mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Nick Gerleman
8cdc9e7f04
Summary: React Native's TS definitions are currently mostly stored in one monolithic file. This change splits the definitions up to correspond to the source files they came from, and are placed next to the source files. I think this should help inform, and make it easy to update the TS declarations when touching the Flow file. I noticed as part of the change that the typings have not yet removed many APIs that were removed from RN. This is bad, since it means using the removed/non-functional API doesn't cause typechecker errors. Locating typings next to source should prevent that from being able to happen. The organization here means individual TS declarations can declare what will be in the RN entrypoint, which is a little confusing. Seems like a good potential next refactor, beyond the literal translation I did. Changelog: [General][Changed] - Place TS Declarations Alongside Source Files Reviewed By: lunaleaps, rshest Differential Revision: D39796598 fbshipit-source-id: b36366466fd1976bdd2d4c8f7a4104a33c457a07
80 lines
2.8 KiB
TypeScript
80 lines
2.8 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 {ProcessedColorValue} from '../StyleSheet/processColor';
|
|
import {ColorValue} from '../StyleSheet/StyleSheet';
|
|
|
|
/**
|
|
* @see: https://reactnative.dev/docs/actionsheetios#content
|
|
*/
|
|
export interface ActionSheetIOSOptions {
|
|
title?: string | undefined;
|
|
options: string[];
|
|
cancelButtonIndex?: number | undefined;
|
|
destructiveButtonIndex?: number | number[] | undefined | null;
|
|
message?: string | undefined;
|
|
anchor?: number | undefined;
|
|
tintColor?: ColorValue | ProcessedColorValue | undefined;
|
|
cancelButtonTintColor?: ColorValue | ProcessedColorValue | undefined;
|
|
userInterfaceStyle?: 'light' | 'dark' | undefined;
|
|
disabledButtonIndices?: number[] | undefined;
|
|
}
|
|
|
|
export interface ShareActionSheetIOSOptions {
|
|
message?: string | undefined;
|
|
url?: string | undefined;
|
|
subject?: string | undefined;
|
|
/** The activities to exclude from the ActionSheet.
|
|
* For example: ['com.apple.UIKit.activity.PostToTwitter']
|
|
*/
|
|
excludedActivityTypes?: string[] | undefined;
|
|
}
|
|
|
|
/**
|
|
* @see https://reactnative.dev/docs/actionsheetios#content
|
|
*/
|
|
export interface ActionSheetIOSStatic {
|
|
/**
|
|
* Display an iOS action sheet. The `options` object must contain one or more
|
|
* of:
|
|
* - `options` (array of strings) - a list of button titles (required)
|
|
* - `cancelButtonIndex` (int) - index of cancel button in `options`
|
|
* - `destructiveButtonIndex` (int) - index of destructive button in `options`
|
|
* - `title` (string) - a title to show above the action sheet
|
|
* - `message` (string) - a message to show below the title
|
|
*/
|
|
showActionSheetWithOptions: (
|
|
options: ActionSheetIOSOptions,
|
|
callback: (buttonIndex: number) => void,
|
|
) => void;
|
|
|
|
/**
|
|
* Display the iOS share sheet. The `options` object should contain
|
|
* one or both of `message` and `url` and can additionally have
|
|
* a `subject` or `excludedActivityTypes`:
|
|
*
|
|
* - `url` (string) - a URL to share
|
|
* - `message` (string) - a message to share
|
|
* - `subject` (string) - a subject for the message
|
|
* - `excludedActivityTypes` (array) - the activities to exclude from the ActionSheet
|
|
*
|
|
* NOTE: if `url` points to a local file, or is a base64-encoded
|
|
* uri, the file it points to will be loaded and shared directly.
|
|
* In this way, you can share images, videos, PDF files, etc.
|
|
*/
|
|
showShareActionSheetWithOptions: (
|
|
options: ShareActionSheetIOSOptions,
|
|
failureCallback: (error: Error) => void,
|
|
successCallback: (success: boolean, method: string) => void,
|
|
) => void;
|
|
}
|
|
|
|
export const ActionSheetIOS: ActionSheetIOSStatic;
|
|
export type ActionSheetIOS = ActionSheetIOSStatic;
|