DocsAPI referenceHeadlessdate-range-picker

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

Core connector and vanilla API

14 exports
View source packages/ui-headless/core/src/date-range-picker/index.ts
DeclarationView source
activateDateRangePickerLayerts
declare function activateDateRangePickerLayer(service: DateRangePickerService, scope: PartScope, doc: Document): () => void;
Name
Kind
Type
Requirement
service
parameter
DateRangePickerService
required
scope
parameter
PartScope
required
doc
parameter
Document
required
return
return value
() => void
n/a
Name
service
Kind
parameter
Type
DateRangePickerService
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
connectDateRangePickerts
declare function connectDateRangePicker(service: DateRangePickerService, scope: PartScope, options?: DateRangePickerConnectOptions): DateRangePickerApi;
Name
Kind
Type
Requirement
service
parameter
DateRangePickerService
required
scope
parameter
PartScope
required
options
parameter
DateRangePickerConnectOptions
optional
return
return value
DateRangePickerApi
n/a
Name
service
Kind
parameter
Type
DateRangePickerService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
DateRangePickerConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
DateRangePickerApi
Requirement
n/a
DeclarationView source
DateRangeChangeDetailts
interface DateRangeChangeDetail {
readonly value: DateRange;
readonly reason: DateRangePickerReason;
}
Name
Kind
Type
Requirement
reason
property
DateRangePickerReason
required
value
property
DateRange
required
Name
reason
Kind
property
Type
DateRangePickerReason
Requirement
required
Name
value
Kind
property
Type
DateRange
Requirement
required
DeclarationView source
dateRangePickerAnatomyts
export declare const dateRangePickerAnatomy: {
readonly scope: "date-range-picker";
readonly parts: readonly ["root", "trigger", "content", "previous", "next", "label", "grid", "weekday", "preset", "cell", "band", "day", "footer"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "trigger", "content", "previous", "next", "label", "grid", "weekday", "preset", "cell", "band", "day", "footer"]
required
scope
property
"date-range-picker"
required
Name
parts
Kind
property
Type
readonly ["root", "trigger", "content", "previous", "next", "label", "grid", "weekday", "preset", "cell", "band", "day", "footer"]
Requirement
required
Name
scope
Kind
property
Type
"date-range-picker"
Requirement
required

DateRangePickerApi

interface
DeclarationView source
DateRangePickerApits
interface DateRangePickerApi {
rootProps(): PartProps;
triggerProps(): PartProps;
contentProps(): PartProps;
previousProps(): PartProps;
nextProps(): PartProps;
labelProps(): PartProps;
gridProps(): PartProps;
weekdayProps(index: number): PartProps;
presetProps(index: number): PartProps;
cellProps(index: number): PartProps;
bandProps(index: number): PartProps | undefined;
dayProps(index: number): PartProps;
footerProps(): PartProps;
days(): readonly DateRangeDay[];
presets(): readonly string[];
readonly range: DateRange;
readonly hover: string | null;
readonly open: boolean;
readonly year: number;
readonly month: number;
destroy(): void;
}
Name
Kind
Type
Requirement
bandProps
method
(index: number) => PartProps | undefined
required
cellProps
method
(index: number) => PartProps
required
contentProps
method
() => PartProps
required
dayProps
method
(index: number) => PartProps
required
days
method
() => readonly DateRangeDay[]
required
destroy
method
() => void
required
footerProps
method
() => PartProps
required
gridProps
method
() => PartProps
required
hover
property
string | null
required
labelProps
method
() => PartProps
required
month
property
number
required
nextProps
method
() => PartProps
required
open
property
boolean
required
presetProps
method
(index: number) => PartProps
required
Name
bandProps
Kind
method
Type
(index: number) => PartProps | undefined
Requirement
required
Name
cellProps
Kind
method
Type
(index: number) => PartProps
Requirement
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 DateRangeDay[]
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
footerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
gridProps
Kind
method
Type
() => PartProps
Requirement
required
Name
hover
Kind
property
Type
string | null
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
presetProps
Kind
method
Type
(index: number) => PartProps
Requirement
required
Name
presets
Kind
method
Type
() => readonly string[]
Requirement
required
Name
previousProps
Kind
method
Type
() => PartProps
Requirement
required
Name
range
Kind
property
Type
DateRange
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
weekdayProps
Kind
method
Type
(index: number) => PartProps
Requirement
required
Name
year
Kind
property
Type
number
Requirement
required
DeclarationView source
DateRangePickerConnectOptionsts
interface DateRangePickerConnectOptions {
readonly ariaLabel?: string;
readonly dayLabel?: (value: string) => string;
readonly messages?: Partial<DateRangePickerMessages>;
readonly onValueChange?: (detail: DateRangeChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
dayLabel
property
(value: string) => string
optional
messages
property
Partial<DateRangePickerMessages>
optional
onValueChange
property
(detail: DateRangeChangeDetail) => 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<DateRangePickerMessages>
Requirement
optional
Name
onValueChange
Kind
property
Type
(detail: DateRangeChangeDetail) => void
Requirement
optional
DeclarationView source
dateRangePickerMessagests
export declare const dateRangePickerMessages: DateRangePickerMessages;
DeclarationView source
DateRangePickerMessagests
type DateRangePickerMessages = Pick<MessageTable, "rootLabel" | "contentLabel" | "previousMonthLabel" | "nextMonthLabel">;
DeclarationView source
DateRangePickerMountts
interface DateRangePickerMount {
readonly service: DateRangePickerService;
readonly connector: DateRangePickerApi;
readonly root: HTMLElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
DateRangePickerApi
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
DateRangePickerService
required
Name
connector
Kind
property
Type
DateRangePickerApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
Name
service
Kind
property
Type
DateRangePickerService
Requirement
required
DeclarationView source
DateRangePickerPartts
type DateRangePickerPart = (typeof dateRangePickerAnatomy.parts)[number];
DeclarationView source
DateRangePickerServicets
type DateRangePickerService = Service<DateRangePickerInput, "ready", DateRangePickerContext, DateRangePickerEvent, DateRangePickerCommand>;
DeclarationView source
mountDateRangePickerts
declare function mountDateRangePicker(container: HTMLElement, options?: MountDateRangePickerOptions): DateRangePickerMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountDateRangePickerOptions
optional
return
return value
DateRangePickerMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountDateRangePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
DateRangePickerMount
Requirement
n/a
DeclarationView source
MountDateRangePickerOptionsts
interface MountDateRangePickerOptions extends DateRangePickerInput, Pick<DateRangePickerConnectOptions, "ariaLabel" | "dayLabel" | "messages"> {
readonly onValueChange?: (detail: DateRangeChangeDetail) => void;
}
Name
Kind
Type
Requirement
onValueChange
property
(detail: DateRangeChangeDetail) => void
optional
Name
onValueChange
Kind
property
Type
(detail: DateRangeChangeDetail) => void
Requirement
optional
DeclarationView source
runDateRangePickerCommandts
declare function runDateRangePickerCommand(command: DateRangePickerCommand, options?: DateRangePickerConnectOptions): void;
Name
Kind
Type
Requirement
command
parameter
DateRangePickerCommand
required
options
parameter
DateRangePickerConnectOptions
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
DateRangePickerCommand
Requirement
required
Name
options
Kind
parameter
Type
DateRangePickerConnectOptions
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-range-pickerts
import { Root, RootProvider } from "@grassroot/ui-headless-react/date-range-picker";

Vue imports

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

Angular imports

@grassroot/ui-headless-angular/date-range-pickerts
import { GrDateRangePickerRoot, GrDateRangePickerRootProvider } from "@grassroot/ui-headless-angular/date-range-picker";

Svelte imports

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

Solid imports

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

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

React adapter

8 exports
View source packages/ui-headless/react/src/date-range-picker/index.ts
DeclarationView source
DateRangePickerRootPropsts
interface DateRangePickerRootProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "onChange">, DateRangePickerInput {
readonly id?: string;
readonly ariaLabel?: string;
readonly dayLabel?: (value: string) => string;
readonly onValueChange?: (detail: DateRangeChangeDetail) => 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
onValueChange
property
(detail: DateRangeChangeDetail) => 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
onValueChange
Kind
property
Type
(detail: DateRangeChangeDetail) => void
Requirement
optional
Name
weekdayLabels
Kind
property
Type
readonly ReactNode[]
Requirement
optional
DeclarationView source
DateRangePickerRootProviderPropsts
interface DateRangePickerRootProviderProps extends HTMLAttributes<HTMLDivElement> {
readonly value: UseDateRangePickerResult;
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
UseDateRangePickerResult
required
weekdayLabels
property
readonly ReactNode[]
optional
Name
monthLabel
Kind
property
Type
(year: number, month: number) => ReactNode
Requirement
optional
Name
value
Kind
property
Type
UseDateRangePickerResult
Requirement
required
Name
weekdayLabels
Kind
property
Type
readonly ReactNode[]
Requirement
optional

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<DateRangePickerRootProps & 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<DateRangePickerRootProviderProps & 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
useDateRangePickerts
declare function useDateRangePicker(input: DateRangePickerInput, options?: UseDateRangePickerOptions): UseDateRangePickerResult;
Name
Kind
Type
Requirement
input
parameter
DateRangePickerInput
required
options
parameter
UseDateRangePickerOptions
optional
return
return value
UseDateRangePickerResult
n/a
Name
input
Kind
parameter
Type
DateRangePickerInput
Requirement
required
Name
options
Kind
parameter
Type
UseDateRangePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDateRangePickerResult
Requirement
n/a
DeclarationView source
useDateRangePickerContextts
declare function useDateRangePickerContext(part: string): UseDateRangePickerResult;
Name
Kind
Type
Requirement
part
parameter
string
required
return
return value
UseDateRangePickerResult
n/a
Name
part
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
UseDateRangePickerResult
Requirement
n/a
DeclarationView source
UseDateRangePickerOptionsts
interface UseDateRangePickerOptions {
readonly id?: string;
readonly ariaLabel?: string;
readonly dayLabel?: (value: string) => string;
readonly onValueChange?: (detail: DateRangeChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
dayLabel
property
(value: string) => string
optional
id
property
string
optional
onValueChange
property
(detail: DateRangeChangeDetail) => 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
onValueChange
Kind
property
Type
(detail: DateRangeChangeDetail) => void
Requirement
optional
DeclarationView source
UseDateRangePickerResultts
interface UseDateRangePickerResult {
readonly service: DateRangePickerService;
readonly connector: DateRangePickerApi;
readonly snapshot: DateRangePickerSnapshot;
}
Name
Kind
Type
Requirement
connector
property
DateRangePickerApi
required
service
property
DateRangePickerService
required
snapshot
property
DateRangePickerSnapshot
required
Name
connector
Kind
property
Type
DateRangePickerApi
Requirement
required
Name
service
Kind
property
Type
DateRangePickerService
Requirement
required
Name
snapshot
Kind
property
Type
DateRangePickerSnapshot
Requirement
required

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

Vue adapter

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

Root

value
DeclarationView source
Rootts
export declare const Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
value: PropType<DateRangePickerInput["value"]>;
defaultValue: PropType<DateRangePickerInput["defaultValue"]>;
defaultOpen: BooleanConstructor;
today: StringConstructor;
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, {
valueChange: (_detail: unknown) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
value: PropType<DateRangePickerInput["value"]>;
defaultValue: PropType<DateRangePickerInput["defaultValue"]>;
defaultOpen: BooleanConstructor;
today: StringConstructor;
id: StringConstructor;
ariaLabel: StringConstructor;
dayLabel: PropType<(value: string) => string>;
monthLabel: PropType<(year: number, month: number) => unknown>;
weekdayLabels: PropType<readonly unknown[]>;
}>> & Readonly<{
onValueChange?: ((_detail: unknown) => any) | 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<UseDateRangePickerResult>;
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<UseDateRangePickerResult>;
required: true;
};
monthLabel: PropType<(year: number, month: number) => unknown>;
weekdayLabels: PropType<readonly unknown[]>;
}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
useDateRangePickerts
declare function useDateRangePicker(input: () => DateRangePickerInput, options?: () => DateRangePickerOptions): UseDateRangePickerResult;
Name
Kind
Type
Requirement
input
parameter
() => DateRangePickerInput
required
options
parameter
() => DateRangePickerOptions
optional
return
return value
UseDateRangePickerResult
n/a
Name
input
Kind
parameter
Type
() => DateRangePickerInput
Requirement
required
Name
options
Kind
parameter
Type
() => DateRangePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDateRangePickerResult
Requirement
n/a
DeclarationView source
useDateRangePickerContextts
declare function useDateRangePickerContext(part: string): UseDateRangePickerResult;
Name
Kind
Type
Requirement
part
parameter
string
required
return
return value
UseDateRangePickerResult
n/a
Name
part
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
UseDateRangePickerResult
Requirement
n/a
DeclarationView source
UseDateRangePickerResultts
interface UseDateRangePickerResult {
readonly service: DateRangePickerService;
readonly connector: DateRangePickerApi;
readonly snapshot: ShallowRef<DateRangePickerSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
DateRangePickerApi
required
service
property
DateRangePickerService
required
snapshot
property
ShallowRef<DateRangePickerSnapshot>
required
Name
connector
Kind
property
Type
DateRangePickerApi
Requirement
required
Name
service
Kind
property
Type
DateRangePickerService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<DateRangePickerSnapshot>
Requirement
required

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

Angular adapter

4 exports
View source packages/ui-headless/angular/src/date-range-picker/index.ts
DeclarationView source
createDateRangePickerStorets
export declare function createDateRangePickerStore(initial: Record<string, unknown>, options?: DateRangePickerOptions): DateRangePickerStore;
Name
Kind
Type
Requirement
initial
parameter
Record<string, unknown>
required
options
parameter
DateRangePickerOptions
optional
return
return value
DateRangePickerStore
n/a
Name
initial
Kind
parameter
Type
Record<string, unknown>
Requirement
required
Name
options
Kind
parameter
Type
DateRangePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
DateRangePickerStore
Requirement
n/a
DeclarationView source
DateRangePickerStorets
export interface DateRangePickerStore {
readonly service: DateRangePickerService;
readonly connector: DateRangePickerApi;
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
DateRangePickerApi
required
scope
property
PartScope
required
service
property
DateRangePickerService
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
DateRangePickerApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DateRangePickerService
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
GrDateRangePickerRootts
export declare class GrDateRangePickerRoot implements OnDestroy {
readonly value: import("@angular/core").InputSignal<{
start: string | null;
end: string | null;
} | undefined>;
readonly defaultValue: import("@angular/core").InputSignal<{
start: string | null;
end: string | null;
} | undefined>;
readonly defaultOpen: import("@angular/core").InputSignal<boolean>;
readonly today: import("@angular/core").InputSignal<string | 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<unknown>;
readonly store: DateRangePickerStore;
private readonly host;
private readonly parts;
private contentElement?;
private last;
constructor();
private applyParts;
private ensureGrid;
private apply;
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDateRangePickerRoot, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<GrDateRangePickerRoot, "gr-date-range-picker-root", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "today": { "alias": "today"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "dayLabel": { "alias": "dayLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; }, 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<{ start: string | null; end: string | null; } | undefined>
required
ensureGrid
property
any
required
host
property
any
required
last
property
any
required
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrDateRangePickerRoot, "gr-date-range-picker-root", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "today": { "alias": "today"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "dayLabel": { "alias": "dayLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; }, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDateRangePickerRoot, never>
required
parts
property
any
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<{ start: string | null; end: 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
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrDateRangePickerRoot, "gr-date-range-picker-root", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "today": { "alias": "today"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "dayLabel": { "alias": "dayLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; }, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDateRangePickerRoot, never>
Requirement
required
Name
parts
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
DateRangePickerStore
Requirement
required
Name
today
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
value
Kind
property
Type
import("@angular/core").InputSignal<{ start: string | null; end: string | null; } | undefined>
Requirement
required
Name
valueChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<unknown>
Requirement
required
DeclarationView source
GrDateRangePickerRootProviderts
export declare class GrDateRangePickerRootProvider implements OnDestroy {
private readonly store;
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrDateRangePickerRootProvider, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<GrDateRangePickerRootProvider, "gr-date-range-picker-root-provider", never, {}, {}, never, ["*"], true, never>;
}
Name
Kind
Type
Requirement
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrDateRangePickerRootProvider, "gr-date-range-picker-root-provider", never, {}, {}, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrDateRangePickerRootProvider, never>
required
store
property
any
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrDateRangePickerRootProvider, "gr-date-range-picker-root-provider", never, {}, {}, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrDateRangePickerRootProvider, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

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

Svelte adapter

2 exports
View source packages/ui-headless/svelte/src/date-range-picker/index.ts
DeclarationView source
createDateRangePickerts
export declare function createDateRangePicker(input: () => DateRangePickerInput, options?: UseDateRangePickerOptions): UseDateRangePickerResult;
Name
Kind
Type
Requirement
input
parameter
() => DateRangePickerInput
required
options
parameter
UseDateRangePickerOptions
optional
return
return value
UseDateRangePickerResult
n/a
Name
input
Kind
parameter
Type
() => DateRangePickerInput
Requirement
required
Name
options
Kind
parameter
Type
UseDateRangePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDateRangePickerResult
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-range-picker

Solid adapter

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

Root

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

RootProvider

function
DeclarationView source
RootProviderts
export declare function RootProvider(props: {
value: UseDateRangePickerResult;
} & JSX.HTMLAttributes<HTMLDivElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ value: UseDateRangePickerResult; } & JSX.HTMLAttributes<HTMLDivElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ value: UseDateRangePickerResult; } & JSX.HTMLAttributes<HTMLDivElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
useDateRangePickerts
export declare function useDateRangePicker(input: Accessor<DateRangePickerInput>, options?: DateRangePickerOptions): UseDateRangePickerResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<DateRangePickerInput>
required
options
parameter
DateRangePickerOptions
optional
return
return value
UseDateRangePickerResult
n/a
Name
input
Kind
parameter
Type
Accessor<DateRangePickerInput>
Requirement
required
Name
options
Kind
parameter
Type
DateRangePickerOptions
Requirement
optional
Name
return
Kind
return value
Type
UseDateRangePickerResult
Requirement
n/a
DeclarationView source
useDateRangePickerContextts
export declare function useDateRangePickerContext(part: string): UseDateRangePickerResult;
Name
Kind
Type
Requirement
part
parameter
string
required
return
return value
UseDateRangePickerResult
n/a
Name
part
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
UseDateRangePickerResult
Requirement
n/a
DeclarationView source
UseDateRangePickerResultts
export interface UseDateRangePickerResult {
readonly service: DateRangePickerService;
readonly connector: DateRangePickerApi;
readonly scope: PartScope;
readonly snapshot: Accessor<DateRangePickerSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
DateRangePickerApi
required
scope
property
PartScope
required
service
property
DateRangePickerService
required
snapshot
property
Accessor<DateRangePickerSnapshot>
required
Name
connector
Kind
property
Type
DateRangePickerApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
DateRangePickerService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<DateRangePickerSnapshot>
Requirement
required