usePermission

Hook that gives you the state of permission

browser

test coverage

Last changed: last month

TIP

This hook uses navigator.permissions browser api to provide enhanced functionality. Make sure to check for compatibility with different browsers when using this api

Installation

Library

CLI

Manual

import { usePermission } from '@siberiacancode/reactuse';

Usage

const { state, supported, query } = usePermission('microphone');

Demo

source

Api

Parameters

Name	Type	Default	Note
permissionDescriptorName	UsePermissionName	-	- The permission name
options.enabled?	boolean	true	- Whether the permission is enabled

Returns

UsePermissionReturn

Type declaration

export type UsePermissionName =
  | 'accelerometer'
  | 'accessibility-events'
  | 'ambient-light-sensor'
  | 'background-sync'
  | 'camera'
  | 'clipboard-read'
  | 'clipboard-write'
  | 'gyroscope'
  | 'magnetometer'
  | 'microphone'
  | 'notifications'
  | 'payment-handler'
  | 'persistent-storage'
  | 'push'
  | 'speaker'
  | PermissionName;

export interface UsePermissionOptions {
  /** Whether the permission is enabled */
  enabled: boolean;
}

export interface UsePermissionReturn {
  /** The permission state */
  state: PermissionState;
  /** The permission supported status */
  supported: boolean;
  /** The permission query function */
  query: () => Promise<PermissionState>;
}

Source

Source • Demo

Contributors

D

debabin

H

hywax