Skip to content
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

PlatformColor API #1813

Merged
merged 9 commits into from
Apr 14, 2020
Merged

PlatformColor API #1813

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
68b9f9d
PlatformColor API
Apr 2, 2020
bce046f
Incorrect quotation marks typo fix
Apr 3, 2020
847e00f
removed platformcolor from versioned docs, moved it out of hooks
Apr 3, 2020
1b6ccbd
Update en.json
Apr 3, 2020
24aeaf1
Added DynamicColorIOS section to colors.md
Apr 8, 2020
af93b09
Updates to colors.md and platformcolor.md
Apr 9, 2020
6e80eaf
Update colors.md
Apr 9, 2020
6ffd590
simplifier example for dynamiccolorios
Apr 9, 2020
43740ce
simplified the dynamiccolorios jsx code example
Apr 10, 2020
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
12 changes: 12 additions & 0 deletions docs/colors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,18 @@ React Native supports also colors as an `int` values (in RGB color mode):

> **_Note:_** This might appear similar to the Android [Color](https://developer.android.com/reference/android/graphics/Color) ints representation but on Android values are stored in SRGB color mode (0xaarrggbb).

## DynamicColorIOS
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could probably use some examples similar to what you have for PlatformColor

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll sync with tom to try and get an example piece in.


```jsx
static DynamicColorIOS({light: [Object object], dark: [Object object]}): [Object object]
```

The `DynamicColorIOS` function is a platform color type specific to iOS. `DynamicColorIOS` takes a single argument as an object with two keys: light and dark. The values of light and dark themselves must be values returned by the `PlatformColor` function.
kikisaints marked this conversation as resolved.
Show resolved Hide resolved

At runtime, the system will chose which of the two colors to display depending on the current system appearance settings. Dynamic colors are useful for branding colors or other app specific colors that still respond automatically to system setting changes.

The `DynamicColorIOS` function is similar to the iOS native methods [`UIColor colorWithDynamicProvider:`](https://developer.apple.com/documentation/uikit/uicolor/3238040-colorwithdynamicprovider)

## Named colors

In React Native you can also use color name strings as values.
Expand Down