-
-
Notifications
You must be signed in to change notification settings - Fork 13
create documentation of button component #22
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.
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,136 @@ | ||
--- | ||
id: button | ||
title: Button | ||
wip: true | ||
--- | ||
|
||
A basic button component that should render nicely on any platform. Supports a minimal level of customization. | ||
|
||
If this button doesn't look right for your app, you can build your own button using [TouchableOpacity](touchableopacity) or [TouchableWithoutFeedback](touchablewithoutfeedback). | ||
|
||
```res | ||
<Button | ||
onPress={onPressLearnMore} | ||
title="Learn More" | ||
color="#841584" | ||
accessibilityLabel="Learn more about this purple button" | ||
/> | ||
``` | ||
|
||
## Example | ||
|
||
```SnackPlayer name=Button%20Example | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Snack don't works on our website and can't. |
||
open ReactNative | ||
|
||
let styles = { | ||
open Style | ||
StyleSheet.create({ | ||
"title": textStyle(~fontSize=24., ~fontWeight=#_600, ()), | ||
}) | ||
} | ||
|
||
@react.component | ||
let app = () => { | ||
<SafeAreaView> | ||
<StatusBar /> | ||
<ScrollView contentInsetAdjustmentBehavior=#automatic> | ||
<Text style={styles["title"]}> {"Button component"->React.string} </Text> | ||
<Button | ||
onPress={(_) => | ||
Alert.alert( | ||
~title="Button pressed", | ||
~message="The button is pressed and show this alert", | ||
(), | ||
) | ||
} | ||
title="Press me" | ||
color="#841584" | ||
accessibilityLabel="Learn more about this purple button" | ||
/> | ||
<Button | ||
title="Press me" | ||
color="#f194ff" | ||
onPress={(_) => | ||
Alert.alert( | ||
~title="Button pressed", | ||
~message="Button with adjusted color pressed", | ||
(), | ||
) | ||
} | ||
/> | ||
</ScrollView> | ||
</SafeAreaView> | ||
} | ||
``` | ||
|
||
--- | ||
|
||
# Reference | ||
|
||
## Props | ||
|
||
### <div class="label required basic">Required</div>**`onPress`** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this css things doesn't work am I right? |
||
|
||
Handler to be called when the user taps the button. | ||
|
||
| Type | | ||
| ---------------------------------- | | ||
| function([PressEvent](pressevent)) | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. link don't work. |
||
|
||
--- | ||
|
||
### <div class="label required basic">Required</div>**`title`** | ||
|
||
Text to display inside the button. On Android the given title will be converted to the uppercased form. | ||
|
||
| Type | | ||
| ------ | | ||
| string | | ||
|
||
--- | ||
|
||
### `accessibilityLabel` | ||
|
||
Text to display for blindness accessibility features. | ||
|
||
| Type | | ||
| ------ | | ||
| string | | ||
|
||
--- | ||
|
||
### `color` | ||
|
||
Color of the text (iOS), or background color of the button (Android). | ||
|
||
| Type | Default | | ||
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| [color](colors) | <ins style={{background: '#2196F3'}} className="color-box" /> `'#2196F3'` <div className="label android">Android</div><hr/><ins style={{background: '#007AFF'}} className="color-box" /> `'#007AFF'` <div className="label ios">iOS</div> | | ||
|
||
--- | ||
|
||
### `disabled` | ||
|
||
If `true`, disable all interactions for this component. | ||
|
||
| Type | Default | | ||
| ---- | ------- | | ||
| bool | `false` | | ||
|
||
--- | ||
### `testID` | ||
|
||
Used to locate this view in end-to-end tests. | ||
|
||
| Type | | ||
| ------ | | ||
| string | | ||
|
||
--- | ||
|
||
### `touchSoundDisabled` <div class="label android">Android</div> | ||
|
||
If `true`, doesn't play system sound on touch. | ||
|
||
| Type | Default | | ||
| ------- | ------- | | ||
| boolean | `false` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pressable are recommended instead of Touchables.