@project44-manifest/react
Version:
Manifest Design System react components
69 lines • 2.18 kB
TypeScript
import * as React from 'react';
import type { DateValue } from '@react-types/calendar';
import type { AriaDatePickerProps } from '@react-types/datepicker';
import { As, Options, Props } from '../../system';
import type { StyleProps } from '../../types';
import { Placement } from '../Overlay';
export declare type DatePickerElement = 'div';
export interface DatePickerOptions<T extends As = DatePickerElement> extends Options<T>, AriaDatePickerProps<DateValue>, StyleProps {
/**
* The ref of the element to append the overlay to.
*/
containerRef?: React.RefObject<HTMLElement>;
/**
* Helper text to append to the form control input element.
*/
helperText?: React.ReactNode;
/**
* Props passed to the helper text.
*/
helperTextProps?: React.HTMLAttributes<HTMLElement>;
/**
* Label of the input element
*/
label?: React.ReactNode;
/**
* Props passed to the label.
*/
labelProps?: React.HTMLAttributes<HTMLElement>;
/**
* The additional offset applied along the main axis between the element and its
* anchor element.
*
* @default 4
*/
offset?: number;
/**
* The placement of the element with respect to its anchor element.
*
* @default 'bottom'
*/
placement?: Placement;
/**
* Temporary text that occupies the text input when it is empty.
*/
placeholder?: string;
/**
* Whether the element should flip its orientation (e.g. top to bottom or left to right) when
* there is insufficient room for it to render completely.
*
* @default true
*/
shouldFlip?: boolean;
/**
* The size of the combobox
*
* @default 'medium'
*/
size?: 'medium' | 'small';
/**
* Icon displayed at the start of the text field.
*
* @example
* <Combobox startIcon={<Icon />} />
*/
startIcon?: React.ReactElement;
}
export declare type DatePickerProps<T extends As = DatePickerElement> = Props<DatePickerOptions<T>>;
export declare const DatePicker: import("../../system").Component<DatePickerOptions<"div">>;
//# sourceMappingURL=DatePicker.d.ts.map