mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Nick Gerleman
5d26ceaa23
Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/35169 This reorganizes typing structure a bit. `Utilities.d.ts` was originally added for utilitiy types but I ended up leaving it a grab bag of types that didn't belong to any individual bit of code. Out of what is in it right now, `Insets` was actually public, and seems to have been imported. We also run into files around the renderer which are [currently overwritten](https://github.com/facebook/react-native/commits/e286da25fc83324363486eb668806aca179f74b3/Libraries/Renderer/implementations/ReactNativeRenderer.d.ts) by the React sync script. Finally, all of the top-level imports of `Utilities` were auto-generated by VS Code, but fail in real apps. I think this is because our tsconfig sets a `baseUrl` to allow resolution from the types folder, so the tooling in the RN repo will use that, but it breaks in real apps that don't have that mapping. This splits all these up into a couple separate directories that are hopefully easier to reason about, and removes `Omit` which has been a builtin type for quite some time (we were actually already using built-in `Omit`). Changelog: [General][Fixed] - Fixup TS Organization Reviewed By: cipolleschi Differential Revision: D40932319 fbshipit-source-id: 0b6e3e3eda603885b4dc01dcb9f5233aa546d128
93 lines
2.9 KiB
TypeScript
93 lines
2.9 KiB
TypeScript
/**
|
|
* 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
|
|
*/
|
|
|
|
import type * as React from 'react';
|
|
import {Constructor} from '../../../types/private/Utilities';
|
|
import {NativeMethods} from '../../../types/public/ReactNativeTypes';
|
|
import {ViewProps} from '../View/ViewPropTypes';
|
|
|
|
export interface DatePickerIOSProps extends ViewProps {
|
|
/**
|
|
* The currently selected date.
|
|
*/
|
|
date?: Date | null | undefined;
|
|
|
|
/**
|
|
* 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 | null | undefined;
|
|
|
|
/**
|
|
* The date picker locale.
|
|
*/
|
|
locale?: string | undefined;
|
|
|
|
/**
|
|
* Maximum date.
|
|
* Restricts the range of possible date/time values.
|
|
*/
|
|
maximumDate?: Date | undefined;
|
|
|
|
/**
|
|
* Maximum date.
|
|
* Restricts the range of possible date/time values.
|
|
*/
|
|
minimumDate?: Date | undefined;
|
|
|
|
/**
|
|
* enum(1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30)
|
|
* The interval at which minutes can be selected.
|
|
*/
|
|
minuteInterval?: 1 | 2 | 3 | 4 | 5 | 6 | 10 | 12 | 15 | 20 | 30 | undefined;
|
|
|
|
/**
|
|
* enum('date', 'time', 'datetime')
|
|
* The date picker mode.
|
|
*/
|
|
mode?: 'date' | 'time' | 'datetime' | undefined;
|
|
|
|
/**
|
|
* 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: (newDate: 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 | undefined;
|
|
|
|
/**
|
|
* 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' | undefined;
|
|
}
|
|
|
|
declare class DatePickerIOSComponent extends React.Component<DatePickerIOSProps> {}
|
|
declare const DatePickerIOSBase: Constructor<NativeMethods> &
|
|
typeof DatePickerIOSComponent;
|
|
|
|
/**
|
|
* DatePickerIOS has been merged with DatePickerAndroid and will be removed in a future release.
|
|
* It can now be installed and imported from `@react-native-community/datetimepicker` instead of 'react-native'.
|
|
* @see https://github.com/react-native-community/datetimepicker
|
|
* @deprecated
|
|
*/
|
|
export class DatePickerIOS extends DatePickerIOSBase {}
|