DocsAPI referenceHeadlessdate-picker

date-picker 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/date-picker

Core connector and vanilla API

15 exports
View source packages/ui-headless/core/src/date-picker/index.ts
DeclarationView source
activateDatePickerLayerts
declare function activateDatePickerLayer(service: DatePickerService, scope: PartScope, doc: Document): () => void;
Name
Kind
Type
Requirement
service
parameter
DatePickerService
required
scope
parameter
PartScope
required
doc
parameter
Document
required
return
return value
() => void
n/a
Name
service
Kind
parameter
Type
DatePickerService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
doc
Kind
parameter
Type
Document
Requirement
required
Name
return
Kind
return value
Type
() => void
Requirement
n/a
DeclarationView source
connectDatePickerts
declare function connectDatePicker(service: DatePickerService, scope: PartScope, options?: DatePickerConnectOptions): DatePickerApi;
Name
Kind
Type
Requirement
service
parameter
DatePickerService
required
scope
parameter
PartScope
required
options
parameter
DatePickerConnectOptions
optional
return
return value
DatePickerApi
n/a
Name
service
Kind
parameter
Type
DatePickerService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
DatePickerConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
DatePickerApi
Requirement
n/a
DeclarationView source
datePickerAnatomyts
export declare const datePickerAnatomy: {
readonly scope: "date-picker";
readonly parts: readonly ["root", "trigger", "content", "previous", "next", "label", "grid", "weekday", "day"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "trigger", "content", "previous", "next", "label", "grid", "weekday", "day"]
required
scope
property
"date-picker"
required
Name
parts
Kind
property
Type
readonly ["root", "trigger", "content", "previous", "next", "label", "grid", "weekday", "day"]
Requirement
required
Name
scope
Kind
property
Type
"date-picker"
Requirement
required

DatePickerApi

interface
DeclarationView source
DatePickerApits
interface DatePickerApi {
rootProps(): PartProps;
triggerProps(): PartProps;
contentProps(): PartProps;
previousProps(): PartProps;
nextProps(): PartProps;
labelProps(): PartProps;
gridProps(): PartProps;
weekdayProps(index: number): PartProps;
dayProps(index: number): PartProps;
hiddenInputProps(): PartProps;
days(): readonly CalendarDay[];
readonly value: string | null;
readonly open: boolean;
readonly year: number;
readonly month: number;
destroy(): void;
}
Name
Kind
Type
Requirement
contentProps
method
() => PartProps
required
dayProps
method
(index: number) => PartProps
required
days
method
() => readonly CalendarDay[]
required
destroy
method
() => void
required
gridProps
method
() => PartProps
required
hiddenInputProps
method
() => PartProps
required
labelProps
method
() => PartProps
required
month
property
number
required
nextProps
method
() => PartProps
required
open
property
boolean
required
previousProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
triggerProps
method
() => PartProps
required
value
property
string | null
required
Name
contentProps
Kind
method
Type
() => PartProps
Requirement
required
Name
dayProps
Kind
method
Type
(index: number) => PartProps
Requirement
required
Name
days
Kind
method
Type
() => readonly CalendarDay[]
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
gridProps
Kind
method
Type
() => PartProps
Requirement
required
Name
hiddenInputProps
Kind
method
Type
() => PartProps
Requirement
required
Name
labelProps
Kind
method
Type
() => PartProps
Requirement
required
Name
month
Kind
property
Type
number
Requirement
required
Name
nextProps
Kind
method
Type
() => PartProps
Requirement
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
previousProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
value
Kind
property
Type
string | null
Requirement
required
Name
weekdayProps
Kind
method
Type
(index: number) => PartProps
Requirement
required
Name
year
Kind
property
Type
number
Requirement
required
DeclarationView source
DatePickerChangeDetailts
interface DatePickerChangeDetail {
readonly value: string;
readonly reason: DatePickerReason;
}
Name
Kind
Type
Requirement
reason
property
DatePickerReason
required
value
property
string
required
Name
reason
Kind
property
Type
DatePickerReason
Requirement
required
Name
value
Kind
property
Type
string
Requirement
required
DeclarationView source
DatePickerConnectOptionsts
interface DatePickerConnectOptions {
readonly ariaLabel?: string;
readonly dayLabel?: (value: string) => string;
readonly messages?: Partial<DatePickerMessages>;
readonly onValueChange?: (detail: DatePickerChangeDetail) => void;
readonly onOpenChange?: (detail: DatePickerOpenChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
dayLabel
property
(value: string) => string
optional
messages
property
Partial<DatePickerMessages>
optional
onOpenChange
property
(detail: DatePickerOpenChangeDetail) => void
optional
onValueChange
property
(detail: DatePickerChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
dayLabel
Kind
property
Type
(value: string) => string
Requirement
optional
Name
messages
Kind
property
Type
Partial<DatePickerMessages>
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: DatePickerOpenChangeDetail) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: DatePickerChangeDetail) => void
Requirement
optional
DeclarationView source
datePickerMessagests
export declare const datePickerMessages: DatePickerMessages;
DeclarationView source
DatePickerMessagests
type DatePickerMessages = Pick<MessageTable, "rootLabel" | "contentLabel" | "previousMonthLabel" | "nextMonthLabel">;

DatePickerMount

interface
DeclarationView source
DatePickerMountts
interface DatePickerMount {
readonly service: DatePickerService;
readonly connector: DatePickerApi;
readonly root: HTMLElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
DatePickerApi
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
DatePickerService
required
Name
connector
Kind
property
Type
DatePickerApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
Name
service
Kind
property
Type
DatePickerService
Requirement
required
DeclarationView source
DatePickerOpenChangeDetailts
interface DatePickerOpenChangeDetail {
readonly open: boolean;
readonly reason: DatePickerReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
DatePickerReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
DatePickerReason
Requirement
required
DeclarationView source
DatePickerPartts
type DatePickerPart = (typeof datePickerAnatomy.parts)[number];
DeclarationView source
DatePickerServicets
type DatePickerService = Service<DatePickerInput, "ready", DatePickerContext, DatePickerEvent, DatePickerCommand>;

mountDatePicker

function
DeclarationView source
mountDatePickerts
declare function mountDatePicker(container: HTMLElement, options?: MountDatePickerOptions): DatePickerMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountDatePickerOptions
optional
return
return value
DatePickerMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountDatePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
DatePickerMount
Requirement
n/a
DeclarationView source
MountDatePickerOptionsts
interface MountDatePickerOptions extends DatePickerInput, Pick<DatePickerConnectOptions, "ariaLabel" | "dayLabel" | "messages"> {
readonly onValueChange?: (detail: DatePickerChangeDetail) => void;
}
Name
Kind
Type
Requirement
onValueChange
property
(detail: DatePickerChangeDetail) => void
optional
Name
onValueChange
Kind
property
Type
(detail: DatePickerChangeDetail) => void
Requirement
optional
DeclarationView source
runDatePickerCommandts
declare function runDatePickerCommand(command: DatePickerCommand, options?: DatePickerConnectOptions): void;
Name
Kind
Type
Requirement
command
parameter
DatePickerCommand
required
options
parameter
DatePickerConnectOptions
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
DatePickerCommand
Requirement
required
Name
options
Kind
parameter
Type
DatePickerConnectOptions
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/date-pickerts
import { Root, RootProvider } from "@grassroot/ui-headless-react/date-picker";

Vue imports

@grassroot/ui-headless-vue/date-pickerts
<script setup lang="ts">
import { Root, RootProvider } from "@grassroot/ui-headless-vue/date-picker";
</script>

Angular imports

@grassroot/ui-headless-angular/date-pickerts
import { GrDatePickerRoot, GrDatePickerRootProvider } from "@grassroot/ui-headless-angular/date-picker";

Svelte imports

@grassroot/ui-headless-svelte/date-pickerts
<script lang="ts">
import { Root } from "@grassroot/ui-headless-svelte/date-picker";
</script>

Solid imports

@grassroot/ui-headless-solid/date-pickerts
import { Root, RootProvider } from "@grassroot/ui-headless-solid/date-picker";

@grassroot/ui-headless-react/date-picker

React adapter

8 exports
View source packages/ui-headless/react/src/date-picker/index.ts
DeclarationView source
DatePickerRootPropsts
interface DatePickerRootProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "dir" | "onChange">, DatePickerInput {
readonly id?: string;
readonly ariaLabel?: string;
readonly dayLabel?: (value: string) => string;
readonly onValueChange?: (detail: {
readonly value: string;
readonly reason: string;
}) => void;
readonly onOpenChange?: (detail: {
readonly open: boolean;
readonly reason: string;
}) => void;
readonly monthLabel?: (year: number, month: number) => ReactNode;
readonly weekdayLabels?: readonly ReactNode[];
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
dayLabel
property
(value: string) => string
optional
id
property
string
optional
monthLabel
property
(year: number, month: number) => ReactNode
optional
onOpenChange
property
(detail: { readonly open: boolean; readonly reason: string; }) => void
optional
onValueChange
property
(detail: { readonly value: string; readonly reason: string; }) => void
optional
weekdayLabels
property
readonly ReactNode[]
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
dayLabel
Kind
property
Type
(value: string) => string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
monthLabel
Kind
property
Type
(year: number, month: number) => ReactNode
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: { readonly open: boolean; readonly reason: string; }) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: { readonly value: string; readonly reason: string; }) => void
Requirement
optional
Name
weekdayLabels
Kind
property
Type
readonly ReactNode[]
Requirement
optional
DeclarationView source
DatePickerRootProviderPropsts
interface DatePickerRootProviderProps extends HTMLAttributes<HTMLDivElement> {
readonly value: UseDatePickerResult;
readonly monthLabel?: (year: number, month: number) => ReactNode;
readonly weekdayLabels?: readonly ReactNode[];
}
Name
Kind
Type
Requirement
monthLabel
property
(year: number, month: number) => ReactNode
optional
value
property
UseDatePickerResult
required
weekdayLabels
property
readonly ReactNode[]
optional
Name
monthLabel
Kind
property
Type
(year: number, month: number) => ReactNode
Requirement
optional
Name
value
Kind
property
Type
UseDatePickerResult
Requirement
required
Name
weekdayLabels
Kind
property
Type
readonly ReactNode[]
Requirement
optional

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<DatePickerRootProps & 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<DatePickerRootProviderProps & 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

useDatePicker

function
DeclarationView source
useDatePickerts
declare function useDatePicker(input: DatePickerInput, options?: UseDatePickerOptions): UseDatePickerResult;
Name
Kind
Type
Requirement
input
parameter
DatePickerInput
required
options
parameter
UseDatePickerOptions
optional
return
return value
UseDatePickerResult
n/a
Name
input
Kind
parameter
Type
DatePickerInput
Requirement
required
Name
options
Kind
parameter
Type
UseDatePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDatePickerResult
Requirement
n/a
DeclarationView source
useDatePickerContextts
declare function useDatePickerContext(part: string): UseDatePickerResult;
Name
Kind
Type
Requirement
part
parameter
string
required
return
return value
UseDatePickerResult
n/a
Name
part
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
UseDatePickerResult
Requirement
n/a
DeclarationView source
UseDatePickerOptionsts
interface UseDatePickerOptions {
readonly id?: string;
readonly ariaLabel?: string;
readonly dayLabel?: (value: string) => string;
readonly onValueChange?: (detail: {
readonly value: string;
readonly reason: string;
}) => void;
readonly onOpenChange?: (detail: DatePickerOpenChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
dayLabel
property
(value: string) => string
optional
id
property
string
optional
onOpenChange
property
(detail: DatePickerOpenChangeDetail) => void
optional
onValueChange
property
(detail: { readonly value: string; readonly reason: string; }) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
dayLabel
Kind
property
Type
(value: string) => string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: DatePickerOpenChangeDetail) => void
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: { readonly value: string; readonly reason: string; }) => void
Requirement
optional
DeclarationView source
UseDatePickerResultts
interface UseDatePickerResult {
readonly service: DatePickerService;
readonly connector: DatePickerApi;
readonly snapshot: DatePickerSnapshot;
}
Name
Kind
Type
Requirement
connector
property
DatePickerApi
required
service
property
DatePickerService
required
snapshot
property
DatePickerSnapshot
required
Name
connector
Kind
property
Type
DatePickerApi
Requirement
required
Name
service
Kind
property
Type
DatePickerService
Requirement
required
Name
snapshot
Kind
property
Type
DatePickerSnapshot
Requirement
required

@grassroot/ui-headless-vue/date-picker

Vue adapter

5 exports
View source packages/ui-headless/vue/src/date-picker/index.ts

Root

value
DeclarationView source
Rootts
export declare const Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
value: PropType<DatePickerInput["value"]>;
defaultValue: PropType<DatePickerInput["defaultValue"]>;
open: {
type: PropType<DatePickerInput["open"]>;
default: undefined;
};
defaultOpen: BooleanConstructor;
today: StringConstructor;
weekStartsOn: NumberConstructor;
id: StringConstructor;
ariaLabel: StringConstructor;
dayLabel: PropType<(value: string) => string>;
monthLabel: PropType<(year: number, month: number) => unknown>;
weekdayLabels: PropType<readonly unknown[]>;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
openChange: (_detail: unknown) => true;
valueChange: (_detail: unknown) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
value: PropType<DatePickerInput["value"]>;
defaultValue: PropType<DatePickerInput["defaultValue"]>;
open: {
type: PropType<DatePickerInput["open"]>;
default: undefined;
};
defaultOpen: BooleanConstructor;
today: StringConstructor;
weekStartsOn: NumberConstructor;
id: StringConstructor;
ariaLabel: StringConstructor;
dayLabel: PropType<(value: string) => string>;
monthLabel: PropType<(year: number, month: number) => unknown>;
weekdayLabels: PropType<readonly unknown[]>;
}>> & Readonly<{
onOpenChange?: ((_detail: unknown) => any) | undefined;
onValueChange?: ((_detail: unknown) => any) | undefined;
}>, {
open: boolean | undefined;
defaultOpen: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
value: {
type: PropType<UseDatePickerResult>;
required: true;
};
monthLabel: PropType<(year: number, month: number) => unknown>;
weekdayLabels: PropType<readonly unknown[]>;
}>, () => 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<UseDatePickerResult>;
required: true;
};
monthLabel: PropType<(year: number, month: number) => unknown>;
weekdayLabels: PropType<readonly unknown[]>;
}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

