Skip to content

Update Dimensions API types #5252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Abbondanzo wants to merge 1 commit into from
+19 −9
Open

Update Dimensions API types #5252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions docs/dimensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,20 +104,20 @@ static addEventListener(
handler: ({
window,
screen,
}: DimensionsValue) => void,
}: DimensionsPayload) => void,
): EventSubscription;
```

Add an event handler. Supported events:

- `change`: Fires when a property within the `Dimensions` object changes. The argument to the event handler is a [`DimensionsValue`](#dimensionsvalue) type object.
- `change`: Fires when a property within the `Dimensions` object changes. The argument to the event handler is a [`DimensionsPayload`](#dimensionspayload) object.

---

### `get()`

```tsx
static get(dim: 'window' | 'screen'): ScaledSize;
static get(dim: string): DisplayMetrics | DisplayMetricsAndroid;
```

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.
Expand All @@ -136,16 +136,18 @@ For Android the `window` dimension will be reduced by the size of status bar (if

## Type Definitions

### DimensionsValue
### DimensionsPayload

**Properties:**

| Name | Type | Description |
| ------ | ----------------------------------- | --------------------------------------- |
| window | [ScaledSize](dimensions#scaledsize) | Size of the visible Application window. |
| screen | [ScaledSize](dimensions#scaledsize) | Size of the device's screen. |
| Name | Type | Description |
| -------------------- | --------------------------------------------------------- | --------------------------------------- |
| window | [DisplayMetrics](dimensions#displaymetrics) | Size of the visible application window. |
| screen | [DisplayMetrics](dimensions#displaymetrics) | Size of the device's screen. |
| windowPhysicalPixels | [DisplayMetricsAndroid](dimensions#displaymetricsandroid) | Physical pixels for the Android window. |
| screenPhysicalPixels | [DisplayMetricsAndroid](dimensions#displaymetricsandroid) | Physical pixels for the Android screen. |

### ScaledSize
### DisplayMetrics

| Type |
| ------ |
Expand All @@ -159,3 +161,11 @@ For Android the `window` dimension will be reduced by the size of status bar (if
| height | number |
| scale | number |
| fontScale | number |

### DisplayMetricsAndroid

`DisplayMetricsAndroid` includes all [`DisplayMetrics`](dimensions#displaymetrics) properties and the following property:

| Name | Type |
| ---------- | ------ |
| densityDpi | number |
Loading