kylefang/react-native
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-native.git synced 2026-04-24 04:16:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Additional markdown adjustments

Browse Source 
Summary:
Follow up to 9ec9567390
Closes https://github.com/facebook/react-native/pull/16759

Differential Revision: D6285219

Pulled By: hramos

fbshipit-source-id: 7012d257a5a6cff06cb2d94203a9379e4b7e3c4e
This commit is contained in:
Héctor Ramos
2017-11-09 09:47:50 -08:00
committed by Facebook Github Bot
parent ae5ef653cb
commit e11d496e9d
96 changed files with 2241 additions and 1130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/dimensions.md
View File

@@ -29,14 +29,18 @@ previous: datepickerandroid
### `set()`
```javascript
static set(dims)
Dimensions.set(dims)
```
This should only be called from native code by sending the
didUpdateDimensions event.
@param {object} dims Simple string-keyed object of dimensions to set
**Parameters:**
| Name | Type | Required | Description |
| - | - | - | - |
| dims | object | Yes | Simple string-keyed object of dimensions to set |
@@ -46,23 +50,24 @@ didUpdateDimensions event.
### `get()`
```javascript
static get(dim)
Dimensions.get(dim)
```
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`).
> 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: `var {height, width} = Dimensions.get('window');`
@param {string} dim Name of dimension as defined when calling `set`.
@returns {Object?} Value for the dimension.
**Parameters:**
| Name | Type | Required | Description |
| - | - | - | - |
| dim | string | Yes | Name of dimension as defined when calling `set`. |
@@ -72,7 +77,7 @@ Example: `var {height, width} = Dimensions.get('window');`
### `addEventListener()`
```javascript
static addEventListener(type, handler)
Dimensions.addEventListener(type, handler)
```
@@ -91,7 +96,7 @@ Add an event handler. Supported events:
### `removeEventListener()`
```javascript
static removeEventListener(type, handler)
Dimensions.removeEventListener(type, handler)
```