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
65 lines
2.0 KiB
TypeScript
65 lines
2.0 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
|
|
*/
|
|
|
|
export interface PixelRatioStatic {
|
|
/*
|
|
Returns the device pixel density. Some examples:
|
|
PixelRatio.get() === 1
|
|
mdpi Android devices (160 dpi)
|
|
PixelRatio.get() === 1.5
|
|
hdpi Android devices (240 dpi)
|
|
PixelRatio.get() === 2
|
|
iPhone 4, 4S
|
|
iPhone 5, 5c, 5s
|
|
iPhone 6
|
|
xhdpi Android devices (320 dpi)
|
|
PixelRatio.get() === 3
|
|
iPhone 6 plus
|
|
xxhdpi Android devices (480 dpi)
|
|
PixelRatio.get() === 3.5
|
|
Nexus 6
|
|
*/
|
|
get(): number;
|
|
|
|
/*
|
|
Returns the scaling factor for font sizes. This is the ratio that is
|
|
used to calculate the absolute font size, so any elements that
|
|
heavily depend on that should use this to do calculations.
|
|
|
|
If a font scale is not set, this returns the device pixel ratio.
|
|
|
|
Currently this is only implemented on Android and reflects the user
|
|
preference set in Settings > Display > Font size,
|
|
on iOS it will always return the default pixel ratio.
|
|
*/
|
|
getFontScale(): number;
|
|
|
|
/**
|
|
* Converts a layout size (dp) to pixel size (px).
|
|
* Guaranteed to return an integer number.
|
|
*/
|
|
getPixelSizeForLayoutSize(layoutSize: number): number;
|
|
|
|
/**
|
|
* Rounds a layout size (dp) to the nearest layout size that
|
|
* corresponds to an integer number of pixels. For example,
|
|
* on a device with a PixelRatio of 3,
|
|
* PixelRatio.roundToNearestPixel(8.4) = 8.33,
|
|
* which corresponds to exactly (8.33 * 3) = 25 pixels.
|
|
*/
|
|
roundToNearestPixel(layoutSize: number): number;
|
|
|
|
/**
|
|
* No-op for iOS, but used on the web. Should not be documented. [sic]
|
|
*/
|
|
startDetecting(): void;
|
|
}
|
|
|
|
export const PixelRatio: PixelRatioStatic;
|