跳至正文
uiify

OTP input

用于一次性验证码的输入框，每个字符占一个输入槽。

浏览器
Chrome 123+Firefox 121+Safari 17.5+
层级
2
压缩后大小
1.53 kB
强制布局预算
0 ms
axe 预算
0
支持 SSR
是
公开契约
测试环境

交互示例

OTP Input

默认

import { OtpInput } from "@gunkin/uiify";

export default function Example() {
  return (
    <OtpInput.Root className="" id="verification-code" length={6}>
      {Array.from({ length: 6 }, (_, index) => (
        <OtpInput.Slot className="" index={index} key={index} />
      ))}
      <OtpInput.HiddenInput />
    </OtpInput.Root>
  );
}
/* OTP input — segmented code entry slots. */

@layer components {
  [data-uiify-otp-input] {
    position: relative;
    display: inline-flex;
    gap: var(--space-sm);
    cursor: text;
  }

  [data-uiify-otp-input] [data-part="slot"] {
    display: inline-flex;
    align-items: center;
    justify-content: center;
    inline-size: 2.5rem;
    block-size: 2.5rem;
    border: var(--border-width) solid var(--input);
    border-radius: var(--radius-md);
    corner-shape: squircle;
    background-color: var(--card);
    color: var(--foreground);
    font-size: var(--text-lg);
    font-weight: var(--weight-medium);
    transition: var(--transition-colors);
  }

  [data-uiify-otp-input] [data-part="slot"][data-active] {
    border-color: var(--primary);
    outline: 2px solid color-mix(in oklch, var(--ring) 35%, transparent);
    outline-offset: 0;
  }

  [data-uiify-otp-input] [data-part="slot"][data-active]::after {
    inline-size: 1px;
    block-size: 1em;
    background-color: currentcolor;
    content: "";
    animation: uiify-otp-input-caret-blink 1s step-end infinite;
  }

  @keyframes uiify-otp-input-caret-blink {
    50% {
      opacity: 0;
    }
  }

  @media (prefers-reduced-motion: reduce) {
    [data-uiify-otp-input] [data-part="slot"][data-active]::after {
      animation: none;
    }
  }

  [data-uiify-otp-input] [data-part="slot"][data-filled] {
    border-color: var(--input);
  }

  [data-uiify-otp-input][data-disabled] [data-part="slot"] {
    opacity: 0.5;
    cursor: not-allowed;
  }
}

@layer components {
  [data-uiify-otp-input]:not([data-disabled]) {
    cursor: text;
  }
}
import { OtpInput } from "@gunkin/uiify";

export default function Example() {
  return (
    <OtpInput.Root
      className="
        relative inline-flex gap-sm [cursor:text] [&_[data-part=slot]]:inline-flex [&_[data-part=slot]]:items-center
        [&_[data-part=slot]]:justify-center [&_[data-part=slot]]:[inline-size:2.5rem]
        [&_[data-part=slot]]:[block-size:2.5rem] [&_[data-part=slot]]:border-[length:var(--border-width)]
        [&_[data-part=slot]]:border-solid [&_[data-part=slot]]:border-input [&_[data-part=slot]]:rounded-md
        [&_[data-part=slot]]:[corner-shape:squircle] [&_[data-part=slot]]:bg-card [&_[data-part=slot]]:text-foreground
        [&_[data-part=slot]]:text-lg [&_[data-part=slot]]:font-[number:var(--weight-medium)]
        [&_[data-part=slot]]:[transition:var(--transition-colors)] [&_[data-part=slot][data-active]]:border-primary
        [&_[data-part=slot][data-active]]:[outline:2px_solid_color-mix(in_oklch,_var(--ring)_35%,_transparent)]
        [&_[data-part=slot][data-active]]:[outline-offset:0] [&_[data-part=slot][data-active]::after]:[inline-size:1px]
        [&_[data-part=slot][data-active]::after]:[block-size:1em] [&_[data-part=slot][data-active]::after]:bg-current
        [&_[data-part=slot][data-active]::after]:content-['']
        [&_[data-part=slot][data-active]::after]:[animation:uiify-otp-input-caret-blink_1s_step-end_infinite]
        motion-reduce:[&_[data-part=slot][data-active]::after]:[animation:none]
        [&_[data-part=slot][data-filled]]:border-input [&[data-disabled]_[data-part=slot]]:opacity-50
        [&[data-disabled]_[data-part=slot]]:cursor-not-allowed [&:not([data-disabled])]:[cursor:text]
      "
      id="verification-code"
      length={6}
    >
      {Array.from({ length: 6 }, (_, index) => (
        <OtpInput.Slot
          className="
            grid place-items-center size-10 border-[length:var(--border-width)] border-solid border-input rounded-md
            bg-card text-foreground text-lg font-medium tabular-nums [transition:var(--transition-colors)]
            data-[active]:border-primary
            data-[active]:[outline:2px_solid_color-mix(in_oklch,_var(--ring)_35%,_transparent)]
            data-[active]:[outline-offset:0] data-[active]:after:content-[''] data-[active]:after:[inline-size:1px]
            data-[active]:after:[block-size:1em] data-[active]:after:bg-current
            data-[active]:after:[animation:uiify-otp-input-caret-blink_1s_step-end_infinite]
            motion-reduce:data-[active]:after:[animation:none] data-[filled]:border-input data-[disabled]:opacity-50
            data-[disabled]:cursor-not-allowed
          "
          index={index}
          key={index}
        />
      ))}
      <OtpInput.HiddenInput />
    </OtpInput.Root>
  );
}
/* app.css */

