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

Jump to bottom

Fix Alert API docs #2027

Merged
merged 4 commits into from
Jul 9, 2020
Merged

Fix Alert API docs #2027

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
30d0fdb
Fix Alert API docs
anku255 Jul 8, 2020
34da7e5
Update docs/alert.md
anku255 Jul 9, 2020
ffb698e
Update docs/alert.md
anku255 Jul 9, 2020
d2cacdb
Update docs/alert.md
anku255 Jul 9, 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
54 changes: 26 additions & 28 deletions docs/alert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ const App = () => {
style: "cancel"
},
{ text: "OK", onPress: () => console.log("OK Pressed") }
],
{ cancelable: false }
]
);

const createThreeButtonAlert = () =>
Expand All @@ -59,8 +58,7 @@ const App = () => {
style: "cancel"
},
{ text: "OK", onPress: () => console.log("OK Pressed") }
],
{ cancelable: false }
]
);

return (
Expand Down Expand Up @@ -101,8 +99,7 @@ class App extends Component {
style: "cancel"
},
{ text: "OK", onPress: () => console.log("OK Pressed") }
],
{ cancelable: false }
]
);

createThreeButtonAlert = () =>
Expand All @@ -120,8 +117,7 @@ class App extends Component {
style: "cancel"
},
{ text: "OK", onPress: () => console.log("OK Pressed") }
],
{ cancelable: false }
]
);

render() {
Expand Down Expand Up @@ -163,31 +159,33 @@ On Android at most three buttons can be specified. Android has a concept of a ne
- Two buttons mean 'negative', 'positive' (such as 'Cancel', 'OK')
- Three buttons mean 'neutral', 'negative', 'positive' (such as 'Later', 'Cancel', 'OK')

By default alerts on Android can be dismissed by tapping outside of the alert box. This event can be handled by providing an optional `options` parameter, with an `onDismiss` callback property `{ onDismiss: () => {} }`.
Alerts on Android can be dismissed by tapping outside of the alert box. It is disabled by default and can be enabled by providing an optional `options` parameter with the cancelable property set to true i.e. `{ cancelable: true }`.
anku255 marked this conversation as resolved.
Show resolved Hide resolved

Alternatively, the dismissing behavior can be disabled altogether by providing an optional options parameter with the cancelable property set to false i.e. `{ cancelable: false }`.
The dismissed event can be handled by providing an `onDismiss` callback property `{ onDismiss: () => {} }` inside the `options` parameter.
anku255 marked this conversation as resolved.
Show resolved Hide resolved

Example usage:

```jsx
// Works on both Android and iOS
Alert.alert(
'Alert Title',
'My Alert Msg',
[
{
text: 'Ask me later',
onPress: () => console.log('Ask me later pressed')
},
{
text: 'Cancel',
onPress: () => console.log('Cancel Pressed'),
style: 'cancel'
},
{ text: 'OK', onPress: () => console.log('OK Pressed') }
],
{ cancelable: false }
);
// Works only on Android
anku255 marked this conversation as resolved.
Show resolved Hide resolved
Alert.alert('Alert Title', 'My Alert Msg', [
{
text: 'Ask me later',
onPress: () => console.log('Ask me later pressed')
},
{
text: 'Cancel',
onPress: () => console.log('Cancel Pressed'),
style: 'cancel'
},
{ text: 'OK', onPress: () => console.log('OK Pressed') },
{
cancelable: true,
anku255 marked this conversation as resolved.
Show resolved Hide resolved
onDismiss: () =>
console.log(
'This alert was dismissed by tapping outside of the alert dialog.'
)
}
]);
```

---
Expand Down