@salt-ds/lab 1.0.0-alpha.89 → 1.0.0-alpha.90

package/dist-types/date-picker/useDatePicker.d.ts

@@ -1,119 +0,0 @@
-import type { DateFrameworkType, Timezone } from "@salt-ds/date-adapters";
-import { type SyntheticEvent } from "react";
-import type { DateRangeSelection, SingleDateSelection } from "../calendar";
-import type { DateInputRangeDetails, DateInputSingleDetails } from "../date-input";
-import type { RangeDatePickerState, SingleDatePickerState } from "./DatePickerContext";
-interface UseDatePickerBaseProps<TDate> {
-    /** If `true`, the component is disabled. */
-    disabled?: boolean;
-    /**
-     * Function to determine if a day is highlighted.
-     * @param date - The date to check.
-     * @returns A string reason if the day is highlighted, otherwise `false` or `undefined`.
-     */
-    isDayHighlighted?: (date: TDate) => string | false | undefined;
-    /**
-     * Function to determine if a day is unselectable.
-     * @param date - The date to check.
-     * @returns A string reason if the day is unselectable, otherwise `false` or `undefined`.
-     */
-    isDayUnselectable?: (date: TDate) => string | false | undefined;
-    /** If `true`, the component is read-only. */
-    readOnly?: boolean;
-    /**
-     * The minimum date for the range, default is 1900.
-     */
-    minDate?: TDate;
-    /**
-     * The maximum date for the range, default is 2100.
-     */
-    maxDate?: TDate;
-    /**
-     * Handler for when the date selection is cancelled.
-     */
-    onCancel?: () => void;
-    /**
-     * Timezone, if un-defined will take the timezone from passed date (or defaultSelectedDate/selectedDate)
-     * Can also be set to "default" to use the default timezone of the date library
-     * Can also be set to "system" to take the timezone of the local system.
-     */
-    timezone?: Timezone;
-}
-/**
- * Props for single date selection.
- * @template TDate - The type of the date object.
- */
-export interface UseDatePickerSingleProps<TDate extends DateFrameworkType> extends UseDatePickerBaseProps<TDate> {
-    /**
-     * Single date selection.
-     */
-    selectionVariant: "single";
-    /**
-     * The selected date. The selected date will be controlled when this prop is provided.
-     */
-    selectedDate?: SingleDateSelection<TDate> | null;
-    /**
-     * The initial selected date, when the selected date is uncontrolled.
-     */
-    defaultSelectedDate?: SingleDateSelection<TDate> | null;
-    /**
-     * Handler called when the selected date changes.
-     * @param event - The synthetic event.
-     * @param date - The selected date or null.
-     * @param details - The selected date details.
-     */
-    onSelectionChange?: (event: SyntheticEvent, date: SingleDateSelection<TDate> | null, details?: DateInputSingleDetails) => void;
-    /**
-     * Handler called when the selected date is confirmed/applied.
-     * @param event - The synthetic event.
-     * @param date - The selected date or null.
-     */
-    onApply?: (event: SyntheticEvent, date: SingleDateSelection<TDate> | null) => void;
-}
-/**
- * Props for date range selection.
- * @template TDate - The type of the date object.
- */
-export interface UseDatePickerRangeProps<TDate extends DateFrameworkType> extends UseDatePickerBaseProps<TDate> {
-    /**
-     * Date range selection.
-     */
-    selectionVariant: "range";
-    /**
-     * The selected date range. The selected date will be controlled when this prop is provided.
-     */
-    selectedDate?: DateRangeSelection<TDate> | null;
-    /**
-     * The initial selected date range, when the selected date is uncontrolled.
-     */
-    defaultSelectedDate?: DateRangeSelection<TDate> | null;
-    /**
-     * Handler called when the selected date range changes.
-     * @param event - The synthetic event.
-     * @param date - The selected date range or null.
-     * @param details - The selected date range details.
-     */
-    onSelectionChange?: (event: SyntheticEvent, date: DateRangeSelection<TDate> | null, details?: DateInputRangeDetails) => void;
-    /**
-     * Handler called when the selected date range is confirmed/applied.
-     * @param event - The synthetic event.
-     * @param date - The selected date range.
-     */
-    onApply?: (event: SyntheticEvent, date: DateRangeSelection<TDate> | null) => void;
-}
-/**
- * Props for the useDatePicker hook.
- * @template TDate - The type of the date object.
- * @template SelectionVariant - The selection variant, either "single" or "range".
- */
-export type UseDatePickerProps<TDate extends DateFrameworkType, SelectionVariant> = SelectionVariant extends "single" ? UseDatePickerSingleProps<TDate> : SelectionVariant extends "range" ? UseDatePickerRangeProps<TDate> : never;
-/**
- * Custom hook for managing date picker state.
- * @template TDate - The type of the date object.
- * @template SelectionVariant - The selection variant, either "single" or "range".
- * @param props - The props for the date picker.
- * @param ref - The ref for the date picker container.
- * @returns The date picker state and helpers.
- */
-export declare function useDatePicker<TDate extends DateFrameworkType, SelectionVariant extends "single" | "range">(props: UseDatePickerProps<TDate, SelectionVariant>, ref: React.ForwardedRef<HTMLDivElement>): SingleDatePickerState<TDate> | RangeDatePickerState<TDate>;
-export {};

