-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from materialr/feature/material-035
feat: Swap to material 0.35.0 Swap to material 0.35.0. Upgrade packages BREAKING CHANGE: the stroked prop has been renamed to outlined to conform to spec.
- Loading branch information
Showing
6 changed files
with
268 additions
and
277 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,44 @@ | ||
# @materialr/button | ||
# MaterialR Button | ||
|
||
**@materialr/button** | ||
|
||
[![Build Status](https://travis-ci.org/materialr/button.svg?branch=master)](https://travis-ci.org/materialr/button) | ||
[![Coverage Status](https://coveralls.io/repos/github/materialr/button/badge.svg?branch=master)](https://coveralls.io/github/materialr/button?branch=master) | ||
[![NSP Status](https://nodesecurity.io/orgs/materialr/projects/d0ac58a2-fcd9-4011-b858-71760f65a5c1/badge)](https://nodesecurity.io/orgs/materialr/projects/d0ac58a2-fcd9-4011-b858-71760f65a5c1) | ||
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) | ||
|
||
Material button implementation for React | ||
|
||
## Installation | ||
|
||
``` | ||
```sh | ||
$ npm install --save @materialr/button | ||
``` | ||
|
||
## Demo | ||
|
||
A full demo is available on the [MaterialR website](https://materialr.github.io/components/button) | ||
showcasing all variants. | ||
|
||
## Components | ||
|
||
### Default export | ||
|
||
```js | ||
import Button from '@materialr/button'; | ||
``` | ||
|
||
**Props** | ||
|
||
| Prop | Type | Required | Default | Description | | ||
| ------------ | -------------------------- | -------- | --------- | ---------------------------------------------------- | | ||
| `children` | string / node | Yes | N/A | The text - or elements - to render inside the button | | ||
| `className` | string | No | undefined | Additional classNames to add to the button | | ||
| `dense` | bool | No | false | Whether to render the dense button variant | | ||
| `disabled` | bool | No | false | Whether the button is disabled | | ||
| `onClick` | func | No | undefined | The button's click handler | | ||
| `outlined` | bool | No | false | Whether to render the outlined button variant | | ||
| `raised` | bool | No | false | Whether to render the raised button variant | | ||
| `ripple` | bool | No | false | Whether to add a ripple effect to the button | | ||
| `type` | enum (button/submit/clear) | No | button | The button's type attribute | | ||
| `unelevated` | bool | No | false | Whether to render the unelevated button variant | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.