R
fn

usePermission

v0.0.15testeddemo

Reactive Permissions API state.

Examples

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

Demo

Loading demo…

Signatures

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

Parameters

ParameterTypeDescription
permissionDescGeneralPermissionDescriptor | "camera" | "geolocation" | "microphone" | "midi" | "notifications" | "persistent-storage" | "push" | "screen-wake-lock" | "storage-access" | "accelerometer" | "accessibility-events" | "ambient-light-sensor" | "background-sync" | "clipboard-read" | "clipboard-write" | "gyroscope" | "local-fonts" | "magnetometer" | "payment-handler" | "speaker" | "speaker-selection" | "window-management"The permission to query
options?UsePermissionOptions<boolean>Options

Returns

Readonly<Ref<PermissionState | undefined, PermissionState | undefined>> | UsePermissionReturnWithControlsThe permission state, or controls when `controls: true`