# PinPad

A component used to authenticate or identify individuals through a standarized number pad.

```ts
const onPinSubmit = (pin: number[]): Promise<PinValidationResult> => {
  return new Promise((resolve) => {
    setTimeout(() => {
      const isPinValid =
        pin.length === 6 && pin.every((digit, index) => digit === index + 1);
      const result: PinValidationResult = isPinValid ? 'accept' : 'reject';
      resolve(result);
    }, 1000);
  });
};

```

## PinPad

### PinPadProps

### label

value: `string`

The content for the prompt on the pin pad.

### masked

value: `boolean`

Whether the entered PIN should be masked.

### maxPinLength

value: `PinLength`

The maximum length of the PIN.

### minPinLength

value: `PinLength`

The minimum length of the PIN.

### onPinEntry

value: `(pin: number[]) => void`

The function to be called when a PIN is entered.

### onSubmit

value: `(pin: number[]) => Promise<PinValidationResult>`

The function to be called when the PIN is submitted.

### pinPadAction

value: `PinPadActionType`

The call to action between the entry view and the keypad, consisting of a label and function that returns the pin.

### PinPadActionType

### label

value: `string`

The label for the action button.

### onPress

value: `() => Promise<number[]>`

The function to be called when the action button is pressed.