@neo4j-ndl/react/lib/types/time-picker/TimePicker.d.ts

React implementation of Neo4j Design System

/**
 *
 *  Copyright (c) "Neo4j"
 *  Neo4j Sweden AB [http://neo4j.com]
 *
 *  This file is part of Neo4j.
 *
 *  Neo4j is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import type React from 'react';
import { type PolymorphicCommonProps } from '../_common/types';
import { NeedleTime } from './needle-time';
export type TimeFormat = 'hh:mm' | 'hh:mm aa';
export type TimePickerProps = {
    /** The value of the time picker */
    value?: NeedleTime;
    /** The format of the time picker */
    format?: TimeFormat;
    /** Whether the time picker is fluid */
    isFluid?: boolean;
    /** Whether the time picker is read only */
    isReadOnly?: boolean;
    /** Whether the time picker is required */
    isRequired?: boolean;
    /** Whether the time picker is disabled */
    isDisabled?: boolean;
    /** The time interval of the time picker, in minutes */
    timeInterval?: number;
    /** The label of the time picker */
    label?: string;
    /** The size of the time picker */
    size?: 'small' | 'medium' | 'large';
    /** Manually set the error text */
    errorText?: string;
    /** Callback function triggered when the time picker value changes */
    onChange?: (time: NeedleTime) => void;
    /** Callback function triggered when the time picker encounters an error */
    onError?: (error: string, time: NeedleTime) => void;
    /**
     * Strategy for the dropdown floating element.
     * By default it is absolute, but if the component is inside of a needle Dialog, it is set to fixed.
     * If this prop is set, no auto-detection of Dialog is done.
     */
    floatingStrategy?: 'absolute' | 'fixed';
    /** Whether the dropdown element is rendered in a portal. */
    isPortaled?: boolean;
};
export declare const TimePicker: <T extends React.ElementType = "div">({ format, isDisabled, isFluid, isReadOnly, isRequired, value, timeInterval, label, onChange, className, onError, style, size, errorText, htmlAttributes, floatingStrategy, isPortaled: isPortaledProp, ref, ...restProps }: PolymorphicCommonProps<T, TimePickerProps>) => import("react/jsx-runtime").JSX.Element;
//# sourceMappingURL=TimePicker.d.ts.map