ph-material-pickers
Version:
React components, that implements material design pickers for material-ui v4
71 lines (70 loc) • 2.09 kB
TypeScript
import { PickerOnChangeFn } from '../../_shared/hooks/useViews';
import { ExportedArrowSwitcherProps } from '../../_shared/ArrowSwitcher';
import { TimeValidationProps } from '../../_helpers/time-utils';
export interface ExportedClockViewProps<TDate> extends TimeValidationProps<TDate> {
/**
* 12h/24h view for hour selection clock.
*
* @default true
*/
ampm?: boolean;
/**
* Step over minutes.
*
* @default 1
*/
minutesStep?: number;
/**
* Display ampm controls under the clock (instead of in the toolbar).
*
* @default false
*/
ampmInClock?: boolean;
/**
* Enables keyboard listener for moving between days in calendar.
*
* @default currentWrapper !== 'static'
*/
allowKeyboardControl?: boolean;
}
export interface ClockViewProps<TDate> extends ExportedClockViewProps<TDate>, ExportedArrowSwitcherProps {
/**
* Selected date @DateIOType.
*/
date: TDate | null;
/**
* Clock type.
*/
type: 'hours' | 'minutes' | 'seconds';
/**
* On change date without moving between views @DateIOType.
*/
onDateChange: PickerOnChangeFn<TDate>;
/**
* On change callback @DateIOType.
*/
onChange: PickerOnChangeFn<TDate>;
/**
* Get clock number aria-text for hours.
*/
getHoursClockNumberText?: (hoursText: string) => string;
/**
* Get clock number aria-text for minutes.
*/
getMinutesClockNumberText?: (minutesText: string) => string;
/**
* Get clock number aria-text for seconds.
*/
getSecondsClockNumberText?: (secondsText: string) => string;
openNextView: () => void;
openPreviousView: () => void;
nextViewAvailable: boolean;
previousViewAvailable: boolean;
showViewSwitcher?: boolean;
}
export declare const useStyles: (props?: any) => Record<"arrowSwitcher", string>;
export declare function ClockView<TDate>(props: ClockViewProps<TDate>): JSX.Element;
export declare namespace ClockView {
var propTypes: any;
var displayName: string;
}