Skip to content
@spuxx/jslibs

UserAgent

UserAgent is a light-weight service providing access to the user agent. It can help you do detect the browser, its version, the operating system, its version and the device type as well as help you building responsive UIs.

Classes

UserAgent

Defined in: packages/browser-utils/src/services/user-agent/user-agent.service.ts:13

UserAgent provides functionality related to the user-agent.

Example

// Check whether the viewport is considered a desktop
const { isDesktop } = UserAgent;


// You may also customize UserAgent's behavior
UserAgent.setOptions({ desktopBreakpoint: 1200 });

Extends

  • object

Constructors

Constructor

new UserAgent(): UserAgent

Defined in: node_modules/.pnpm/@spuxx+js-utils@1.3.0_@modyfi+vite-plugin-yaml@1.1.0_rollup@4.60.2_vite@8.0.8_@types+node@25._35qvdzfmbdn2irxbsdgir45xk4/node_modules/@spuxx/js-utils/dist/main.d.ts:349

Returns

UserAgent

Inherited from

ServiceMixin<UserAgent>().constructor

Properties

_instance

static _instance: UserAgent | null

Defined in: node_modules/.pnpm/@spuxx+js-utils@1.3.0_@modyfi+vite-plugin-yaml@1.1.0_rollup@4.60.2_vite@8.0.8_@types+node@25._35qvdzfmbdn2irxbsdgir45xk4/node_modules/@spuxx/js-utils/dist/main.d.ts:354

⛔️ Do not set this and treat it as if it were protected! ⛔️ Unfortunately, TypeScript does not allow private or protected members in declaration files yet. See: https://github.com/microsoft/TypeScript/issues/35822

Inherited from

ServiceMixin<UserAgent>()._instance

instance

readonly static instance: UserAgent

Defined in: node_modules/.pnpm/@spuxx+js-utils@1.3.0_@modyfi+vite-plugin-yaml@1.1.0_rollup@4.60.2_vite@8.0.8_@types+node@25._35qvdzfmbdn2irxbsdgir45xk4/node_modules/@spuxx/js-utils/dist/main.d.ts:358

Returns the instance of the service.

Inherited from

ServiceMixin<UserAgent>().instance

Accessors

isDesktop
Get Signature

get static isDesktop(): boolean

Defined in: packages/browser-utils/src/services/user-agent/user-agent.service.ts:39

Whether the current viewport is considered a desktop.

Returns

boolean

Whether the current viewport is considered a desktop.

isMobile
Get Signature

get static isMobile(): boolean

Defined in: packages/browser-utils/src/services/user-agent/user-agent.service.ts:50

Whether the current viewport is considered a mobile.

Returns

boolean

Whether the current viewport is considered a mobile.

options
Get Signature

get static options(): UserAgentOptions

Defined in: packages/browser-utils/src/services/user-agent/user-agent.service.ts:31

Gets the UserAgents options.

Returns

UserAgentOptions

The UserAgents options.

Methods

destroy()

static destroy(): void

Defined in: node_modules/.pnpm/@spuxx+js-utils@1.3.0_@modyfi+vite-plugin-yaml@1.1.0_rollup@4.60.2_vite@8.0.8_@types+node@25._35qvdzfmbdn2irxbsdgir45xk4/node_modules/@spuxx/js-utils/dist/main.d.ts:359

Returns

void

Inherited from

ServiceMixin<UserAgent>().destroy

setOptions()

static setOptions(options): void

Defined in: packages/browser-utils/src/services/user-agent/user-agent.service.ts:23

Sets the UserAgents options.

Parameters
options

Partial<UserAgentOptions>

The options to use.

Returns

void

After the options have been set.

Interfaces

UserAgentOptions

Defined in: packages/browser-utils/src/services/user-agent/types.ts:4

The options for the UserAgent service.

Properties

desktopBreakpoint

desktopBreakpoint: number

Defined in: packages/browser-utils/src/services/user-agent/types.ts:10

The minimum viewport width in pixels that will be considered a desktop device. Defaults to 960 pixels.

Default
960;