@layer reset, ui, app, tokens, base, demo, components, utilities, theme;

@import "@gunkin/uiify/styles/reset";

@import "@gunkin/uiify/components/behavior.css";

@import "@gunkin/uiify/styles/tokens";

@import "@gunkin/uiify/styles/tailwind";

@import "tailwindcss/utilities.css";

@theme { --spacing: 0.25rem; --font-weight-normal: 400; --font-weight-medium: 500; --font-weight-semibold: 600; --font-weight-bold: 700; }

@source inline('relative inline-flex gap-sm [cursor:text] [&_[data-part=slot]]:inline-flex [&_[data-part=slot]]:items-center [&_[data-part=slot]]:justify-center [&_[data-part=slot]]:[inline-size:2.5rem] [&_[data-part=slot]]:[block-size:2.5rem] [&_[data-part=slot]]:border-[length:var(--border-width)] [&_[data-part=slot]]:border-solid [&_[data-part=slot]]:border-input [&_[data-part=slot]]:rounded-md [&_[data-part=slot]]:[corner-shape:squircle] [&_[data-part=slot]]:bg-card [&_[data-part=slot]]:text-foreground [&_[data-part=slot]]:text-lg [&_[data-part=slot]]:font-[number:var(--weight-medium)] [&_[data-part=slot]]:[transition:var(--transition-colors)] [&_[data-part=slot][data-active]]:border-primary [&_[data-part=slot][data-active]]:[outline:2px_solid_color-mix(in_oklch,_var(--ring)_35%,_transparent)] [&_[data-part=slot][data-active]]:[outline-offset:0] [&_[data-part=slot][data-active]::after]:[inline-size:1px] [&_[data-part=slot][data-active]::after]:[block-size:1em] [&_[data-part=slot][data-active]::after]:bg-current [&_[data-part=slot][data-active]::after]:[animation:uiify-otp-input-caret-blink_1s_step-end_infinite] motion-reduce:[&_[data-part=slot][data-active]::after]:[animation:none] [&_[data-part=slot][data-filled]]:border-input [&[data-disabled]_[data-part=slot]]:opacity-50 [&[data-disabled]_[data-part=slot]]:cursor-not-allowed [&:not([data-disabled])]:[cursor:text] grid place-items-center size-10 border-[length:var(--border-width)] border-solid border-input rounded-md bg-card text-foreground text-lg font-medium tabular-nums [transition:var(--transition-colors)] data-[active]:border-primary data-[active]:[outline:2px_solid_color-mix(in_oklch,_var(--ring)_35%,_transparent)] data-[active]:[outline-offset:0] data-[active]:after:[inline-size:1px] data-[active]:after:[block-size:1em] data-[active]:after:bg-current data-[active]:after:[animation:uiify-otp-input-caret-blink_1s_step-end_infinite] motion-reduce:data-[active]:after:[animation:none] data-[filled]:border-input data-[disabled]:opacity-50 data-[disabled]:cursor-not-allowed');

@source inline("[&_[data-part=slot][data-active]::after]:content-[''] data-[active]:after:content-['']");

@layer base { :root { --uiify-control-text: var(--text-sm); } @media (pointer: coarse) { :root { --uiify-control-text: var(--text-base); } } }

/* Authored animation and registered properties used by the Tailwind skin.
 * Visual rules belong in utility recipes; only at-rule definitions live here. */
