Pin Input

Alpha

A sequence of one-character alphanumeric inputs.

Pin Input

<script setup lang="ts">
import { ref } from 'vue'
import { Label, PinInputInput, PinInputRoot } from 'radix-vue'

const value = ref<string[]>([])
const handleComplete = (e: string[]) => alert(e.join(''))
</script>

<template>
  <div>
    <Label for="pin-input" class="text-white">Pin Input</Label>
    <PinInputRoot
      id="pin-input"
      v-model="value"
      placeholder="○"
      class="flex gap-2 items-center mt-1"
      @complete="handleComplete"
    >
      <PinInputInput
        v-for="(id, index) in 5"
        :key="id"
        :index="index"
        class="w-10 h-10 bg-white rounded text-center shadow-lg text-green10 placeholder:text-mauve8 focus:outline focus:outline-2 focus:outline-offset-2 focus:outline-white"
      />
    </PinInputRoot>
  </div>
</template>

Features

• Full keyboard navigation.
• Can be controlled or uncontrolled.
• Supports pasting from clipboard
• Emit event when inputs were filled.

Installation

Install the component from your command line.

npm install radix-vue

Anatomy

Import all parts and piece them together.

<script setup>
import { PinInputInput, PinInputRoot } from 'radix-vue'
</script>

<template>
  <PinInputRoot>
    <PinInputInput />
  </PinInputRoot>
</template>

API Reference

Root

Contains all the parts of a checkbox. An input will also render when used within a form to ensure events propagate correctly.

Prop	Default	Type
as	div	string | Component The element or component this component should render as. Can be overwrite by asChild
asChild	false	boolean Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
defaultValue		string[] The default value of the pin inputs when it is initially rendered. Use when you do not need to control its checked state.
modelValue		string[] The controlled checked state of the pin input. Can be binded with v-model.
placeholder		string The placeholder character to use for empty pin-inputs.
mask	false	boolean When true, pin inputs will be treated as password.
otp	false	boolean When true, mobile devices will autodetect the OTP from messages or clipboard, and enable the autocomplete field.
type	text	text | number Input type for the inputs.
disabled		boolean When true, prevents the user from interacting with the pin input
required		boolean When true, indicates that the user must check the pin input before the owning form can be submitted.
name		string The name of the pin input Submitted with its owning form as part of a name/value pair.

Emit	Type
@update:modelValue	(value: string[]) => void
@complete	(value: string[]) => void

Data Attribute	Value
[data-complete]	Present when completed
[data-disabled]	Present when disabled

Input

Input field for Pin Input. You can add as many input as you like.

Prop	Default	Type
as	span	string | Component The element or component this component should render as. Can be overwrite by asChild
asChild	false	boolean Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
index		number Position of the value this input bind to.
disabled		boolean When true, prevents the user from interacting with the pin input

Data Attribute	Value
[data-complete]	Present when completed
[data-disabled]	Present when disabled

Examples

OTP mode

You can set the pin input to otp mode by setting otp to true.

<script setup lang="ts"> 
import { Label, PinInputInput, PinInputRoot } from 'radix-vue' 
</script>

<template>
  <PinInputRoot v-model="value" otp>
    …
  </PinInputRoot>
</template>

Numeric mode

You can set the pin input to only accept number type by setting type to number.

<script setup lang="ts"> 
import { Label, PinInputInput, PinInputRoot } from 'radix-vue' 
</script>

<template>
  <PinInputRoot v-model="value" type="number">
    …
  </PinInputRoot>
</template>

Accessibility

Keyboard Interactions

Key	Description
ArrowLeft	Focus on previous input.
ArrowRight	Focus on next input.
Home	Focus on the first input.
End	Focus on the last input.
Backspace	Deletes the value of the current input. If the input is empty, moves to the previous input and deletes that value as well.
Delete	Deletes the value of the current input.
Ctrl + V	Pastes the contents of the clipboard into the pin input. If the number of characters in the clipboard equals exceeds the number of inputs, the contents are pasted from the first input. Otherwise, the contents are pasted from the current input onwards.