@agregio-solutions/design-system 1.92.1 → 1.93.0

package/dist/packages/components/TimePicker/TimePicker.d.ts

@@ -0,0 +1,101 @@
+import { default as React } from 'react';
+import { Props as FormGroupWrapperProps } from '../../internal-components/FormGroupWrapper/FormGroupWrapper';
+export type TimeUnit = "hours" | "minutes" | "seconds";
+export type TimePickerValue = {
+    hours?: string;
+    minutes?: string;
+    seconds?: string;
+};
+export type Props = Omit<FormGroupWrapperProps, "children" | "description" | "className" | "style" | "characterCounter" | "htmlForId"> & {
+    /**
+     * The controlled value: an object with optional `hours`, `minutes`, `seconds` keys, each as a 2-digit padded
+     * string (e.g. `{ hours: "08", minutes: "34" }`). Use `null` for the initial empty state before any selection.
+     */
+    value: TimePickerValue | null;
+    /**
+     * Handler called every time a unit changes. Emits an object containing only the units that have a value.
+     */
+    onChange: (value: TimePickerValue) => void;
+    /**
+     * Units displayed and their visual order. Defaults to ["hours","minutes","seconds"].
+     */
+    units?: Array<TimeUnit>;
+    /**
+     * Step for the minutes options (1..30). Default 1.
+     */
+    minutesStep?: number;
+    /**
+     * Step for the seconds options (1..30). Default 1.
+     */
+    secondsStep?: number;
+    /**
+     * Whether the input is disabled.
+     */
+    isDisabled?: boolean;
+    /**
+     * Whether the input can be selected but not changed by the user.
+     * In read-only mode, the value is rendered as plain formatted text.
+     */
+    isReadOnly?: boolean;
+    /**
+     * Specifies the nature of the TimePicker (mainly to change the trigger border color and helperText color).
+     * If you do not pass a nature prop, the component will automatically set the nature based on the presence of success/error messages.
+     */
+    nature?: "default" | "negative" | "positive" | "warning";
+    /**
+     * Props to pass to the wrapper div (for example, style or className).
+     */
+    wrapperProps?: React.HTMLProps<HTMLDivElement>;
+    /**
+     * Accessible label used as a prefix for each Select trigger (e.g. "<aria-label> : Hours").
+     * Required when `label` is a ReactNode rather than a string.
+     */
+    "aria-label"?: string;
+};
+declare const TimePicker: React.ForwardRefExoticComponent<Omit<FormGroupWrapperProps, "className" | "style" | "children" | "description" | "htmlForId" | "characterCounter"> & {
+    /**
+     * The controlled value: an object with optional `hours`, `minutes`, `seconds` keys, each as a 2-digit padded
+     * string (e.g. `{ hours: "08", minutes: "34" }`). Use `null` for the initial empty state before any selection.
+     */
+    value: TimePickerValue | null;
+    /**
+     * Handler called every time a unit changes. Emits an object containing only the units that have a value.
+     */
+    onChange: (value: TimePickerValue) => void;
+    /**
+     * Units displayed and their visual order. Defaults to ["hours","minutes","seconds"].
+     */
+    units?: Array<TimeUnit>;
+    /**
+     * Step for the minutes options (1..30). Default 1.
+     */
+    minutesStep?: number;
+    /**
+     * Step for the seconds options (1..30). Default 1.
+     */
+    secondsStep?: number;
+    /**
+     * Whether the input is disabled.
+     */
+    isDisabled?: boolean;
+    /**
+     * Whether the input can be selected but not changed by the user.
+     * In read-only mode, the value is rendered as plain formatted text.
+     */
+    isReadOnly?: boolean;
+    /**
+     * Specifies the nature of the TimePicker (mainly to change the trigger border color and helperText color).
+     * If you do not pass a nature prop, the component will automatically set the nature based on the presence of success/error messages.
+     */
+    nature?: "default" | "negative" | "positive" | "warning";
+    /**
+     * Props to pass to the wrapper div (for example, style or className).
+     */
+    wrapperProps?: React.HTMLProps<HTMLDivElement>;
+    /**
+     * Accessible label used as a prefix for each Select trigger (e.g. "<aria-label> : Hours").
+     * Required when `label` is a ReactNode rather than a string.
+     */
+    "aria-label"?: string;
+} & React.RefAttributes<HTMLDivElement>>;
+export default TimePicker;