@neo4j-ndl/react/lib/types/timezone-picker/TimeZonePicker.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 CommonProps } from '../_common/types';
export type TimeZonePickerProps = {
    /** The value of the timezone picker (IANA timezone identifier) */
    value?: string;
    /** Whether the timezone picker is fluid */
    isFluid?: boolean;
    /** Whether the timezone picker is read only */
    isReadOnly?: boolean;
    /** Whether the timezone picker is required */
    isRequired?: boolean;
    /** Whether the timezone picker is disabled */
    isDisabled?: boolean;
    /** The label of the timezone picker */
    label?: string;
    /** The size of the timezone picker */
    size?: 'small' | 'medium' | 'large';
    /** Manually set the error text */
    errorText?: string;
    /** Callback function triggered when the timezone picker value changes */
    onChange?: (timezone: string) => void;
    /** Callback function triggered when the timezone picker encounters an error */
    onError?: (error: string, timezone: string) => 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;
    /** Reference date for calculating timezone offsets (useful for DST-aware offset display) */
    referenceDate?: Date;
    /**
     * Display mode: 'city', 'utc', or 'both'
     * 'city' - shows city-based timezones, This should be used when the user needs to select a timezone for themselves or if they are selecting a timezone that's related to a date.
     * 'utc' - shows UTC timezones, This should be used when the user needs to select a timezone for a database entry or a technical application.
     * 'both' - shows both city-based and UTC timezones in separate sections, This should be used when the user needs to select a timezone for a database entry or a technical application, but also wants to see the city-based timezones for context for example a zoned date time.
     * @default 'city'
     * @example
     * <TimeZonePicker mode="city" />
     * <TimeZonePicker mode="utc" />
     * <TimeZonePicker mode="both" />
     */
    mode?: 'city' | 'utc' | 'both';
};
export declare const TimeZonePicker: ({ isDisabled, isFluid, isReadOnly, isRequired, value, label, onChange, className, onError, style, size, errorText, htmlAttributes, floatingStrategy, isPortaled: isPortaledProp, referenceDate, mode, ref, ...restProps }: CommonProps<"input", TimeZonePickerProps>) => import("react/jsx-runtime").JSX.Element;
//# sourceMappingURL=TimeZonePicker.d.ts.map