Skip to content
aq-ui
Back to HooksHook

Use Permission

Open-code aq-ui React hook for Use Permission.

Installation

pnpm dlx aq-ui@alpha add use-permission

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { usePermission } from "@/hooks/use-permission"

PermissionResult

interfaceSource L8

Type contract for PermissionResult.

interface PermissionResult

Members

NameType
statePermissionStatusValue
supportedboolean
errorunknown

PermissionStatusValue

typeSource L5

Type contract for PermissionStatusValue.

type PermissionStatusValue = PermissionState | "unsupported" | "unavailable"

usePermission

functionSource L14

Open-code aq-ui React hook for Use Permission.

function usePermission(descriptor: PermissionDescriptor): PermissionResult
Returns
PermissionResult

Parameters

NameType
descriptorPermissionDescriptor

Files

  • hooks/use-permission.ts

Source