useDatePicker

function
DeclarationView source
useDatePickerts
declare function useDatePicker(input: () => DatePickerInput, options?: () => DatePickerOptions): UseDatePickerResult;
Name
Kind
Type
Requirement
input
parameter
() => DatePickerInput
required
options
parameter
() => DatePickerOptions
optional
return
return value
UseDatePickerResult
n/a
Name
input
Kind
parameter
Type
() => DatePickerInput
Requirement
required
Name
options
Kind
parameter
Type
() => DatePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDatePickerResult
Requirement
n/a
DeclarationView source
useDatePickerContextts
declare function useDatePickerContext(part: string): UseDatePickerResult;
Name
Kind
Type
Requirement
part
parameter
string
required
return
return value
UseDatePickerResult
n/a
Name
part
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
UseDatePickerResult
Requirement
n/a
DeclarationView source
UseDatePickerResultts
interface UseDatePickerResult {
readonly service: DatePickerService;
readonly connector: DatePickerApi;
readonly snapshot: ShallowRef<DatePickerSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
DatePickerApi
required
service
property
DatePickerService
required
snapshot
property
ShallowRef<DatePickerSnapshot>
required
Name
connector
Kind
property
Type
DatePickerApi
Requirement
required
Name
service
Kind
property
Type
DatePickerService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<DatePickerSnapshot>
Requirement
required

@grassroot/ui-headless-angular/date-picker

Angular adapter

4 exports
View source packages/ui-headless/angular/src/date-picker/index.ts
DeclarationView source
createDatePickerStorets
export declare function createDatePickerStore(initial: Record<string, unknown>, options?: DatePickerOptions): DatePickerStore;
Name
Kind
Type
Requirement
initial
parameter
Record<string, unknown>
required
options
parameter
DatePickerOptions
optional
return
return value
DatePickerStore
n/a
Name
initial
Kind
parameter
Type
Record<string, unknown>
Requirement
required
Name
options
Kind
parameter
Type
DatePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
DatePickerStore
Requirement
n/a

DatePickerStore

interface
DeclarationView source
DatePickerStorets
export interface DatePickerStore {
readonly service: DatePickerService;
readonly connector: DatePickerApi;
readonly scope: PartScope;
readonly version: WritableSignal<number>;
start(): void;
stop(): void;
sync(input: Record<string, unknown>): void;
syncOptions(options: Record<string, unknown>): void;
}
Name
Kind
Type
Requirement
connector
property
DatePickerApi
required
scope
property
PartScope
required
service
property
DatePickerService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: Record<string, unknown>) => void
required
syncOptions
method
(options: Record<string, unknown>) => void
required
version
property
WritableSignal<number>
required
Name
connector
Kind
property
Type
DatePickerApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DatePickerService
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
syncOptions
Kind
method
Type
(options: Record<string, unknown>) => void
Requirement
required
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required
DeclarationView source
GrDatePickerRootts
export declare class GrDatePickerRoot implements OnDestroy {
readonly value: import("@angular/core").InputSignal<string | null | undefined>;
readonly defaultValue: import("@angular/core").InputSignal<string | null | undefined>;
readonly open: import("@angular/core").InputSignal<boolean | undefined>;
readonly defaultOpen: import("@angular/core").InputSignal<boolean>;
readonly today: import("@angular/core").InputSignal<string | undefined>;
readonly weekStartsOn: import("@angular/core").InputSignal<number | undefined>;
readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>;
readonly dayLabel: import("@angular/core").InputSignal<((value: string) => string) | undefined>;
readonly valueChange: import("@angular/core").OutputEmitterRef<{
value: string;
reason: string;
}>;
readonly openChange: import("@angular/core").OutputEmitterRef<{
open: boolean;
reason: string;
}>;
readonly store: DatePickerStore;
private readonly host;
private readonly parts;
private contentElement?;
private last;
constructor();
private applyParts;
private ensureGrid;
private apply;
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDatePickerRoot, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<GrDatePickerRoot, "gr-date-picker-root", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "today": { "alias": "today"; "required": false; "isSignal": true; }; "weekStartsOn": { "alias": "weekStartsOn"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "dayLabel": { "alias": "dayLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "openChange": "openChange"; }, never, never, true, never>;
}
Name
Kind
Type
Requirement
apply
property
any
required
applyParts
property
any
required
ariaLabel
property
import("@angular/core").InputSignal<string | undefined>
required
contentElement
property
any
optional
dayLabel
property
import("@angular/core").InputSignal<((value: string) => string) | undefined>
required
defaultOpen
property
import("@angular/core").InputSignal<boolean>
required
defaultValue
property
import("@angular/core").InputSignal<string | null | undefined>
required
ensureGrid
property
any
required
host
property
any
required
last
property
any
required
ngOnDestroy
method
() => void
required
open
property
import("@angular/core").InputSignal<boolean | undefined>
required
openChange
property
import("@angular/core").OutputEmitterRef<{ open: boolean; reason: string; }>
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrDatePickerRoot, "gr-date-picker-root", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "today": { "alias": "today"; "required": false; "isSignal": true; }; "weekStartsOn": { "alias": "weekStartsOn"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "dayLabel": { "alias": "dayLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "openChange": "openChange"; }, never, never, true, never>
required
Name
apply
Kind
property
Type
any
Requirement
required
Name
applyParts
Kind
property
Type
any
Requirement
required
Name
ariaLabel
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
contentElement
Kind
property
Type
any
Requirement
optional
Name
dayLabel
Kind
property
Type
import("@angular/core").InputSignal<((value: string) => string) | undefined>
Requirement
required
Name
defaultOpen
Kind
property
Type
import("@angular/core").InputSignal<boolean>
Requirement
required
Name
defaultValue
Kind
property
Type
import("@angular/core").InputSignal<string | null | undefined>
Requirement
required
Name
ensureGrid
Kind
property
Type
any
Requirement
required
Name
host
Kind
property
Type
any
Requirement
required
Name
last
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
open
Kind
property
Type
import("@angular/core").InputSignal<boolean | undefined>
Requirement
required
Name
openChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<{ open: boolean; reason: string; }>
Requirement
required
Name
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrDatePickerRoot, "gr-date-picker-root", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "today": { "alias": "today"; "required": false; "isSignal": true; }; "weekStartsOn": { "alias": "weekStartsOn"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "dayLabel": { "alias": "dayLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "openChange": "openChange"; }, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDatePickerRoot, never>
Requirement
required
Name
parts
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
DatePickerStore
Requirement
required
Name
today
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
value
Kind
property
Type
import("@angular/core").InputSignal<string | null | undefined>
Requirement
required
Name
valueChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<{ value: string; reason: string; }>
Requirement
required
Name
weekStartsOn
Kind
property
Type
import("@angular/core").InputSignal<number | undefined>
Requirement
required
DeclarationView source
GrDatePickerRootProviderts
export declare class GrDatePickerRootProvider implements OnDestroy {
private readonly store;
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDatePickerRootProvider, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<GrDatePickerRootProvider, "gr-date-picker-root-provider", never, {}, {}, never, ["*"], true, never>;
}
Name
Kind
Type
Requirement
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrDatePickerRootProvider, "gr-date-picker-root-provider", never, {}, {}, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDatePickerRootProvider, never>
required
store
property
any
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrDatePickerRootProvider, "gr-date-picker-root-provider", never, {}, {}, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDatePickerRootProvider, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

@grassroot/ui-headless-svelte/date-picker

Svelte adapter

2 exports
View source packages/ui-headless/svelte/src/date-picker/index.ts

createDatePicker

function
DeclarationView source
createDatePickerts
export declare function createDatePicker(input: () => DatePickerInput, options?: UseDatePickerOptions): UseDatePickerResult;
Name
Kind
Type
Requirement
input
parameter
() => DatePickerInput
required
options
parameter
UseDatePickerOptions
optional
return
return value
UseDatePickerResult
n/a
Name
input
Kind
parameter
Type
() => DatePickerInput
Requirement
required
Name
options
Kind
parameter
Type
UseDatePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDatePickerResult
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

@grassroot/ui-headless-solid/date-picker

Solid adapter

5 exports
View source packages/ui-headless/solid/src/date-picker/index.ts

Root

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

RootProvider

function
DeclarationView source
RootProviderts
export declare function RootProvider(props: {
value: UseDatePickerResult;
} & JSX.HTMLAttributes<HTMLDivElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ value: UseDatePickerResult; } & JSX.HTMLAttributes<HTMLDivElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ value: UseDatePickerResult; } & JSX.HTMLAttributes<HTMLDivElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

useDatePicker

function
DeclarationView source
useDatePickerts
export declare function useDatePicker(input: Accessor<DatePickerInput>, options?: DatePickerOptions): UseDatePickerResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<DatePickerInput>
required
options
parameter
DatePickerOptions
optional
return
return value
UseDatePickerResult
n/a
Name
input
Kind
parameter
Type
Accessor<DatePickerInput>
Requirement
required
Name
options
Kind
parameter
Type
DatePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDatePickerResult
Requirement
n/a
DeclarationView source
useDatePickerContextts
export declare function useDatePickerContext(part: string): UseDatePickerResult;
Name
Kind
Type
Requirement
part
parameter
string
required
return
return value
UseDatePickerResult
n/a
Name
part
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
UseDatePickerResult
Requirement
n/a
DeclarationView source
UseDatePickerResultts
export interface UseDatePickerResult {
readonly service: DatePickerService;
readonly connector: DatePickerApi;
readonly scope: PartScope;
readonly snapshot: Accessor<DatePickerSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
DatePickerApi
required
scope
property
PartScope
required
service
property
DatePickerService
required
snapshot
property
Accessor<DatePickerSnapshot>
required
Name
connector
Kind
property
Type
DatePickerApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DatePickerService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<DatePickerSnapshot>
Requirement
required