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
1.8 KiB
TypeScript
80 lines
1.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 {ColorValue} from '../StyleSheet/StyleSheet';
|
|
|
|
export type ShareContent =
|
|
| {
|
|
title?: string | undefined;
|
|
message: string;
|
|
}
|
|
| {
|
|
title?: string | undefined;
|
|
url: string;
|
|
};
|
|
|
|
export type ShareOptions = {
|
|
dialogTitle?: string | undefined;
|
|
excludedActivityTypes?: Array<string> | undefined;
|
|
tintColor?: ColorValue | undefined;
|
|
subject?: string | undefined;
|
|
};
|
|
|
|
export type ShareSharedAction = {
|
|
action: 'sharedAction';
|
|
activityType?: string | undefined;
|
|
};
|
|
|
|
export type ShareDismissedAction = {
|
|
action: 'dismissedAction';
|
|
};
|
|
|
|
export type ShareAction = ShareSharedAction | ShareDismissedAction;
|
|
|
|
export interface ShareStatic {
|
|
/**
|
|
* Open a dialog to share text content.
|
|
*
|
|
* In iOS, Returns a Promise which will be invoked an object containing `action`, `activityType`.
|
|
* If the user dismissed the dialog, the Promise will still be resolved with action being `Share.dismissedAction`
|
|
* and all the other keys being undefined.
|
|
*
|
|
* In Android, Returns a Promise which always be resolved with action being `Share.sharedAction`.
|
|
*
|
|
* ### Content
|
|
*
|
|
* - `message` - a message to share
|
|
* - `title` - title of the message
|
|
*
|
|
* #### iOS
|
|
*
|
|
* - `url` - an URL to share
|
|
*
|
|
* At least one of URL and message is required.
|
|
*
|
|
* ### Options
|
|
*
|
|
* #### iOS
|
|
*
|
|
* - `excludedActivityTypes`
|
|
* - `tintColor`
|
|
*
|
|
* #### Android
|
|
*
|
|
* - `dialogTitle`
|
|
*
|
|
*/
|
|
share(content: ShareContent, options?: ShareOptions): Promise<ShareAction>;
|
|
sharedAction: 'sharedAction';
|
|
dismissedAction: 'dismissedAction';
|
|
}
|
|
|
|
export const Share: ShareStatic;
|
|
export type Share = ShareStatic;
|