@layer components {
  @keyframes uiify-presence-in {
    from {
      opacity: 0;
      scale: var(--presence-scale);
    }
  }
}

@layer components {
  @keyframes uiify-presence-out {
    to {
      opacity: 0;
      scale: var(--presence-scale);
    }
  }
}

@property --uiify-spinner-tail {
  syntax: "<angle>";
  inherits: false;
  initial-value: 0deg;
}

@property --uiify-spinner-length {
  syntax: "<angle>";
  inherits: false;
  initial-value: 36deg;
}

@layer components {
  @keyframes uiify-spinner-rotate {
    to {
      transform: rotate(360deg);
    }
  }
}

@layer components {
  @keyframes uiify-spinner-orbit {
    0% {
      --uiify-spinner-tail: 0deg;
      --uiify-spinner-length: 36deg;
    }

    50% {
      --uiify-spinner-tail: 90deg;
      --uiify-spinner-length: 324deg;
    }

    100% {
      --uiify-spinner-tail: 360deg;
      --uiify-spinner-length: 36deg;
    }
  }
}

@layer components {
  @keyframes uiify-skeleton-pulse {
    50% {
      opacity: 0.45;
    }
  }
}

@layer components {
  @keyframes uiify-skeleton-shimmer {
    to {
      background-position: -200% 0;
    }
  }
}

@layer components {
  @keyframes uiify-skeleton-reveal {
    from {
      opacity: 0;
    }
    to {
      opacity: 1;
    }
  }
}

@property --candle-body-height {
  syntax: "<percentage>";
  inherits: true;
  initial-value: 0%;
}

@property --candle-body-top {
  syntax: "<percentage>";
  inherits: true;
  initial-value: 50%;
}

@property --candle-slot {
  syntax: "<percentage>";
  inherits: true;
  initial-value: 100%;
}

@property --candle-wick-height {
  syntax: "<percentage>";
  inherits: true;
  initial-value: 0%;
}

@property --candle-wick-top {
  syntax: "<percentage>";
  inherits: true;
  initial-value: 50%;
}

@property --candle-x {
  syntax: "<percentage>";
  inherits: true;
  initial-value: 0%;
}

@property --candle-scale {
  syntax: "<number>";
  inherits: true;
  initial-value: 1;
}

@property --line-y {
  syntax: "<percentage>";
  inherits: true;
  initial-value: 50%;
}

@property --line-prev-y {
  syntax: "<percentage>";
  inherits: true;
  initial-value: 50%;
}

@property --line-count {
  syntax: "<integer>";
  inherits: false;
  initial-value: 1;
}

@property --line-scale {
  syntax: "<number>";
  inherits: true;
  initial-value: 1;
}

@layer components {
  @keyframes uiify-otp-input-caret-blink {
    50% {
      opacity: 0;
    }
  }
}

API

OtpInput.Root

属性类型默认值说明
valuestring—当前验证码，使字段受控。
defaultValuestring""非受控字段的初始验证码。
onValueChange(value: string) => void—验证码变化时，使用新验证码调用。
onComplete(value: string) => void—验证码达到配置长度时调用。
lengthnumber6验证码的字符数。
type"numeric" | "alphanumeric""numeric"输入或粘贴时保留哪些字符。
maskbooleanfalse隐藏输入槽中已输入的字符。
disabledbooleanfalse禁用隐藏输入框，并设置data-disabled属性。
autoFocusbooleanfalse字段挂载时聚焦隐藏输入框。
idstring—应用于渲染根元素的id。
renderReactElement | ((props, state) => ReactElement)—替换渲染元素，同时保留行为和无障碍连接关系。

OtpInput.Slot

属性类型默认值说明
index*number—此输入槽显示验证码中的哪个位置。
renderReactElement | ((props, state) => ReactElement)—替换渲染元素，同时保留行为和无障碍连接关系。

OtpInput.HiddenInput

属性类型默认值说明
autoFocusboolean—挂载时聚焦此输入框，覆盖根设置。
renderReactElement | ((props, state) => ReactElement)—替换渲染元素，同时保留行为和无障碍连接关系。

键盘

按键操作
Tab将焦点移入或移出控件
Enter / Space获得焦点时激活（按钮类控件）

无障碍

尽可能使用语义化HTML。可在交互示例中检查渲染的标记；仅在原生元素无法满足需求时添加ARIA。

样式钩子

data-disabled