usePermission

Category

Browser

Export Size

498 B

Last Changed

5 days ago

Related

useUserMedia

Reactive Permissions API state

Demo

Usage

import { usePermission } from '@reause/core'

const microphoneAccess = usePermission('microphone') // 'granted' | 'denied' | 'prompt'

Type Declarations

Toggle

export type GeneralPermissionDescriptor = PermissionDescriptor | {
    name: DescriptorNamePolyfill;
}

export interface UsePermissionOptions<Controls extends boolean = false> {
    controls?: Controls;
    navigator?: Navigator;
}

export type UsePermissionReturn = PermissionState

export interface UsePermissionReturnWithControls {
    state: UsePermissionReturn;
    isSupported: boolean;
    query: () => Promise<PermissionStatus | undefined>;
}

type DescriptorNamePolyfill = 'accelerometer' | 'accessibility-events' | 'ambient-light-sensor' | 'background-sync' | 'camera' | 'clipboard-read' | 'clipboard-write' | 'gyroscope' | 'magnetometer' | 'microphone' | 'notifications' | 'payment-handler' | 'persistent-storage' | 'push' | 'speaker' | 'local-fonts'

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

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

Source

Source · Demo · VueUse

Contributors

Changelog

v0.1.0 on

f4741 - fix(core): resolve usePermission audit findings (#617)