UNPKG

toggles

Version:

A collection of React hooks for toggles with dynamic noun and verb APIs

29 lines (28 loc) 1.08 kB
import { type Noun } from './nouns'; export declare const verbPairs: { readonly open: "close"; readonly show: "hide"; readonly turnOn: "turnOff"; readonly check: "uncheck"; readonly enable: "disable"; readonly expand: "collapse"; readonly activate: "deactivate"; readonly start: "end"; readonly connect: "disconnect"; readonly focus: "blur"; readonly mount: "unmount"; readonly reveal: "conceal"; readonly display: "dismiss"; readonly lock: "unlock"; readonly subscribe: "unsubscribe"; }; export type PositiveVerbName = keyof typeof verbPairs; export type NegativeVerbName = typeof verbPairs[PositiveVerbName]; export type VerbName = PositiveVerbName | NegativeVerbName | 'toggle'; export type Verb = (noun: Noun) => void; export type Verbs = Record<VerbName, Verb>; export type PositiveVerbs = Record<PositiveVerbName, Verb>; export type NegativeVerbs = Record<NegativeVerbName, Verb>; export declare const positiveVerbs: PositiveVerbs; export declare const negativeVerbs: NegativeVerbs; export declare const verbs: Verbs;