Skip to content

Commit

Permalink
Merge pull request #14 from materialr/feature/material-035
Browse files Browse the repository at this point in the history
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
hvolschenk committed Apr 27, 2018
2 parents a6c28a3 + 2acd47b commit e06feb7
Show file tree
Hide file tree
Showing 6 changed files with 268 additions and 277 deletions.
39 changes: 37 additions & 2 deletions README.md
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 |
3 changes: 3 additions & 0 deletions jest.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,8 @@
"testPathIgnorePatterns": [
"/node_modules/",
"<rootDir>/.jest"
],
"transformIgnorePatterns": [
"<rootDir>/node_modules/(!@material)"
]
}
146 changes: 76 additions & 70 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 5 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,16 @@
},
"homepage": "https://github.com/materialr/button#readme",
"dependencies": {
"@material/button": "^0.34.1",
"@material/button": "^0.35.0",
"@material/ripple": "^0.35.0",
"@materialr/ripple": "^0.1.3",
"classnames": "^2.2.5",
"prop-types": "^15.6.1",
"react": "^16.3.1"
"react": "^16.3.2"
},
"devDependencies": {
"babel-cli": "^6.26.0",
"babel-core": "^6.26.0",
"babel-core": "^6.26.3",
"babel-jest": "^22.4.3",
"babel-preset-env": "^1.6.0",
"babel-preset-react": "^6.24.1",
Expand All @@ -51,7 +52,7 @@
"eslint-plugin-react": "^7.7.0",
"jest": "^22.4.3",
"nsp": "^3.2.1",
"react-dom": "^16.3.1",
"react-dom": "^16.3.2",
"semantic-release": "^15.1.7"
}
}
Loading

0 comments on commit e06feb7

Please sign in to comment.