# utils/env

module

<a id="constants">

## Constants

<a id="constant-env">

### `env: EnvType`

A namespace containing environment and browser information.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L105)

<a id="interfaces">

## Interfaces

<a id="interface-EnvFeaturesType">

### `EnvFeaturesType`

<a id="interface-EnvType">

### `EnvType`

<a id="functions">

## Functions

<a id="function-getUserAgent">

### `getUserAgent() → string` _(internal)_

Safely returns `userAgent` from browser's navigator API in a lower case. If navigator API is not available it will return an empty string.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L18)

#### Returns

* `string`

<a id="function-isAndroid">

### `isAndroid( userAgent ) → boolean` _(internal)_

Checks if User Agent represented by the string is Android mobile device.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L196)

#### Parameters

* `userAgent: string`

  **Lowercase** `navigator.userAgent` string.

#### Returns

* `boolean`

  Whether User Agent is Safari or not.

<a id="function-isBlink">

### `isBlink( userAgent ) → boolean` _(internal)_

Checks if User Agent represented by the string is Blink engine.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L207)

#### Parameters

* `userAgent: string`

  **Lowercase** `navigator.userAgent` string.

#### Returns

* `boolean`

  Whether User Agent is Blink engine or not.

<a id="function-isGecko">

### `isGecko( userAgent ) → boolean` _(internal)_

Checks if User Agent represented by the string is Firefox (Gecko).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L162)

#### Parameters

* `userAgent: string`

  **Lowercase** `navigator.userAgent` string.

#### Returns

* `boolean`

  Whether User Agent is Firefox or not.

<a id="function-isMac">

### `isMac( userAgent ) → boolean` _(internal)_

Checks if User Agent represented by the string is running on Macintosh.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L140)

#### Parameters

* `userAgent: string`

  **Lowercase** `navigator.userAgent` string.

#### Returns

* `boolean`

  Whether User Agent is running on Macintosh or not.

<a id="function-isMediaForcedColors">

### `isMediaForcedColors() → boolean` _(internal)_

Checks if the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).

Returns `false` in environments where `window` global object is not available.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L243)

#### Returns

* `boolean`

<a id="function-isMotionReduced">

### `isMotionReduced() → boolean` _(internal)_

Checks if the user enabled "prefers reduced motion" setting in browser.

Returns `false` in environments where `window` global object is not available.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L254)

#### Returns

* `boolean`

<a id="function-isRegExpUnicodePropertySupported">

### `isRegExpUnicodePropertySupported() → boolean` _(internal)_

Checks if the current environment supports ES2018 Unicode properties like `\p{P}` or `\p{L}`. More information about unicode properties might be found [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L220)

#### Returns

* `boolean`

<a id="function-isSafari">

### `isSafari( userAgent ) → boolean` _(internal)_

Checks if User Agent represented by the string is Safari.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L173)

#### Parameters

* `userAgent: string`

  **Lowercase** `navigator.userAgent` string.

#### Returns

* `boolean`

  Whether User Agent is Safari or not.

<a id="function-isWindows">

### `isWindows( userAgent ) → boolean` _(internal)_

Checks if User Agent represented by the string is running on Windows.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L151)

#### Parameters

* `userAgent: string`

  **Lowercase** `navigator.userAgent` string.

#### Returns

* `boolean`

  Whether User Agent is running on Windows or not.

<a id="function-isiOS">

### `isiOS( userAgent ) → boolean` _(internal)_

Checks if User Agent represented by the string is running in iOS.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/env.ts#L184)

#### Parameters

* `userAgent: string`

  **Lowercase** `navigator.userAgent` string.

#### Returns

* `boolean`

  Whether User Agent is running in iOS or not.

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)