Skip to content

Commit

Permalink
feat: material 0.35.0 upgrade add UUID. fix linting. upgrade packages…
Browse files Browse the repository at this point in the history
…. rename props to remove has and is BREAKING CHANGE: has and is has been removed from all props to align with other components
  • Loading branch information
hvolschenk committed Apr 28, 2018
1 parent 7427a02 commit 5052954
Show file tree
Hide file tree
Showing 5 changed files with 172 additions and 114 deletions.
58 changes: 57 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,58 @@
# textfield
# MaterialR TextField

**@materialr/textfield**

[![Build Status](https://travis-ci.org/materialr/textfield.svg?branch=master)](https://travis-ci.org/materialr/textfield)
[![Coverage Status](https://coveralls.io/repos/github/materialr/textfield/badge.svg?branch=master)](https://coveralls.io/github/materialr/textfield?branch=master)
[![NSP Status](https://nodesecurity.io/orgs/materialr/projects/781e1159-7da9-4317-87ca-bffa2b49d70b/badge)](https://nodesecurity.io/orgs/materialr/projects/781e1159-7da9-4317-87ca-bffa2b49d70b)
[![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 textfield implementation for React

## Installation

```sh
$ npm install --save @materialr/textfield
```

## Demo

A full demo is available on the
[MaterialR website](https://materialr.github.io/components/textfield) showcasing all variants.

## Components

### Default export

```js
import TextField from '@materialr/textfield';
```

**Props**

| Prop | Type | Required | Default | Description |
| ----------------------------- | --------------- | -------- | ---------- | -------------------------------------------------------------- |
| `box` | bool | No | false | Whether to render a box outline |
| `className` | string | No | undefined | Additional classNames to add |
| `disabled` | bool | No | false | Whether the input is disabled |
| `fullWidth` | bool | No | false | Whether the input is the full width of it's parent |
| `helperText` | string | No | undefined | The helper text to render beneath the field |
| `helperTextPersistent` | bool | No | false | Whether the helper text is always visible |
| `helperTextValidationMessage` | bool | No | false | Whether the helper text is for a validation message |
| `icon` | string | No | undefined | The material icon to render to the start of the field |
| `iconAlignEnd` | bool | No | false | Whether the icon is aligned to the end of the field |
| `id` | string | No | `uuidv1()` | The id attribute of the field |
| `label` | string | Yes | N/A | The field's label |
| `lengthMaximum` | number | No | undefined | The maximum length of the field (HTML5 validation) |
| `lengthMinimum` | number | No | undefined | The minimum length of the field (HTML5 validation) |
| `onBlur` | func | No | undefined | The `blur` event handler |
| `onChange` | func | No | undefined | The `change` event handler |
| `onDragStart` | func | No | undefined | The `dragstart` event handler |
| `onDrop` | func | No | undefined | The `drop` event handler |
| `onFocus` | func | No | undefined | The `focus` event handler |
| `onIconClick` | func | No | undefined | The event handler when clicking on the `icon` |
| `outlined` | bool | No | false | Whether to display the outline style field |
| `required` | bool | No | false | Whether the field is required (HTML5 validation) |
| `type` | string | No | text | The field's type attribute (use `textarea` for a `<textarea>`) |
| `valid` | bool | No | undefined | Whether the field is valid or not (manual validation) |
| `value` | string | No | undefined | the value of the field |
104 changes: 52 additions & 52 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,14 +28,15 @@
},
"homepage": "https://github.com/materialr/textfield#readme",
"dependencies": {
"@material/textfield": "^0.34.1",
"@material/textfield": "^0.35.0",
"classnames": "^2.2.5",
"prop-types": "^15.6.1",
"react": "^16.3.1"
"react": "^16.3.2",
"uuid": "^3.2.1"
},
"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.1",
"babel-preset-react": "^6.24.1",
Expand All @@ -50,7 +51,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 5052954

Please sign in to comment.