package/dist-types/date-picker/useFocusOut.d.ts

@@ -1,9 +0,0 @@
-import type { ElementProps, FloatingContext } from "@floating-ui/react";
-export interface UseFocusOutProps {
-    /**
-     * Whether the hook is enabled
-     * @default true
-     */
-    enabled?: boolean;
-}
-export declare function useFocusOut(context: FloatingContext, props: UseFocusOutProps): ElementProps;

package/dist-types/date-picker/useKeyboard.d.ts

@@ -1,20 +0,0 @@
-import type { ElementProps, FloatingContext } from "@floating-ui/react";
-import { type KeyboardEvent } from "react";
-export interface UseKeyboardProps {
-    /**
-     * Whether the hook is enabled
-     * @default true
-     */
-    enabled?: boolean;
-    /**
-     * Handler for when the arrow key down is pressed
-     * @param event
-     */
-    onArrowDown?: (event: KeyboardEvent) => void;
-}
-/**
- * Floating UI Interactions hook, that will open DatePicker on keydown
- * @param context
- * @param props
- */
-export declare function useKeyboard(_context: FloatingContext, props: UseKeyboardProps): ElementProps;

package/dist-types/localization-provider/LocalizationProvider.d.ts

@@ -1,62 +0,0 @@
-import type { DateFrameworkType, SaltDateAdapter } from "@salt-ds/date-adapters";
-export interface LocalizationProviderValue<TDate extends DateFrameworkType> {
-    defaultDates: {
-        minDate: TDate;
-        maxDate: TDate;
-    };
-    dateAdapter: SaltDateAdapter<TDate>;
-}
-/**
- * Props for the LocalizationProvider component.
- *
- * @template TDate - The type of the date object used in the provider.
- * @template TLocale - The type of the locale, defaulting to string.
- */
-export interface LocalizationProviderProps<TDate extends DateFrameworkType, TLocale = string> {
-    /**
-     * The child components to be rendered within the provider.
-     */
-    children?: React.ReactNode;
-    /**
-     * The instance of the date library being used.
-     */
-    instance?: any;
-    /**
-     * The date adapter class, which provides methods for date manipulation and formatting.
-     * This should be a constructor for a class implementing the SaltDateAdapter interface.
-     */
-    DateAdapter: new (...args: any) => SaltDateAdapter<TDate, TLocale>;
-    /**
-     * The locale to be used for date formatting and manipulation.
-     */
-    locale?: TLocale;
-    /**
-     * The minimum date allowed for all date selections.
-     * Defaults to January 1, 1900.
-     */
-    minDate?: TDate;
-    /**
-     * The maximum date allowed for all date selections.
-     * Defaults to December 31, 2099.
-     */
-    maxDate?: TDate;
-}
-export type LocalizationProviderContext<TDate extends DateFrameworkType> = {
-    [K in keyof LocalizationProviderValue<TDate>]: LocalizationProviderValue<TDate>[K] | null;
-};
-export declare const LocalizationProviderContext: import("react").Context<LocalizationProviderValue<any> | null>;
-export declare const LocalizationProvider: <TDate extends DateFrameworkType, TLocale>(props: LocalizationProviderProps<TDate, TLocale>) => import("react/jsx-runtime").JSX.Element;
-/**
- * Custom hook to access the localization context.
- *
- * This hook provides access to the localization settings and utilities
- * within the `LocalizationProviderContext`. It should be used within a
- * component that is a descendant of `LocalizationProviderContext.Provider`.
- *
- * @template TDate - The type of the date object used in the localization context.
- *
- * @returns The localization provider value, which includes date manipulation and formatting utilities.
- *
- * @throws Will throw an error if the hook is used outside of a `LocalizationProviderContext.Provider`.
- */
-export declare const useLocalization: <TDate extends DateFrameworkType>() => LocalizationProviderValue<TDate>;