Skip to content

update button.md #9

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

Open
westl wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update button.md #9

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
19 changes: 14 additions & 5 deletions components/button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ import { Button } from 'react-native-material-design';
render() {
return (
<View>
<Button value="NORMAL FLAT" onPress={()=> console.log("I pressed a flat button")} />
<Button value="NORMAL RAISED" raised={true} onPress={()=> console.log("I pressed a raised button")} />
//**NOTE: If using overrides on a flat button (raised={false}), backgroundColor will not display.
<Button text="NORMAL FLAT" onPress={()=> console.log("I pressed a flat button")} />
<Button text="NORMAL RAISED" raised={true} onPress={()=> console.log("I pressed a raised button")} />
</View>
);
}
Expand All @@ -28,25 +29,33 @@ render() {

Prop | Type | Description | Required | Default
--- | --- | --- | --- | ---
value | string | The text which is rendered inside of the button | true |
text | string | The text which is rendered inside of the button | true |
theme | [THEME_NAME](/api/theme_name) | | false | light
primary | [PRIMARY_COLORS](/api/primary_colors) | | false | [PRIMARY](/api/primary)
overrides <br /> *textColor* <br /> *backgroundColor* <br /> *rippleColor* | object <br /> *string* <br /> *string* <br /> *string* | An object to override any colors <br /> *Override the text color of the button* <br /> *Override the background color of the button* <br /> *Override the ripple color of the button* | false <br /><br /><br /><br /> |
disabled | bool | Whether to render the button as disabled. This will prevent any onPress props being triggered | false | false
onPress | func | A function which is called when the touch of the button is released | false |
onLongPress | func | A function which is called when the touch of the button is held for a long duration | false |
raised | bool | | false | false

## Examples

### Group Buttons

```
<View style={{flex: 2, flexDirection: 'row'}}>
<View style={{flex: 3, flexDirection: 'row'}}>
<View style={{flex: 1}}>
<Button text='Button A' raised={true} />
</View>
<View style={{flex: 1}}>
<Button text='Button B' raised={true} />
//**NOTE: primary only changes the text and not the color of the button at the moment.
<Button primary='paperGreen' text='Button B' raised={true} />
</View>
<View style={{flex: 1}}>
<Button overrides={{
backgroundColor: 'paperRed',
textColor: 'paperGrey50'
}} text='Looks Good!' raised={true} onPress={() => console.log("IT LOOKS GOOD!")}/>
</View>
</View>
```