Skip to content

sebflorent/material-ui-password-field

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

material-ui-password-field

This project provides a password field for Material-UI.

Demo

If you want to try the component yourself instead of watching a gif, head over to the storybook for a live demo!

Installation

npm i --save material-ui-password-field

Usage

The usage of this component is pretty straightforward: Just replace your boring password TextFields with the shiny new PasswordField and you're done.

import PasswordField from 'material-ui-password-field'

<PasswordField
  hintText="At least 8 characters"
  floatingLabelText="Enter your password"
  errorText="Your password is too short"
/>

Properties

Name Type Default Description
disableButton bool false Set this to true to disable the visibility button.
visible bool false Set this to true to make the password initially visible.
style object Override the inline-styles of the root element.
textFieldStyle object Override the inline-styles of the TextField element.

Additionally, all properties of Material UI's Text Field should be supported, except for type and multiLine. Please open an issue if something is missing or does not work as expected.

Credits

Some code for the input component was adapted from Material UI's Text Field that we all know and love.

License

The files included in this repository are licensed under the MIT license.

About

A password field using Material-UI.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%