DocsAPI referenceHeadlessquantity-stepper

quantity-stepper 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.

@grassroot/ui-headless-core/quantity-stepper

Core connector and vanilla API

13 exports
View source packages/ui-headless/core/src/quantity-stepper/index.ts
DeclarationView source
connectQuantityStepperts
declare function connectQuantityStepper(service: QuantityStepperService, scope: PartScope, options?: QuantityStepperConnectOptions): QuantityStepperApi;
Name
Kind
Type
Requirement
service
parameter
QuantityStepperService
required
scope
parameter
PartScope
required
options
parameter
QuantityStepperConnectOptions
optional
return
return value
QuantityStepperApi
n/a
Name
service
Kind
parameter
Type
QuantityStepperService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
QuantityStepperConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
QuantityStepperApi
Requirement
n/a
DeclarationView source
mountQuantityStepperts
declare function mountQuantityStepper(container: HTMLElement, options?: MountQuantityStepperOptions): QuantityStepperMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountQuantityStepperOptions
optional
return
return value
QuantityStepperMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountQuantityStepperOptions
Requirement
optional
Name
return
Kind
return value
Type
QuantityStepperMount
Requirement
n/a
DeclarationView source
MountQuantityStepperOptionsts
interface MountQuantityStepperOptions extends QuantityStepperInput, Pick<QuantityStepperConnectOptions, "ariaLabel" | "messages"> {
readonly onValueChange?: (detail: QuantityStepperChangeDetail) => void;
}
Name
Kind
Type
Requirement
onValueChange
property
(detail: QuantityStepperChangeDetail) => void
optional
Name
onValueChange
Kind
property
Type
(detail: QuantityStepperChangeDetail) => void
Requirement
optional
DeclarationView source
quantityStepperAnatomyts
export declare const quantityStepperAnatomy: {
readonly scope: "quantity-stepper";
readonly parts: readonly ["root", "decrement", "value", "increment"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "decrement", "value", "increment"]
required
scope
property
"quantity-stepper"
required
Name
parts
Kind
property
Type
readonly ["root", "decrement", "value", "increment"]
Requirement
required
Name
scope
Kind
property
Type
"quantity-stepper"
Requirement
required

QuantityStepperApi

interface
DeclarationView source
QuantityStepperApits
interface QuantityStepperApi {
rootProps(): PartProps;
decrementProps(): PartProps;
valueProps(): PartProps;
incrementProps(): PartProps;
readonly value: number;
readonly disabled: boolean;
readonly canDecrement: boolean;
readonly canIncrement: boolean;
}
Name
Kind
Type
Requirement
canDecrement
property
boolean
required
canIncrement
property
boolean
required
decrementProps
method
() => PartProps
required
disabled
property
boolean
required
incrementProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
value
property
number
required
valueProps
method
() => PartProps
required
Name
canDecrement
Kind
property
Type
boolean
Requirement
required
Name
canIncrement
Kind
property
Type
boolean
Requirement
required
Name
decrementProps
Kind
method
Type
() => PartProps
Requirement
required
Name
disabled
Kind
property
Type
boolean
Requirement
required
Name
incrementProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
value
Kind
property
Type
number
Requirement
required
Name
valueProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
QuantityStepperChangeDetailts
interface QuantityStepperChangeDetail {
readonly value: number;
readonly reason: "pointer" | "keyboard" | "programmatic";
}
Name
Kind
Type
Requirement
reason
property
"pointer" | "keyboard" | "programmatic"
required
value
property
number
required
Name
reason
Kind
property
Type
"pointer" | "keyboard" | "programmatic"
Requirement
required
Name
value
Kind
property
Type
number
Requirement
required
DeclarationView source
QuantityStepperConnectOptionsts
interface QuantityStepperConnectOptions {
readonly ariaLabel?: string;
readonly messages?: Partial<QuantityStepperMessages>;
readonly onValueChange?: (detail: QuantityStepperChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
messages
property
Partial<QuantityStepperMessages>
optional
onValueChange
property
(detail: QuantityStepperChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
messages
Kind
property
Type
Partial<QuantityStepperMessages>
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: QuantityStepperChangeDetail) => void
Requirement
optional
DeclarationView source
quantityStepperMessagests
export declare const quantityStepperMessages: QuantityStepperMessages;
DeclarationView source
QuantityStepperMessagests
type QuantityStepperMessages = Pick<MessageTable, "rootLabel" | "decrementLabel" | "incrementLabel">;
DeclarationView source
QuantityStepperMountts
interface QuantityStepperMount {
readonly service: QuantityStepperService;
readonly connector: QuantityStepperApi;
readonly root: HTMLDivElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
QuantityStepperApi
required
destroy
method
() => void
required
root
property
HTMLDivElement
required
service
property
QuantityStepperService
required
Name
connector
Kind
property
Type
QuantityStepperApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLDivElement
Requirement
required
Name
service
Kind
property
Type
QuantityStepperService
Requirement
required
DeclarationView source
QuantityStepperPartts
type QuantityStepperPart = (typeof quantityStepperAnatomy.parts)[number];
DeclarationView source
QuantityStepperServicets
type QuantityStepperService = Service<QuantityStepperInput, "ready", QuantityStepperContext, QuantityStepperEvent, QuantityStepperCommand>;
DeclarationView source
runQuantityStepperCommandts
declare function runQuantityStepperCommand(command: QuantityStepperCommand, options?: QuantityStepperConnectOptions): void;
Name
Kind
Type
Requirement
command
parameter
QuantityStepperCommand
required
options
parameter
QuantityStepperConnectOptions
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
QuantityStepperCommand
Requirement
required
Name
options
Kind
parameter
Type
QuantityStepperConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
void
Requirement
n/a

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.

React imports

@grassroot/ui-headless-react/quantity-stepperts
import { Decrement, Increment, Root, RootProvider, Value } from "@grassroot/ui-headless-react/quantity-stepper";

Vue imports

@grassroot/ui-headless-vue/quantity-stepperts
<script setup lang="ts">
import { Decrement, Increment, Root, RootProvider, Value } from "@grassroot/ui-headless-vue/quantity-stepper";
</script>

Angular imports

@grassroot/ui-headless-angular/quantity-stepperts
import { GrQuantityStepperDecrement, GrQuantityStepperIncrement, GrQuantityStepperRoot, GrQuantityStepperRootProvider, GrQuantityStepperValue } from "@grassroot/ui-headless-angular/quantity-stepper";

Svelte imports

@grassroot/ui-headless-svelte/quantity-stepperts
<script lang="ts">
import { Decrement, Increment, Parts, Root, RootProvider, Value } from "@grassroot/ui-headless-svelte/quantity-stepper";
</script>

Solid imports

@grassroot/ui-headless-solid/quantity-stepperts
import { Decrement, Increment, Root, RootProvider, Value } from "@grassroot/ui-headless-solid/quantity-stepper";

@grassroot/ui-headless-react/quantity-stepper

React adapter

12 exports
View source packages/ui-headless/react/src/quantity-stepper/index.ts

Decrement

value
DeclarationView source
Decrementts
export declare const Decrement: import("react").ForwardRefExoticComponent<QuantityStepperButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Increment

value
DeclarationView source
Incrementts
export declare const Increment: import("react").ForwardRefExoticComponent<QuantityStepperButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a
DeclarationView source
QuantityStepperButtonPropsts
interface QuantityStepperButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
DeclarationView source
QuantityStepperRootPropsts
interface QuantityStepperRootProps extends Omit<HTMLAttributes<HTMLDivElement>, "onChange" | "value" | "defaultValue">, QuantityStepperInput {
readonly ariaLabel?: string;
readonly id?: string;
readonly onValueChange?: (detail: QuantityStepperChangeDetail) => void;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
children
property
ReactNode
optional
id
property
string
optional
onValueChange
property
(detail: QuantityStepperChangeDetail) => void
optional
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
onValueChange
Kind
property
Type
(detail: QuantityStepperChangeDetail) => void
Requirement
optional
DeclarationView source
QuantityStepperRootProviderPropsts
interface QuantityStepperRootProviderProps extends Omit<HTMLAttributes<HTMLDivElement>, "onChange"> {
readonly value: UseQuantityStepperResult;
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
value
property
UseQuantityStepperResult
required
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
value
Kind
property
Type
UseQuantityStepperResult
Requirement
required
DeclarationView source
QuantityStepperValuePropsts
interface QuantityStepperValueProps extends HTMLAttributes<HTMLSpanElement> {
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<QuantityStepperRootProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: import("react").ForwardRefExoticComponent<QuantityStepperRootProviderProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a
DeclarationView source
useQuantityStepperts
declare function useQuantityStepper(input: QuantityStepperInput, options?: UseQuantityStepperOptions): UseQuantityStepperResult;
Name
Kind
Type
Requirement
input
parameter
QuantityStepperInput
required
options
parameter
UseQuantityStepperOptions
optional
return
return value
UseQuantityStepperResult
n/a
Name
input
Kind
parameter
Type
QuantityStepperInput
Requirement
required
Name
options
Kind
parameter
Type
UseQuantityStepperOptions
Requirement
optional
Name
return
Kind
return value
Type
UseQuantityStepperResult
Requirement
n/a
DeclarationView source
UseQuantityStepperOptionsts
interface UseQuantityStepperOptions {
readonly id?: string;
readonly ariaLabel?: string;
readonly onValueChange?: (detail: QuantityStepperChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
id
property
string
optional
onValueChange
property
(detail: QuantityStepperChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: QuantityStepperChangeDetail) => void
Requirement
optional
DeclarationView source
UseQuantityStepperResultts
interface UseQuantityStepperResult {
readonly service: QuantityStepperService;
readonly connector: QuantityStepperApi;
readonly scope: PartScope;
readonly snapshot: QuantityStepperSnapshot;
}
Name
Kind
Type
Requirement
connector
property
QuantityStepperApi
required
scope
property
PartScope
required
service
property
QuantityStepperService
required
snapshot
property
QuantityStepperSnapshot
required
Name
connector
Kind
property
Type
QuantityStepperApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
QuantityStepperService
Requirement
required
Name
snapshot
Kind
property
Type
QuantityStepperSnapshot
Requirement
required

Value

value
DeclarationView source
Valuets
export declare const Value: import("react").ForwardRefExoticComponent<QuantityStepperValueProps & import("react").RefAttributes<HTMLSpanElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

@grassroot/ui-headless-vue/quantity-stepper

Vue adapter

7 exports
View source packages/ui-headless/vue/src/quantity-stepper/index.ts

Decrement

value
DeclarationView source
Decrementts
export declare const Decrement: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => 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<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

Increment

value
DeclarationView source
Incrementts
export declare const Increment: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => 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<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

Root

value
DeclarationView source
Rootts
export declare const Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
min: NumberConstructor;
max: NumberConstructor;
step: NumberConstructor;
value: {
type: PropType<number | undefined>;
default: undefined;
};
defaultValue: {
type: PropType<number | undefined>;
default: undefined;
};
disabled: BooleanConstructor;
ariaLabel: StringConstructor;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
valueChange: (_detail: QuantityStepperChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
min: NumberConstructor;
max: NumberConstructor;
step: NumberConstructor;
value: {
type: PropType<number | undefined>;
default: undefined;
};
defaultValue: {
type: PropType<number | undefined>;
default: undefined;
};
disabled: BooleanConstructor;
ariaLabel: StringConstructor;
}>> & Readonly<{
onValueChange?: ((_detail: QuantityStepperChangeDetail) => any) | undefined;
}>, {
asChild: boolean;
value: number | undefined;
defaultValue: number | undefined;
disabled: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
value: {
type: PropType<UseQuantityStepperResult>;
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<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
value: {
type: PropType<UseQuantityStepperResult>;
required: true;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
useQuantityStepperts
declare function useQuantityStepper(input: () => QuantityStepperInput, options?: () => QuantityStepperOptions): UseQuantityStepperResult;
Name
Kind
Type
Requirement
input
parameter
() => QuantityStepperInput
required
options
parameter
() => QuantityStepperOptions
optional
return
return value
UseQuantityStepperResult
n/a
Name
input
Kind
parameter
Type
() => QuantityStepperInput
Requirement
required
Name
options
Kind
parameter
Type
() => QuantityStepperOptions
Requirement
optional
Name
return
Kind
return value
Type
UseQuantityStepperResult
Requirement
n/a
DeclarationView source
UseQuantityStepperResultts
interface UseQuantityStepperResult {
readonly service: QuantityStepperService;
readonly connector: QuantityStepperApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<QuantityStepperSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
QuantityStepperApi
required
scope
property
PartScope
required
service
property
QuantityStepperService
required
snapshot
property
ShallowRef<QuantityStepperSnapshot>
required
Name
connector
Kind
property
Type
QuantityStepperApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
QuantityStepperService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<QuantityStepperSnapshot>
Requirement
required

Value

value
DeclarationView source
Valuets
export declare const Value: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => 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<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

@grassroot/ui-headless-angular/quantity-stepper

Angular adapter

8 exports
View source packages/ui-headless/angular/src/quantity-stepper/index.ts
DeclarationView source
createQuantityStepperStorets
export declare function createQuantityStepperStore(initial: QuantityStepperInput, options?: CreateQuantityStepperStoreOptions): QuantityStepperStore;
Name
Kind
Type
Requirement
initial
parameter
QuantityStepperInput
required
options
parameter
CreateQuantityStepperStoreOptions
optional
return
return value
QuantityStepperStore
n/a
Name
initial
Kind
parameter
Type
QuantityStepperInput
Requirement
required
Name
options
Kind
parameter
Type
CreateQuantityStepperStoreOptions
Requirement
optional
Name
return
Kind
return value
Type
QuantityStepperStore
Requirement
n/a
DeclarationView source
CreateQuantityStepperStoreOptionsts
export interface CreateQuantityStepperStoreOptions {
readonly ariaLabel?: string;
readonly onValueChange?: (detail: QuantityStepperChangeDetail) => void;
readonly onCommit?: () => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
onCommit
property
() => void
optional
onValueChange
property
(detail: QuantityStepperChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
onCommit
Kind
property
Type
() => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: QuantityStepperChangeDetail) => void
Requirement
optional
DeclarationView source
GrQuantityStepperDecrementts
export declare class GrQuantityStepperDecrement implements OnDestroy {
private readonly store;
private readonly element;
private readonly listeners;
private readonly consumer;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrQuantityStepperDecrement, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrQuantityStepperDecrement, "[grQuantityStepperDecrement]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrQuantityStepperDecrement, "[grQuantityStepperDecrement]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrQuantityStepperDecrement, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrQuantityStepperDecrement, "[grQuantityStepperDecrement]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrQuantityStepperDecrement, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
DeclarationView source
GrQuantityStepperIncrementts
export declare class GrQuantityStepperIncrement implements OnDestroy {
private readonly store;
private readonly element;
private readonly listeners;
private readonly consumer;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrQuantityStepperIncrement, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrQuantityStepperIncrement, "[grQuantityStepperIncrement]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrQuantityStepperIncrement, "[grQuantityStepperIncrement]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrQuantityStepperIncrement, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrQuantityStepperIncrement, "[grQuantityStepperIncrement]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrQuantityStepperIncrement, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

Owns the store on the consumer's root element; it does not render a host wrapper. Angular has no runtime `as`/`asChild` primitive, so this attribute directive is the documented divergence: consumers choose the literal root element in the template (`<div grQuantityStepperRoot>`), while the part directives apply connector props to their own consumer-owned elements.

DeclarationView source
GrQuantityStepperRootts
export declare class GrQuantityStepperRoot implements OnDestroy {
readonly min: import("@angular/core").InputSignal<number | undefined>;
readonly max: import("@angular/core").InputSignal<number | undefined>;
readonly step: import("@angular/core").InputSignal<number | undefined>;
readonly value: import("@angular/core").InputSignal<number | undefined>;
readonly defaultValue: import("@angular/core").InputSignal<number | undefined>;
readonly disabled: import("@angular/core").InputSignal<boolean | undefined>;
readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>;
readonly valueChange: import("@angular/core").OutputEmitterRef<QuantityStepperChangeDetail>;
readonly store: QuantityStepperStore;
private readonly host;
private readonly listeners;
private last;
private readonly consumer;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrQuantityStepperRoot, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrQuantityStepperRoot, "[grQuantityStepperRoot]", never, { "min": { "alias": "min"; "required": false; "isSignal": true; }; "max": { "alias": "max"; "required": false; "isSignal": true; }; "step": { "alias": "step"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
}
Name
Kind
Type
Requirement
ariaLabel
property
import("@angular/core").InputSignal<string | undefined>
required
consumer
property
any
required
defaultValue
property
import("@angular/core").InputSignal<number | undefined>
required
disabled
property
import("@angular/core").InputSignal<boolean | undefined>
required
host
property
any
required
last
property
any
required
listeners
property
any
required
max
property
import("@angular/core").InputSignal<number | undefined>
required
min
property
import("@angular/core").InputSignal<number | undefined>
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrQuantityStepperRoot, "[grQuantityStepperRoot]", never, { "min": { "alias": "min"; "required": false; "isSignal": true; }; "max": { "alias": "max"; "required": false; "isSignal": true; }; "step": { "alias": "step"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; }, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrQuantityStepperRoot, never>
required
step
property
import("@angular/core").InputSignal<number | undefined>
required
store
property
QuantityStepperStore
required
Name
ariaLabel
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
defaultValue
Kind
property
Type
import("@angular/core").InputSignal<number | 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
max
Kind
property
Type
import("@angular/core").InputSignal<number | undefined>
Requirement
required
Name
min
Kind
property
Type
import("@angular/core").InputSignal<number | undefined>
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrQuantityStepperRoot, "[grQuantityStepperRoot]", never, { "min": { "alias": "min"; "required": false; "isSignal": true; }; "max": { "alias": "max"; "required": false; "isSignal": true; }; "step": { "alias": "step"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; }, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrQuantityStepperRoot, never>
Requirement
required
Name
step
Kind
property
Type
import("@angular/core").InputSignal<number | undefined>
Requirement
required
Name
store
Kind
property
Type
QuantityStepperStore
Requirement
required
Name
value
Kind
property
Type
import("@angular/core").InputSignal<number | undefined>
Requirement
required
Name
valueChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<QuantityStepperChangeDetail>
Requirement
required

Advanced composition counterpart; adopts the parent-provided store without adding a DOM node.

DeclarationView source
GrQuantityStepperRootProviderts
export declare class GrQuantityStepperRootProvider implements OnDestroy {
private readonly store;
private readonly host;
private readonly listeners;
private readonly consumer;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrQuantityStepperRootProvider, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrQuantityStepperRootProvider, "[grQuantityStepperRootProvider]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
host
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrQuantityStepperRootProvider, "[grQuantityStepperRootProvider]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrQuantityStepperRootProvider, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
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
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrQuantityStepperRootProvider, "[grQuantityStepperRootProvider]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrQuantityStepperRootProvider, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
DeclarationView source
GrQuantityStepperValuets
export declare class GrQuantityStepperValue implements OnDestroy {
private readonly store;
private readonly element;
private readonly listeners;
private readonly consumer;
private readonly hasChildren;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrQuantityStepperValue, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrQuantityStepperValue, "[grQuantityStepperValue]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
hasChildren
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrQuantityStepperValue, "[grQuantityStepperValue]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrQuantityStepperValue, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
hasChildren
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrQuantityStepperValue, "[grQuantityStepperValue]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrQuantityStepperValue, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
DeclarationView source
QuantityStepperStorets
export interface QuantityStepperStore {
readonly service: QuantityStepperService;
readonly connector: QuantityStepperApi;
readonly scope: PartScope;
readonly version: WritableSignal<number>;
start(): void;
stop(): void;
sync(input: QuantityStepperInput): void;
syncOptions(options: Record<string, unknown>): void;
}
Name
Kind
Type
Requirement
connector
property
QuantityStepperApi
required
scope
property
PartScope
required
service
property
QuantityStepperService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: QuantityStepperInput) => void
required
syncOptions
method
(options: Record<string, unknown>) => void
required
version
property
WritableSignal<number>
required
Name
connector
Kind
property
Type
QuantityStepperApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
QuantityStepperService
Requirement
required
Name
start
Kind
method
Type
() => void
Requirement
required
Name
stop
Kind
method
Type
() => void
Requirement
required
Name
sync
Kind
method
Type
(input: QuantityStepperInput) => void
Requirement
required
Name
syncOptions
Kind
method
Type
(options: Record<string, unknown>) => void
Requirement
required
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required

@grassroot/ui-headless-svelte/quantity-stepper

Svelte adapter

9 exports
View source packages/ui-headless/svelte/src/quantity-stepper/index.ts
DeclarationView source
createQuantityStepperts
export declare function createQuantityStepper(input: () => QuantityStepperInput, options?: UseQuantityStepperOptions): UseQuantityStepperResult;
Name
Kind
Type
Requirement
input
parameter
() => QuantityStepperInput
required
options
parameter
UseQuantityStepperOptions
optional
return
return value
UseQuantityStepperResult
n/a
Name
input
Kind
parameter
Type
() => QuantityStepperInput
Requirement
required
Name
options
Kind
parameter
Type
UseQuantityStepperOptions
Requirement
optional
Name
return
Kind
return value
Type
UseQuantityStepperResult
Requirement
n/a

Decrement

value
DeclarationView source
Decrementts
export declare const Decrement: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return 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

Increment

value
DeclarationView source
Incrementts
export declare const Increment: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return 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

Parts

value
DeclarationView source
Partsts
export declare const Parts: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return 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

Root

value
DeclarationView source
Rootts
export declare const Root: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return 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

value
DeclarationView source
RootProviderts
export declare const RootProvider: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return 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
DeclarationView source
UseQuantityStepperOptionsts
export interface UseQuantityStepperOptions {
readonly id?: string;
readonly ariaLabel?: string;
readonly onValueChange?: (detail: import("@grassroot/ui-headless-core/quantity-stepper").QuantityStepperChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
id
property
string
optional
onValueChange
property
(detail: import("@grassroot/ui-headless-core/quantity-stepper").QuantityStepperChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: import("@grassroot/ui-headless-core/quantity-stepper").QuantityStepperChangeDetail) => void
Requirement
optional
DeclarationView source
UseQuantityStepperResultts
export interface UseQuantityStepperResult {
readonly service: QuantityStepperService;
readonly connector: QuantityStepperApi;
readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>;
readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
QuantityStepperApi
required
scope
property
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
required
service
property
QuantityStepperService
required
version
property
() => number
required
Name
connector
Kind
property
Type
QuantityStepperApi
Requirement
required
Name
scope
Kind
property
Type
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
Requirement
required
Name
service
Kind
property
Type
QuantityStepperService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

Value

value
DeclarationView source
Valuets
export declare const Value: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return 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

@grassroot/ui-headless-solid/quantity-stepper

Solid adapter

12 exports
View source packages/ui-headless/solid/src/quantity-stepper/index.ts

Decrement

function
DeclarationView source
Decrementts
export declare function Decrement(props?: QuantityStepperButtonProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
QuantityStepperButtonProps
optional
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
QuantityStepperButtonProps
Requirement
optional
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

Increment

function
DeclarationView source
Incrementts
export declare function Increment(props?: QuantityStepperButtonProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
QuantityStepperButtonProps
optional
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
QuantityStepperButtonProps
Requirement
optional
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
QuantityStepperButtonPropsts
export interface QuantityStepperButtonProps extends JSX.ButtonHTMLAttributes<HTMLButtonElement> {
readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
children
property
JSX.Element
optional
Name
children
Kind
property
Type
JSX.Element
Requirement
optional
DeclarationView source
QuantityStepperRootPropsts
export interface QuantityStepperRootProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange" | "value" | "defaultValue">, QuantityStepperInput {
readonly ariaLabel?: string;
readonly id?: string;
readonly onValueChange?: (detail: QuantityStepperChangeDetail) => void;
readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
children
property
JSX.Element
optional
id
property
string
optional
onValueChange
property
(detail: QuantityStepperChangeDetail) => void
optional
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
onValueChange
Kind
property
Type
(detail: QuantityStepperChangeDetail) => void
Requirement
optional
DeclarationView source
QuantityStepperRootProviderPropsts
export interface QuantityStepperRootProviderProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange"> {
readonly value: UseQuantityStepperResult;
readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
children
property
JSX.Element
optional
value
property
UseQuantityStepperResult
required
Name
children
Kind
property
Type
JSX.Element
Requirement
optional
Name
value
Kind
property
Type
UseQuantityStepperResult
Requirement
required
DeclarationView source
QuantityStepperValuePropsts
export interface QuantityStepperValueProps extends JSX.HTMLAttributes<HTMLSpanElement> {
readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
children
property
JSX.Element
optional
Name
children
Kind
property
Type
JSX.Element
Requirement
optional

Root

function
DeclarationView source
Rootts
export declare function Root(props: QuantityStepperRootProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
QuantityStepperRootProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
QuantityStepperRootProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

RootProvider

function
DeclarationView source
RootProviderts
export declare function RootProvider(props: QuantityStepperRootProviderProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
QuantityStepperRootProviderProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
QuantityStepperRootProviderProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
useQuantityStepperts
export declare function useQuantityStepper(input: Accessor<QuantityStepperInput>, options?: UseQuantityStepperOptions): UseQuantityStepperResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<QuantityStepperInput>
required
options
parameter
UseQuantityStepperOptions
optional
return
return value
UseQuantityStepperResult
n/a
Name
input
Kind
parameter
Type
Accessor<QuantityStepperInput>
Requirement
required
Name
options
Kind
parameter
Type
UseQuantityStepperOptions
Requirement
optional
Name
return
Kind
return value
Type
UseQuantityStepperResult
Requirement
n/a
DeclarationView source
UseQuantityStepperOptionsts
export interface UseQuantityStepperOptions {
readonly id?: string;
readonly ariaLabel?: string;
readonly onValueChange?: (detail: QuantityStepperChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
id
property
string
optional
onValueChange
property
(detail: QuantityStepperChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: QuantityStepperChangeDetail) => void
Requirement
optional
DeclarationView source
UseQuantityStepperResultts
export interface UseQuantityStepperResult {
readonly service: QuantityStepperService;
readonly connector: QuantityStepperApi;
readonly scope: PartScope;
readonly snapshot: Accessor<QuantityStepperSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
QuantityStepperApi
required
scope
property
PartScope
required
service
property
QuantityStepperService
required
snapshot
property
Accessor<QuantityStepperSnapshot>
required
Name
connector
Kind
property
Type
QuantityStepperApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
QuantityStepperService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<QuantityStepperSnapshot>
Requirement
required

Value

function
DeclarationView source
Valuets
export declare function Value(props?: QuantityStepperValueProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
QuantityStepperValueProps
optional
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
QuantityStepperValueProps
Requirement
optional
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a