usePermission

v0.0.14testeddemo

Reactive Permissions API state.

Examples

const microphone = usePermission('microphone');

const { state, isSupported, query } = usePermission('camera', { controls: true });

Demo

Loading demo…

Signatures

export function usePermission(
  permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor['name'],
  options?: UsePermissionOptions<false>,
): UsePermissionReturn;

export function usePermission(
  permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor['name'],
  options: UsePermissionOptions<true>,
): UsePermissionReturnWithControls;

Parameters

Parameter	Type	Default	Description
`permissionDesc`	`GeneralPermissionDescriptor \| GeneralPermissionDescriptor['name']`	—	The permission to query
`options`?	`UsePermissionOptions<boolean>`	`{}`	Options

Returns

UsePermissionReturn | UsePermissionReturnWithControlsThe permission state, or controls when controls: true

Related Types

PermissionDescriptorNamePolyfill

Permission names not yet present in the lib DOM PermissionName union but supported by browsers behind the Permissions API.

export type PermissionDescriptorNamePolyfill
  = | 'accelerometer'
    | 'accessibility-events'
    | 'ambient-light-sensor'
    | 'background-sync'
    | 'camera'
    | 'clipboard-read'
    | 'clipboard-write'
    | 'geolocation'
    | 'gyroscope'
    | 'local-fonts'
    | 'magnetometer'
    | 'microphone'
    | 'midi'
    | 'notifications'
    | 'payment-handler'
    | 'persistent-storage'
    | 'push'
    | 'screen-wake-lock'
    | 'speaker'
    | 'speaker-selection'
    | 'storage-access'
    | 'window-management';