indreka-field-password
TypeScript icon, indicating that this package has built-in type declarations

1.1.6 • Public • Published

Introduction

The input field password is a fundamental component of our design system. It provides a way for users to provide their password information for various purposes such as registration, login, so that only they have access to their account and details.

Input Field Password

The table below provides the size specifications:

Size Height
Mobile 36 px
Tablet 38 px
Web/Desktop 40 px

Input Field Password Colors

The table below provides the color specifications:

Color Hex code
Primary-1 #FFB42A
Neutral-1 #262626
Neutral-2 #6C6969
Neutral-3 #FFFFFF
Accent-1 #C7413A

Input Field Password States

The Input Field Password component has several states, depending on the user's interaction with it

State Description
Default The initial state of the Input Field component
Hover When the user hovers the mouse pointer over the Input Field
Focus When the user clicks on the Input Field
Error When the user gives incorrect password to display the error
Disabled When the Input Field is not available for interaction

indreka-field-password component

The <indreka-field-password></indreka-field-password> component having the following property:

  1. id having type of string.
  2. name having type of string.
  3. label having type of string.
  4. value having type of string.
  5. placeholder having type of string.
  6. required having type of boolean.
  7. disabled having type of boolean.
  8. helperEnabled having type of boolean.
  9. errorMessage having type of string.
  10. helperMessage having type of string.
  11. requiredMessage having type of string.
  12. pattern having type of string.
  13. iconHidePassword having type of array.
  14. iconShowPassword having type of array.
  15. iconLeft having type of array.

use

<indreka-field-password></indreka-field-password>

we can pass attributes inside like:

  1. id <indreka-field-password id="id"></indreka-field-password>

-- This will set an id for the checkbox and also set the 'for' attribute for the label as well.

  1. name <indreka-field-password name="name"></indreka-field-password>

-- This will add a name for the input field.

  1. label <indreka-field-password label="labelName"></indreka-field-password>

-- This will set the label for the password field and also update the aria-label.

  1. value <indreka-field-email value="value"></indreka-field-email>

-- This will store the value of the input field and if set, will show a default value on the input field.

  1. placeholder <indreka-field-password placeholder="placeholderName"></indreka-field-password>

-- This will set a placeholder for the input field.

  1. required <indreka-field-password required></indreka-field-password>

-- This will make the input field mandatory, if no value is provided, an error message will be shown below the field.

  1. disabled <indreka-field-password disabled></indreka-field-password>

-- This will disable the input field preventing the user to perform any action the input field.

  1. helperEnabled <indreka-field-password helperEnabled></indreka-field-password>

-- This will enable the helper text below the input field, user must keep this enabled to see the helper text or the error messages.

  1. errorMessage <indreka-field-password errorMessage="message"></indreka-field-password>

-- By using the errorMessage attribute, we can provide the error message for the validations.

  1. helperMessage <indreka-field-password helperMessage="message"></indreka-field-password>

-- This will allow the user to show a helper message for the input field, this will just be used to display information, no validation checks will be done here.

  1. requiredMessage <indreka-field-password helperMessage="message"></indreka-field-password>

-- This will allow the user to change the required message for the input field.

  1. pattern <indreka-field-password pattern="[A-Za-z0-9]{8,}">Text</indreka-field-password>

-- This will set a pattern for the input/password which will be checked and display an error message if the pattern does not matches.

  1. iconHidePassword <indreka-field-text iconHidePassword='["IconType", "IconVersion", "IconName"]'></indreka-field-text>

-- This will add an icon to the right end of the input field which will make the password hidden and it will take an array as input consisting of the icon's type, version and name (in the same order), You can take reference from the Icon Library.

  1. iconShowPassword <indreka-field-text iconShowPassword='["IconType", "IconVersion", "IconName"]'></indreka-field-text>

-- This will add an icon to the right end of the input field which will make the password visible and it will take an array as input consisting of the icon's type, version and name (in the same order), You can take reference from the Icon Library.

  1. iconLeft <indreka-field-text iconLeft='["IconType", "IconVersion", "IconName"]'></indreka-field-text>

-- This will add an icon to the left end of the input field and it will take an array as input consisting of the icon's type, version and name (in the same order), You can take reference from the Icon Library.

Angular use

--We are using custom events for values. so need to be implemented in the HTML code to get the input field values.

passwordFieldEvent <indreka-field-password (passwordFieldEvent)="eventHandler($event)"></indreka-field-password>

--Example

html <indreka-field-password name="passwordInput" (passwordFieldEvent)="handlePasswordFieldEvent($event)" ></indreka-field-password>

ts handlePasswordFieldEvent(event: Event) { const customEvent = event as CustomEvent; console.log(customEvent.detail); -- will provide the value from the input field }

styles The max-width and min-width of the input field is given as 120px and 600px respectively. For the custom component the styles cannot be changed. To change the width and height of the input-field . It can be wrapped between the div tag and it can be changed by giving width and height accordingly.

Readme

Keywords

none

Package Sidebar

Install

npm i indreka-field-password

Weekly Downloads

9

Version

1.1.6

License

none

Unpacked Size

49.5 kB

Total Files

14

Last publish

Collaborators

  • centilytics_admin