You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
114 lines
3.0 KiB
114 lines
3.0 KiB
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
* @flow strict-local
|
|
*/
|
|
|
|
// This is a controlled component version of RCTDatePickerIOS.
|
|
|
|
import type {SyntheticEvent} from '../../Types/CoreEventTypes';
|
|
import type {ViewProps} from '../View/ViewPropTypes';
|
|
|
|
import * as React from 'react';
|
|
|
|
type Event = SyntheticEvent<
|
|
$ReadOnly<{|
|
|
timestamp: number,
|
|
|}>,
|
|
>;
|
|
|
|
type Props = $ReadOnly<{|
|
|
...ViewProps,
|
|
|
|
/**
|
|
* The currently selected date.
|
|
*/
|
|
date?: ?Date,
|
|
|
|
/**
|
|
* Provides an initial value that will change when the user starts selecting
|
|
* a date. It is useful for simple use-cases where you do not want to deal
|
|
* with listening to events and updating the date prop to keep the
|
|
* controlled state in sync. The controlled state has known bugs which
|
|
* causes it to go out of sync with native. The initialDate prop is intended
|
|
* to allow you to have native be source of truth.
|
|
*/
|
|
initialDate?: ?Date,
|
|
|
|
/**
|
|
* The date picker locale.
|
|
*/
|
|
locale?: ?string,
|
|
|
|
/**
|
|
* Maximum date.
|
|
*
|
|
* Restricts the range of possible date/time values.
|
|
*/
|
|
maximumDate?: ?Date,
|
|
|
|
/**
|
|
* Minimum date.
|
|
*
|
|
* Restricts the range of possible date/time values.
|
|
*/
|
|
minimumDate?: ?Date,
|
|
|
|
/**
|
|
* The interval at which minutes can be selected.
|
|
*/
|
|
minuteInterval?: ?(1 | 2 | 3 | 4 | 5 | 6 | 10 | 12 | 15 | 20 | 30),
|
|
|
|
/**
|
|
* The date picker mode.
|
|
*/
|
|
mode?: ?('date' | 'time' | 'datetime'),
|
|
|
|
/**
|
|
* Date change handler.
|
|
*
|
|
* This is called when the user changes the date or time in the UI.
|
|
* The first and only argument is an Event. For getting the date the picker
|
|
* was changed to, use onDateChange instead.
|
|
*/
|
|
onChange?: ?(event: Event) => void,
|
|
|
|
/**
|
|
* Date change handler.
|
|
*
|
|
* This is called when the user changes the date or time in the UI.
|
|
* The first and only argument is a Date object representing the new
|
|
* date and time.
|
|
*/
|
|
onDateChange: (date: Date) => void,
|
|
|
|
/**
|
|
* Timezone offset in minutes.
|
|
*
|
|
* By default, the date picker will use the device's timezone. With this
|
|
* parameter, it is possible to force a certain timezone offset. For
|
|
* instance, to show times in Pacific Standard Time, pass -7 * 60.
|
|
*/
|
|
timeZoneOffsetInMinutes?: ?number,
|
|
|
|
/**
|
|
* The date picker style
|
|
* This is only available on devices with iOS 14.0 and later.
|
|
* 'spinner' is the default style if this prop isn't set.
|
|
*/
|
|
pickerStyle?: ?('compact' | 'spinner' | 'inline'),
|
|
|}>;
|
|
|
|
/**
|
|
* Use `DatePickerIOS` to render a date/time picker (selector) on iOS. This is
|
|
* a controlled component, so you must hook in to the `onDateChange` callback
|
|
* and update the `date` prop in order for the component to update, otherwise
|
|
* the user's change will be reverted immediately to reflect `props.date` as the
|
|
* source of truth.
|
|
*/
|
|
export type DatePickerIOSType = React.ComponentType<Props>;
|