Skip to content

Add the "preferred" AlertButtonStyle #2839

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

Merged
merged 1 commit into from
Nov 5, 2022
Merged

Add the "preferred" AlertButtonStyle #2839

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
15 changes: 8 additions & 7 deletions docs/alert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ export default App;

## iOS

On iOS you can specify any number of buttons. Each button can optionally specify a style, available options are represented by the [AlertButtonStyle](#alertbuttonstyle-ios) enum.
On iOS you can specify any number of buttons. Each button can optionally specify a style or be emphasized, available options are represented by the [AlertButtonStyle](#alertbuttonstyle-ios) enum and the `isPreferred` field on [Buttons](alert#buttons).

## Android

Expand Down Expand Up @@ -284,19 +284,20 @@ An iOS Alert type.

### Buttons

Array of objects containg Alert buttons configuration.
Array of objects containing Alert buttons configuration.

| Type |
| ---------------- |
| array of objects |

**Objects properties:**

| Name | Type | Description |
| -------------------------------------- | ---------------------------------------------- | ------------------------------------------------------- |
| text | string | Button label. |
| onPress | function | Callback function when button is pressed. |
| style <div class="label ios">iOS</div> | [AlertButtonStyle](alert#alertbuttonstyle-ios) | Button style, on Android this property will be ignored. |
| Name | Type | Description |
| -------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------ |
| text | string | Button label. |
| onPress | function | Callback function when button is pressed. |
| style <div class="label ios">iOS</div> | [AlertButtonStyle](alert#alertbuttonstyle-ios) | Button style, on Android this property will be ignored. |
| isPreferred <div class="label ios">iOS</div> | boolean | Whether button should be emphasized, on Android this property will be ignored. |

---

Expand Down