- Name
service- Kind
- parameter
- Type
ToggleButtonService- Requirement
- required
Docs/API reference/Headless/toggle-button
toggle-button headless API
The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.
58 of 58
@grassroot/ui-headless-core/toggle-button
Core connector and vanilla API
View source
packages/ui-headless/core/src/toggle-button/index.ts
connectToggleButton
functionDeclarationView source
connectToggleButtonts
declare function connectToggleButton(service: ToggleButtonService, scope: PartScope, options?: ToggleButtonConnectOptions): ToggleButtonApi;Name
Kind
Type
Requirement
serviceparameter
ToggleButtonServicerequired
scopeparameter
PartScoperequired
optionsparameter
ToggleButtonConnectOptionsoptional
returnreturn value
ToggleButtonApin/a
- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
options- Kind
- parameter
- Type
ToggleButtonConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
ToggleButtonApi- Requirement
- n/a
mountToggleButton
functionDeclarationView source
mountToggleButtonts
declare function mountToggleButton(container: HTMLElement, options?: MountToggleButtonOptions): ToggleButtonMount;Name
Kind
Type
Requirement
containerparameter
HTMLElementrequired
optionsparameter
MountToggleButtonOptionsoptional
returnreturn value
ToggleButtonMountn/a
- Name
container- Kind
- parameter
- Type
HTMLElement- Requirement
- required
- Name
options- Kind
- parameter
- Type
MountToggleButtonOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
ToggleButtonMount- Requirement
- n/a
MountToggleButtonOptions
interfaceDeclarationView source
MountToggleButtonOptionsts
interface MountToggleButtonOptions extends ToggleButtonInput, ToggleButtonConnectOptions {}runToggleButtonCommand
functionDeclarationView source
runToggleButtonCommandts
declare function runToggleButtonCommand(command: ToggleButtonCommand, options?: Pick<ToggleButtonConnectOptions, "onPressedChange">): void;Name
Kind
Type
Requirement
commandparameter
ToggleButtonCommandrequired
optionsparameter
Pick<ToggleButtonConnectOptions, "onPressedChange">optional
returnreturn value
voidn/a
- Name
command- Kind
- parameter
- Type
ToggleButtonCommand- Requirement
- required
- Name
options- Kind
- parameter
- Type
Pick<ToggleButtonConnectOptions, "onPressedChange">- Requirement
- optional
- Name
return- Kind
- return value
- Type
void- Requirement
- n/a
toggleButtonAnatomy
valueDeclarationView source
toggleButtonAnatomyts
export declare const toggleButtonAnatomy: { readonly scope: "toggle-button"; readonly parts: readonly ["root"];};Name
Kind
Type
Requirement
partsproperty
readonly ["root"]required
scopeproperty
"toggle-button"required
- Name
parts- Kind
- property
- Type
readonly ["root"]- Requirement
- required
- Name
scope- Kind
- property
- Type
"toggle-button"- Requirement
- required
ToggleButtonApi
interfaceDeclarationView source
ToggleButtonApits
interface ToggleButtonApi { rootProps(): PartProps; readonly pressed: boolean; readonly disabled: boolean;}Name
Kind
Type
Requirement
disabledproperty
booleanrequired
pressedproperty
booleanrequired
rootPropsmethod
() => PartPropsrequired
- Name
disabled- Kind
- property
- Type
boolean- Requirement
- required
- Name
pressed- Kind
- property
- Type
boolean- Requirement
- required
- Name
rootProps- Kind
- method
- Type
() => PartProps- Requirement
- required
ToggleButtonChangeDetail
interfaceDeclarationView source
ToggleButtonChangeDetailts
interface ToggleButtonChangeDetail { readonly pressed: boolean; readonly reason: "pointer" | "keyboard" | "programmatic";}Name
Kind
Type
Requirement
pressedproperty
booleanrequired
reasonproperty
"pointer" | "keyboard" | "programmatic"required
- Name
pressed- Kind
- property
- Type
boolean- Requirement
- required
- Name
reason- Kind
- property
- Type
"pointer" | "keyboard" | "programmatic"- Requirement
- required
ToggleButtonCommand
typeDeclarationView source
ToggleButtonCommandts
type ToggleButtonCommand = CommandObject & { readonly type: "PRESSED_CHANGE_REQUEST"; readonly pressed: boolean; readonly reason: ToggleButtonReason;};Name
Kind
Type
Requirement
pressedproperty
booleanrequired
reasonproperty
ToggleButtonReasonrequired
typeproperty
stringrequired
- Name
pressed- Kind
- property
- Type
boolean- Requirement
- required
- Name
reason- Kind
- property
- Type
ToggleButtonReason- Requirement
- required
- Name
type- Kind
- property
- Type
string- Requirement
- required
ToggleButtonConnectOptions
interfaceDeclarationView source
ToggleButtonConnectOptionsts
interface ToggleButtonConnectOptions { readonly ariaLabel?: string; readonly onPressedChange?: (detail: ToggleButtonChangeDetail) => void;}Name
Kind
Type
Requirement
ariaLabelproperty
stringoptional
onPressedChangeproperty
(detail: ToggleButtonChangeDetail) => voidoptional
- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
onPressedChange- Kind
- property
- Type
(detail: ToggleButtonChangeDetail) => void- Requirement
- optional
ToggleButtonContext
typeDeclarationView source
ToggleButtonContextts
type ToggleButtonContext = { readonly mode: BindingMode; readonly pressed: boolean;};Name
Kind
Type
Requirement
modeproperty
BindingModerequired
pressedproperty
booleanrequired
- Name
mode- Kind
- property
- Type
BindingMode- Requirement
- required
- Name
pressed- Kind
- property
- Type
boolean- Requirement
- required
ToggleButtonEvent
typeDeclarationView source
ToggleButtonEventts
type ToggleButtonEvent = { readonly type: "PRESS"; readonly reason: ToggleButtonReason;} | { readonly type: "RESET";};ToggleButtonInput
typeDeclarationView source
ToggleButtonInputts
type ToggleButtonInput = { readonly pressed?: boolean; readonly defaultPressed?: boolean; readonly disabled?: boolean;};Name
Kind
Type
Requirement
defaultPressedproperty
booleanoptional
disabledproperty
booleanoptional
pressedproperty
booleanoptional
- Name
defaultPressed- Kind
- property
- Type
boolean- Requirement
- optional
- Name
disabled- Kind
- property
- Type
boolean- Requirement
- optional
- Name
pressed- Kind
- property
- Type
boolean- Requirement
- optional
toggleButtonMachine
valueDeclarationView source
toggleButtonMachinets
export declare const toggleButtonMachine: Machine<ToggleButtonInput, "ready", ToggleButtonContext, ToggleButtonEvent, ToggleButtonCommand>;ToggleButtonMount
interfaceDeclarationView source
ToggleButtonMountts
interface ToggleButtonMount { readonly service: ToggleButtonService; readonly connector: ToggleButtonApi; readonly root: HTMLButtonElement; destroy(): void;}Name
Kind
Type
Requirement
connectorproperty
ToggleButtonApirequired
destroymethod
() => voidrequired
rootproperty
HTMLButtonElementrequired
serviceproperty
ToggleButtonServicerequired
- Name
connector- Kind
- property
- Type
ToggleButtonApi- Requirement
- required
- Name
destroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
root- Kind
- property
- Type
HTMLButtonElement- Requirement
- required
- Name
service- Kind
- property
- Type
ToggleButtonService- Requirement
- required
ToggleButtonPart
typeDeclarationView source
ToggleButtonPartts
type ToggleButtonPart = (typeof toggleButtonAnatomy.parts)[number];ToggleButtonReason
typeDeclarationView source
ToggleButtonReasonts
type ToggleButtonReason = "pointer" | "keyboard" | "programmatic";toggleButtonSelectors
valueDeclarationView source
toggleButtonSelectorsts
export declare const toggleButtonSelectors: { pressed: (snapshot: ToggleButtonSnapshot) => boolean;};Name
Kind
Type
Requirement
pressedproperty
(snapshot: ToggleButtonSnapshot) => booleanrequired
- Name
pressed- Kind
- property
- Type
(snapshot: ToggleButtonSnapshot) => boolean- Requirement
- required
ToggleButtonService
typeDeclarationView source
ToggleButtonServicets
type ToggleButtonService = Service<ToggleButtonInput, "ready", ToggleButtonContext, ToggleButtonEvent, ToggleButtonCommand>;ToggleButtonSnapshot
typeDeclarationView source
ToggleButtonSnapshotts
type ToggleButtonSnapshot = Snapshot<"ready", ToggleButtonContext>;Framework adapters
Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.
React example follows below.
Vue example follows below.
Angular example follows below.
Svelte example follows below.
Solid example follows below.
React imports
@grassroot/ui-headless-react/toggle-buttonts
1
import { Root, RootProvider, ToggleButtonRoot, ToggleButtonRootProvider } from "@grassroot/ui-headless-react/toggle-button";Vue imports
@grassroot/ui-headless-vue/toggle-buttonts
1
2
3
<script setup lang="ts">import { Root, RootProvider, ToggleButtonRoot, ToggleButtonRootProvider } from "@grassroot/ui-headless-vue/toggle-button";</script>Angular imports
@grassroot/ui-headless-angular/toggle-buttonts
1
import { GrToggleButtonRoot, GrToggleButtonRootProvider, Root, RootProvider } from "@grassroot/ui-headless-angular/toggle-button";Svelte imports
@grassroot/ui-headless-svelte/toggle-buttonts
1
2
3
<script lang="ts"> import { Root, RootProvider, ToggleButtonRoot, ToggleButtonRootProvider } from "@grassroot/ui-headless-svelte/toggle-button";</script>Solid imports
@grassroot/ui-headless-solid/toggle-buttonts
1
import { Root, RootProvider, ToggleButtonRoot, ToggleButtonRootProvider } from "@grassroot/ui-headless-solid/toggle-button";@grassroot/ui-headless-react/toggle-button
React adapter
View source
packages/ui-headless/react/src/toggle-button/index.ts
Root
valueDeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<ToggleButtonRootProps & import("react").RefAttributes<HTMLButtonElement>>;Name
Kind
Type
Requirement
propsparameter
Prequired
returnreturn value
ReactNoden/a
- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
RootProvider
valueDeclarationView source
RootProviderts
export declare const RootProvider: import("react").ForwardRefExoticComponent<ToggleButtonRootProviderProps & import("react").RefAttributes<HTMLButtonElement>>;Name
Kind
Type
Requirement
propsparameter
Prequired
returnreturn value
ReactNoden/a
- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
ToggleButtonRoot
valueDeclarationView source
ToggleButtonRootts
export declare const ToggleButtonRoot: import("react").ForwardRefExoticComponent<ToggleButtonRootProps & import("react").RefAttributes<HTMLButtonElement>>;Name
Kind
Type
Requirement
propsparameter
Prequired
returnreturn value
ReactNoden/a
- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
ToggleButtonRootProps
interfaceDeclarationView source
ToggleButtonRootPropsts
interface ToggleButtonRootProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, "defaultValue" | "onChange" | "disabled">, ToggleButtonInput { readonly ariaLabel?: string; readonly id?: string; readonly onPressedChange?: (detail: ToggleButtonChangeDetail) => void; readonly children?: ReactNode;}Name
Kind
Type
Requirement
ariaLabelproperty
stringoptional
childrenproperty
ReactNodeoptional
idproperty
stringoptional
onPressedChangeproperty
(detail: ToggleButtonChangeDetail) => voidoptional
- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onPressedChange- Kind
- property
- Type
(detail: ToggleButtonChangeDetail) => void- Requirement
- optional
ToggleButtonRootProvider
valueDeclarationView source
ToggleButtonRootProviderts
export declare const ToggleButtonRootProvider: import("react").ForwardRefExoticComponent<ToggleButtonRootProviderProps & import("react").RefAttributes<HTMLButtonElement>>;Name
Kind
Type
Requirement
propsparameter
Prequired
returnreturn value
ReactNoden/a
- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
ToggleButtonRootProviderProps
interfaceDeclarationView source
ToggleButtonRootProviderPropsts
interface ToggleButtonRootProviderProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, "defaultValue" | "onChange" | "value"> { readonly value: UseToggleButtonResult; readonly children?: ReactNode;}Name
Kind
Type
Requirement
childrenproperty
ReactNodeoptional
valueproperty
UseToggleButtonResultrequired
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
value- Kind
- property
- Type
UseToggleButtonResult- Requirement
- required
useToggleButton
functionDeclarationView source
useToggleButtonts
declare function useToggleButton(input: ToggleButtonInput, options?: UseToggleButtonOptions): UseToggleButtonResult;Name
Kind
Type
Requirement
inputparameter
ToggleButtonInputrequired
optionsparameter
UseToggleButtonOptionsoptional
returnreturn value
UseToggleButtonResultn/a
- Name
input- Kind
- parameter
- Type
ToggleButtonInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseToggleButtonOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseToggleButtonResult- Requirement
- n/a
UseToggleButtonOptions
interfaceDeclarationView source
UseToggleButtonOptionsts
interface UseToggleButtonOptions extends ToggleButtonConnectOptions { readonly id?: string;}Name
Kind
Type
Requirement
idproperty
stringoptional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
UseToggleButtonResult
interfaceDeclarationView source
UseToggleButtonResultts
interface UseToggleButtonResult { readonly service: ToggleButtonService; readonly connector: ToggleButtonApi; readonly scope: PartScope; readonly snapshot: ToggleButtonSnapshot;}Name
Kind
Type
Requirement
connectorproperty
ToggleButtonApirequired
scopeproperty
PartScoperequired
serviceproperty
ToggleButtonServicerequired
snapshotproperty
ToggleButtonSnapshotrequired
- Name
connector- Kind
- property
- Type
ToggleButtonApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
ToggleButtonService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ToggleButtonSnapshot- Requirement
- required
@grassroot/ui-headless-vue/toggle-button
Vue adapter
View source
packages/ui-headless/vue/src/toggle-button/index.ts
Root
valueDeclarationView source
Rootts
export declare const Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; pressed: { type: PropType<boolean | undefined>; default: undefined; }; defaultPressed: { type: PropType<boolean | undefined>; default: undefined; }; disabled: { type: PropType<boolean | undefined>; default: undefined; }; ariaLabel: StringConstructor; id: StringConstructor;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { pressedChange: (_detail: ToggleButtonChangeDetail) => true;}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; pressed: { type: PropType<boolean | undefined>; default: undefined; }; defaultPressed: { type: PropType<boolean | undefined>; default: undefined; }; disabled: { type: PropType<boolean | undefined>; default: undefined; }; ariaLabel: StringConstructor; id: StringConstructor;}>> & Readonly<{ onPressedChange?: ((_detail: ToggleButtonChangeDetail) => any) | undefined;}>, { asChild: boolean; pressed: boolean | undefined; defaultPressed: boolean | undefined; disabled: boolean | undefined;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;RootProvider
valueDeclarationView source
RootProviderts
export declare const RootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ value: { type: PropType<UseToggleButtonResult>; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ value: { type: PropType<UseToggleButtonResult>; required: true; };}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;ToggleButtonOptions
typeDeclarationView source
ToggleButtonOptionsts
type ToggleButtonOptions = ToggleButtonConnectOptions & { readonly id?: string;};Name
Kind
Type
Requirement
idproperty
stringoptional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
ToggleButtonRoot
valueDeclarationView source
ToggleButtonRootts
export declare const ToggleButtonRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; pressed: { type: PropType<boolean | undefined>; default: undefined; }; defaultPressed: { type: PropType<boolean | undefined>; default: undefined; }; disabled: { type: PropType<boolean | undefined>; default: undefined; }; ariaLabel: StringConstructor; id: StringConstructor;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { pressedChange: (_detail: ToggleButtonChangeDetail) => true;}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; pressed: { type: PropType<boolean | undefined>; default: undefined; }; defaultPressed: { type: PropType<boolean | undefined>; default: undefined; }; disabled: { type: PropType<boolean | undefined>; default: undefined; }; ariaLabel: StringConstructor; id: StringConstructor;}>> & Readonly<{ onPressedChange?: ((_detail: ToggleButtonChangeDetail) => any) | undefined;}>, { asChild: boolean; pressed: boolean | undefined; defaultPressed: boolean | undefined; disabled: boolean | undefined;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;ToggleButtonRootProvider
valueDeclarationView source
ToggleButtonRootProviderts
export declare const ToggleButtonRootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ value: { type: PropType<UseToggleButtonResult>; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ value: { type: PropType<UseToggleButtonResult>; required: true; };}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;useToggleButton
functionDeclarationView source
useToggleButtonts
declare function useToggleButton(input: () => ToggleButtonInput, options?: () => ToggleButtonOptions): UseToggleButtonResult;Name
Kind
Type
Requirement
inputparameter
() => ToggleButtonInputrequired
optionsparameter
() => ToggleButtonOptionsoptional
returnreturn value
UseToggleButtonResultn/a
- Name
input- Kind
- parameter
- Type
() => ToggleButtonInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
() => ToggleButtonOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseToggleButtonResult- Requirement
- n/a
UseToggleButtonResult
interfaceDeclarationView source
UseToggleButtonResultts
interface UseToggleButtonResult { readonly service: ToggleButtonService; readonly connector: ToggleButtonApi; readonly scope: PartScope; readonly snapshot: ShallowRef<ToggleButtonSnapshot>;}Name
Kind
Type
Requirement
connectorproperty
ToggleButtonApirequired
scopeproperty
PartScoperequired
serviceproperty
ToggleButtonServicerequired
snapshotproperty
ShallowRef<ToggleButtonSnapshot>required
- Name
connector- Kind
- property
- Type
ToggleButtonApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
ToggleButtonService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ShallowRef<ToggleButtonSnapshot>- Requirement
- required
@grassroot/ui-headless-angular/toggle-button
Angular adapter
View source
packages/ui-headless/angular/src/toggle-button/index.ts
createToggleButtonStore
functionDeclarationView source
createToggleButtonStorets
export declare function createToggleButtonStore(initial: ToggleButtonInput, options?: CreateToggleButtonStoreOptions): ToggleButtonStore;Name
Kind
Type
Requirement
initialparameter
ToggleButtonInputrequired
optionsparameter
CreateToggleButtonStoreOptionsoptional
returnreturn value
ToggleButtonStoren/a
- Name
initial- Kind
- parameter
- Type
ToggleButtonInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
CreateToggleButtonStoreOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
ToggleButtonStore- Requirement
- n/a
CreateToggleButtonStoreOptions
interfaceDeclarationView source
CreateToggleButtonStoreOptionsts
export interface CreateToggleButtonStoreOptions extends ToggleButtonConnectOptions {}GrToggleButtonRoot
classDeclarationView source
GrToggleButtonRootts
export declare class GrToggleButtonRoot implements OnDestroy { readonly pressed: import("@angular/core").InputSignal<boolean | undefined>; readonly defaultPressed: import("@angular/core").InputSignal<boolean | undefined>; readonly disabled: import("@angular/core").InputSignal<boolean | undefined>; readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>; readonly pressedChange: import("@angular/core").OutputEmitterRef<ToggleButtonChangeDetail>; readonly store: ToggleButtonStore; private readonly host; private readonly listeners; private readonly consumer; private last; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrToggleButtonRoot, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrToggleButtonRoot, "gr-toggle-button-root", never, { "pressed": { "alias": "pressed"; "required": false; "isSignal": true; }; "defaultPressed": { "alias": "defaultPressed"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "pressedChange": "pressedChange"; }, never, ["*"], true, never>;}Name
Kind
Type
Requirement
ariaLabelproperty
import("@angular/core").InputSignal<string | undefined>required
consumerproperty
anyrequired
defaultPressedproperty
import("@angular/core").InputSignal<boolean | undefined>required
disabledproperty
import("@angular/core").InputSignal<boolean | undefined>required
hostproperty
anyrequired
lastproperty
anyrequired
listenersproperty
anyrequired
ngOnDestroymethod
() => voidrequired
ɵcmpproperty
i0.ɵɵComponentDeclaration<GrToggleButtonRoot, "gr-toggle-button-root", never, { "pressed": { "alias": "pressed"; "required": false; "isSignal": true; }; "defaultPressed": { "alias": "defaultPressed"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "pressedChange": "pressedChange"; }, never, ["*"], true, never>required
ɵfacproperty
i0.ɵɵFactoryDeclaration<GrToggleButtonRoot, never>required
pressedproperty
import("@angular/core").InputSignal<boolean | undefined>required
pressedChangeproperty
import("@angular/core").OutputEmitterRef<ToggleButtonChangeDetail>required
storeproperty
ToggleButtonStorerequired
- Name
ariaLabel- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
defaultPressed- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
disabled- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
last- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrToggleButtonRoot, "gr-toggle-button-root", never, { "pressed": { "alias": "pressed"; "required": false; "isSignal": true; }; "defaultPressed": { "alias": "defaultPressed"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "pressedChange": "pressedChange"; }, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrToggleButtonRoot, never>- Requirement
- required
- Name
pressed- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
pressedChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<ToggleButtonChangeDetail>- Requirement
- required
- Name
store- Kind
- property
- Type
ToggleButtonStore- Requirement
- required
DeclarationView source
GrToggleButtonRootProviderts
export declare class GrToggleButtonRootProvider implements OnDestroy { private readonly store; private readonly host; private readonly listeners; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrToggleButtonRootProvider, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrToggleButtonRootProvider, "gr-toggle-button-root-provider", never, {}, {}, never, ["*"], true, never>;}Name
Kind
Type
Requirement
hostproperty
anyrequired
listenersproperty
anyrequired
ngOnDestroymethod
() => voidrequired
ɵcmpproperty
i0.ɵɵComponentDeclaration<GrToggleButtonRootProvider, "gr-toggle-button-root-provider", never, {}, {}, never, ["*"], true, never>required
ɵfacproperty
i0.ɵɵFactoryDeclaration<GrToggleButtonRootProvider, never>required
storeproperty
anyrequired
- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrToggleButtonRootProvider, "gr-toggle-button-root-provider", never, {}, {}, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrToggleButtonRootProvider, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
Root
classDeclarationView source
Rootts
export declare class GrToggleButtonRoot implements OnDestroy { readonly pressed: import("@angular/core").InputSignal<boolean | undefined>; readonly defaultPressed: import("@angular/core").InputSignal<boolean | undefined>; readonly disabled: import("@angular/core").InputSignal<boolean | undefined>; readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>; readonly pressedChange: import("@angular/core").OutputEmitterRef<ToggleButtonChangeDetail>; readonly store: ToggleButtonStore; private readonly host; private readonly listeners; private readonly consumer; private last; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrToggleButtonRoot, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrToggleButtonRoot, "gr-toggle-button-root", never, { "pressed": { "alias": "pressed"; "required": false; "isSignal": true; }; "defaultPressed": { "alias": "defaultPressed"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "pressedChange": "pressedChange"; }, never, ["*"], true, never>;}Name
Kind
Type
Requirement
ariaLabelproperty
import("@angular/core").InputSignal<string | undefined>required
consumerproperty
anyrequired
defaultPressedproperty
import("@angular/core").InputSignal<boolean | undefined>required
disabledproperty
import("@angular/core").InputSignal<boolean | undefined>required
hostproperty
anyrequired
lastproperty
anyrequired
listenersproperty
anyrequired
ngOnDestroymethod
() => voidrequired
ɵcmpproperty
i0.ɵɵComponentDeclaration<GrToggleButtonRoot, "gr-toggle-button-root", never, { "pressed": { "alias": "pressed"; "required": false; "isSignal": true; }; "defaultPressed": { "alias": "defaultPressed"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "pressedChange": "pressedChange"; }, never, ["*"], true, never>required
ɵfacproperty
i0.ɵɵFactoryDeclaration<GrToggleButtonRoot, never>required
pressedproperty
import("@angular/core").InputSignal<boolean | undefined>required
pressedChangeproperty
import("@angular/core").OutputEmitterRef<ToggleButtonChangeDetail>required
storeproperty
ToggleButtonStorerequired
- Name
ariaLabel- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
defaultPressed- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
disabled- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
last- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrToggleButtonRoot, "gr-toggle-button-root", never, { "pressed": { "alias": "pressed"; "required": false; "isSignal": true; }; "defaultPressed": { "alias": "defaultPressed"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "pressedChange": "pressedChange"; }, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrToggleButtonRoot, never>- Requirement
- required
- Name
pressed- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
pressedChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<ToggleButtonChangeDetail>- Requirement
- required
- Name
store- Kind
- property
- Type
ToggleButtonStore- Requirement
- required
RootProvider
classDeclarationView source
RootProviderts
export declare class GrToggleButtonRootProvider implements OnDestroy { private readonly store; private readonly host; private readonly listeners; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrToggleButtonRootProvider, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrToggleButtonRootProvider, "gr-toggle-button-root-provider", never, {}, {}, never, ["*"], true, never>;}Name
Kind
Type
Requirement
hostproperty
anyrequired
listenersproperty
anyrequired
ngOnDestroymethod
() => voidrequired
ɵcmpproperty
i0.ɵɵComponentDeclaration<GrToggleButtonRootProvider, "gr-toggle-button-root-provider", never, {}, {}, never, ["*"], true, never>required
ɵfacproperty
i0.ɵɵFactoryDeclaration<GrToggleButtonRootProvider, never>required
storeproperty
anyrequired
- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrToggleButtonRootProvider, "gr-toggle-button-root-provider", never, {}, {}, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrToggleButtonRootProvider, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
ToggleButtonStore
interfaceDeclarationView source
ToggleButtonStorets
export interface ToggleButtonStore { readonly service: ToggleButtonService; readonly connector: ToggleButtonApi; readonly scope: PartScope; readonly version: WritableSignal<number>; start(): void; stop(): void; sync(input: Record<string, unknown>): void;}Name
Kind
Type
Requirement
connectorproperty
ToggleButtonApirequired
scopeproperty
PartScoperequired
serviceproperty
ToggleButtonServicerequired
startmethod
() => voidrequired
stopmethod
() => voidrequired
syncmethod
(input: Record<string, unknown>) => voidrequired
versionproperty
WritableSignal<number>required
- Name
connector- Kind
- property
- Type
ToggleButtonApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
ToggleButtonService- Requirement
- required
- Name
start- Kind
- method
- Type
() => void- Requirement
- required
- Name
stop- Kind
- method
- Type
() => void- Requirement
- required
- Name
sync- Kind
- method
- Type
(input: Record<string, unknown>) => void- Requirement
- required
- Name
version- Kind
- property
- Type
WritableSignal<number>- Requirement
- required
@grassroot/ui-headless-svelte/toggle-button
Svelte adapter
View source
packages/ui-headless/svelte/src/toggle-button/index.ts
createToggleButton
functionDeclarationView source
createToggleButtonts
export declare function createToggleButton(input: () => ToggleButtonInput, options?: UseToggleButtonOptions): UseToggleButtonResult;Name
Kind
Type
Requirement
inputparameter
() => ToggleButtonInputrequired
optionsparameter
UseToggleButtonOptionsoptional
returnreturn value
UseToggleButtonResultn/a
- Name
input- Kind
- parameter
- Type
() => ToggleButtonInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseToggleButtonOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseToggleButtonResult- Requirement
- n/a
Root
valueDeclarationView source
Rootts
export declare const Root: LegacyComponentType;Name
Kind
Type
Requirement
argsparameter
Parameters<Component<Record<string, any>>>optional
returnreturn value
ReturnType<Component<Record<string, any>, Record<string, any>>>n/a
- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
RootProvider
valueDeclarationView source
RootProviderts
export declare const RootProvider: LegacyComponentType;Name
Kind
Type
Requirement
argsparameter
Parameters<Component<Record<string, any>>>optional
returnreturn value
ReturnType<Component<Record<string, any>, Record<string, any>>>n/a
- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
ToggleButtonRoot
valueDeclarationView source
ToggleButtonRootts
export declare const ToggleButtonRoot: LegacyComponentType;Name
Kind
Type
Requirement
argsparameter
Parameters<Component<Record<string, any>>>optional
returnreturn value
ReturnType<Component<Record<string, any>, Record<string, any>>>n/a
- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
ToggleButtonRootProvider
valueDeclarationView source
ToggleButtonRootProviderts
export declare const ToggleButtonRootProvider: LegacyComponentType;Name
Kind
Type
Requirement
argsparameter
Parameters<Component<Record<string, any>>>optional
returnreturn value
ReturnType<Component<Record<string, any>, Record<string, any>>>n/a
- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
UseToggleButtonOptions
interfaceDeclarationView source
UseToggleButtonOptionsts
export interface UseToggleButtonOptions extends ToggleButtonConnectOptions { readonly id?: string;}Name
Kind
Type
Requirement
idproperty
stringoptional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
UseToggleButtonResult
interfaceDeclarationView source
UseToggleButtonResultts
export interface UseToggleButtonResult { readonly service: ToggleButtonService; readonly connector: ToggleButtonApi; readonly scope: PartScope; readonly version: () => number;}Name
Kind
Type
Requirement
connectorproperty
ToggleButtonApirequired
scopeproperty
PartScoperequired
serviceproperty
ToggleButtonServicerequired
versionproperty
() => numberrequired
- Name
connector- Kind
- property
- Type
ToggleButtonApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
ToggleButtonService- Requirement
- required
- Name
version- Kind
- property
- Type
() => number- Requirement
- required
@grassroot/ui-headless-solid/toggle-button
Solid adapter
View source
packages/ui-headless/solid/src/toggle-button/index.ts
Root
functionDeclarationView source
Rootts
export declare function ToggleButtonRoot(props: ToggleButtonRootProps): JSX.Element;Name
Kind
Type
Requirement
propsparameter
ToggleButtonRootPropsrequired
returnreturn value
JSX.Elementn/a
- Name
props- Kind
- parameter
- Type
ToggleButtonRootProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
RootProvider
functionDeclarationView source
RootProviderts
export declare function ToggleButtonRootProvider(props: ToggleButtonRootProviderProps): JSX.Element;Name
Kind
Type
Requirement
propsparameter
ToggleButtonRootProviderPropsrequired
returnreturn value
JSX.Elementn/a
- Name
props- Kind
- parameter
- Type
ToggleButtonRootProviderProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
ToggleButtonRoot
functionDeclarationView source
ToggleButtonRootts
export declare function ToggleButtonRoot(props: ToggleButtonRootProps): JSX.Element;Name
Kind
Type
Requirement
propsparameter
ToggleButtonRootPropsrequired
returnreturn value
JSX.Elementn/a
- Name
props- Kind
- parameter
- Type
ToggleButtonRootProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
ToggleButtonRootProps
interfaceDeclarationView source
ToggleButtonRootPropsts
export interface ToggleButtonRootProps extends Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, "disabled" | "onChange">, ToggleButtonInput { readonly ariaLabel?: string; readonly id?: string; readonly onPressedChange?: (detail: ToggleButtonChangeDetail) => void; readonly children?: JSX.Element;}Name
Kind
Type
Requirement
ariaLabelproperty
stringoptional
childrenproperty
JSX.Elementoptional
idproperty
stringoptional
onPressedChangeproperty
(detail: ToggleButtonChangeDetail) => voidoptional
- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
children- Kind
- property
- Type
JSX.Element- Requirement
- optional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onPressedChange- Kind
- property
- Type
(detail: ToggleButtonChangeDetail) => void- Requirement
- optional
ToggleButtonRootProvider
functionDeclarationView source
ToggleButtonRootProviderts
export declare function ToggleButtonRootProvider(props: ToggleButtonRootProviderProps): JSX.Element;Name
Kind
Type
Requirement
propsparameter
ToggleButtonRootProviderPropsrequired
returnreturn value
JSX.Elementn/a
- Name
props- Kind
- parameter
- Type
ToggleButtonRootProviderProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
ToggleButtonRootProviderProps
interfaceDeclarationView source
ToggleButtonRootProviderPropsts
export interface ToggleButtonRootProviderProps extends Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, "disabled" | "onChange" | "value"> { readonly value: UseToggleButtonResult; readonly children?: JSX.Element;}Name
Kind
Type
Requirement
childrenproperty
JSX.Elementoptional
valueproperty
UseToggleButtonResultrequired
- Name
children- Kind
- property
- Type
JSX.Element- Requirement
- optional
- Name
value- Kind
- property
- Type
UseToggleButtonResult- Requirement
- required
useToggleButton
functionDeclarationView source
useToggleButtonts
export declare function useToggleButton(input: Accessor<ToggleButtonInput>, options?: UseToggleButtonOptions): UseToggleButtonResult;Name
Kind
Type
Requirement
inputparameter
Accessor<ToggleButtonInput>required
optionsparameter
UseToggleButtonOptionsoptional
returnreturn value
UseToggleButtonResultn/a
- Name
input- Kind
- parameter
- Type
Accessor<ToggleButtonInput>- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseToggleButtonOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseToggleButtonResult- Requirement
- n/a
UseToggleButtonOptions
interfaceDeclarationView source
UseToggleButtonOptionsts
export interface UseToggleButtonOptions extends ToggleButtonConnectOptions { readonly id?: string;}Name
Kind
Type
Requirement
idproperty
stringoptional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
UseToggleButtonResult
interfaceDeclarationView source
UseToggleButtonResultts
export interface UseToggleButtonResult { readonly service: ToggleButtonService; readonly connector: ToggleButtonApi; readonly scope: PartScope; readonly snapshot: () => number;}Name
Kind
Type
Requirement
connectorproperty
ToggleButtonApirequired
scopeproperty
PartScoperequired
serviceproperty
ToggleButtonServicerequired
snapshotproperty
() => numberrequired
- Name
connector- Kind
- property
- Type
ToggleButtonApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
ToggleButtonService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
() => number- Requirement
- required