4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
1.8 KiB
1.8 KiB
category
| category |
|---|
| Browser |
usePermission
Reactive Permissions API. The Permissions API provides the tools to allow developers to implement a better user experience as far as permissions are concerned.
Usage
import { usePermission } from '@vueuse/core'
const microphoneAccess = usePermission('microphone')
Type Declarations
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 type GeneralPermissionDescriptor =
| PermissionDescriptor
| {
name: DescriptorNamePolyfill
}
export interface UsePermissionOptions<
Controls extends boolean,
> extends ConfigurableNavigator {
/**
* Expose more controls
*
* @default false
*/
controls?: Controls
}
export type UsePermissionReturn = Readonly<
ShallowRef<PermissionState | undefined>
>
export interface UsePermissionReturnWithControls extends Supportable {
state: UsePermissionReturn
query: () => Promise<PermissionStatus | undefined>
}
/**
* Reactive Permissions API.
*
* @see https://vueuse.org/usePermission
*
* @__NO_SIDE_EFFECTS__
*/
export declare function usePermission(
permissionDesc:
| GeneralPermissionDescriptor
| GeneralPermissionDescriptor["name"],
options?: UsePermissionOptions<false>,
): UsePermissionReturn
export declare function usePermission(
permissionDesc:
| GeneralPermissionDescriptor
| GeneralPermissionDescriptor["name"],
options: UsePermissionOptions<true>,
): UsePermissionReturnWithControls