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.5 KiB
TypeScript
80 lines
2.5 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 {EmitterSubscription} from '../vendor/emitter/EventEmitter';
|
|
|
|
// Used by Dimensions below
|
|
export interface ScaledSize {
|
|
width: number;
|
|
height: number;
|
|
scale: number;
|
|
fontScale: number;
|
|
}
|
|
|
|
/**
|
|
* Initial dimensions are set before `runApplication` is called so they should
|
|
* be available before any other require's are run, but may be updated later.
|
|
*
|
|
* Note: Although dimensions are available immediately, they may change (e.g
|
|
* due to device rotation) so any rendering logic or styles that depend on
|
|
* these constants should try to call this function on every render, rather
|
|
* than caching the value (for example, using inline styles rather than
|
|
* setting a value in a `StyleSheet`).
|
|
*
|
|
* Example: `const {height, width} = Dimensions.get('window');`
|
|
*
|
|
* @param dim Name of dimension as defined when calling `set`.
|
|
* @returns Value for the dimension.
|
|
* @see https://reactnative.dev/docs/dimensions#content
|
|
*/
|
|
export interface Dimensions {
|
|
/**
|
|
* Initial dimensions are set before runApplication is called so they
|
|
* should be available before any other require's are run, but may be
|
|
* updated later.
|
|
* Note: Although dimensions are available immediately, they may
|
|
* change (e.g due to device rotation) so any rendering logic or
|
|
* styles that depend on these constants should try to call this
|
|
* function on every render, rather than caching the value (for
|
|
* example, using inline styles rather than setting a value in a
|
|
* StyleSheet).
|
|
* Example: const {height, width} = Dimensions.get('window');
|
|
@param dim Name of dimension as defined when calling set.
|
|
@returns Value for the dimension.
|
|
*/
|
|
get(dim: 'window' | 'screen'): ScaledSize;
|
|
|
|
/**
|
|
* This should only be called from native code by sending the didUpdateDimensions event.
|
|
* @param dims Simple string-keyed object of dimensions to set
|
|
*/
|
|
set(dims: {[key: string]: any}): void;
|
|
|
|
/**
|
|
* Add an event listener for dimension changes
|
|
*
|
|
* @param type the type of event to listen to
|
|
* @param handler the event handler
|
|
*/
|
|
addEventListener(
|
|
type: 'change',
|
|
handler: ({
|
|
window,
|
|
screen,
|
|
}: {
|
|
window: ScaledSize;
|
|
screen: ScaledSize;
|
|
}) => void,
|
|
): EmitterSubscription;
|
|
}
|
|
|
|
export function useWindowDimensions(): ScaledSize;
|
|
|
|
export const Dimensions: Dimensions;
|