@bdt-component-library/password-field
v0.1.1
Published
PasswordField component
Downloads
6
Readme
PasswordField Component
About
This is a component published as its own package from our component library monorepo: https://github.com/BenefitsDataTrust/ui-components. Setup instructions, as well as higher-level goals and concerns can be found from the main project README.
Description
Handles display of the PasswordField which wraps the TextField component.
- https://zeroheight.com/990ea04ab/p/98b6fb-input-fields
API
| prop | type | required | default | explanation | |-----------|--------|----------|---------|--------------| | className | string | no | "" | Adds an optional classname to the text field | | id | string | yes | undefined | Input id attr | | value | string | no | "" | Input value | | required | boolean | no | false | Determines if the input is required | | name | string | no | "" | Input name attr | | placeholder | string | no | "" | Input placeholder text | | disabled | boolean | no | false | Determines input disabled state | | onChange | function | no | () => {} | Event handler for onchange events | | testId | string | no | "" | Allows an id to be added for testing purposes via the data-testid attr || | noBottomMargin | boolean | no | false | Removes bottom margin of input for more control over formatting | | hasSuccess | boolean | no | false | Determines the input's success state | | hasError | boolean | no | false | Determines the input's error state |