Skip to content

Commit

Permalink
feat: update types & README (#298)
Browse files Browse the repository at this point in the history
* chore: fix lint warnings

* feat: add test attributes to types
  • Loading branch information
apollonian authored Jun 24, 2021
1 parent 1e34117 commit a170001
Show file tree
Hide file tree
Showing 9 changed files with 156 additions and 299 deletions.
3 changes: 2 additions & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
"plugin:react/recommended",
"plugin:react-hooks/recommended",
"plugin:import/recommended",
"plugin:prettier/recommended"
"plugin:prettier/recommended",
"prettier"
],
"rules": {
"no-unused-vars": "off",
Expand Down
1 change: 1 addition & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"arrowParens": "always",
"printWidth": 120,
"semi": true,
"singleQuote": true,
"tabWidth": 2,
Expand Down
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,13 +155,27 @@ export default class App extends Component {
<td>false</td>
<td>Restrict input to only numbers.</td>
</tr>
<tr>
<tr>
<td>isInputSecure</td>
<td>boolean</td>
<td>false</td>
<td>false</td>
<td>Masks input characters.</td>
</tr>
<tr>
<td>data-cy</td>
<td>string</td>
<td>false</td>
<td>-</td>
<td>Test attribute passed to the inputs.</td>
</tr>
<tr>
<td>data-testid</td>
<td>string</td>
<td>false</td>
<td>-</td>
<td>Test attribute passed to the inputs.</td>
</tr>
</table>

## Breaking changes when porting to v1.0.0
Expand All @@ -183,9 +197,7 @@ npm run dev
- [x] Add flowtypes
- [x] Add ESLint, Prettier for code quality
- [x] Add styling support for states including focus/disabled
- [ ] Travis CI, Codecov
- [ ] Write tests
- [ ] Improve Documentation

## Contributing

Expand Down
Loading

0 comments on commit a170001

Please sign in to comment.