@k8ordo/ui

ColorPicker

色を#rrggbbで選ぶ入力欄です。色相と彩度、明度のつまみと、見本から選べます。

インポート

ts
import { ColorPicker } from '@k8ordo/ui';

使い方

nameはテキストの入力欄に付きます。つまみや見本で選んだ色はこの入力欄に書き込まれ、inputイベントが発火します。入力欄の横の色を押すと、ブラウザの色の選択が開きます。そこで選んだ色も同じように入力欄に入ります。入力している間は、6桁そろうまで色として扱いません。フォーカスを外したときとEnterで、小文字の#rrggbbにそろえます。3桁の#f80もそこで6桁に広げます。

tsx
<ColorPicker aria-label="Accent color" defaultValue="#0d9488" name="accent" />

見本

見本はそれぞれlabelを名前に持つトグルボタンです。今の色と同じ見本が押された状態になります。

tsx
const swatches = [
  { value: '#0d9488', label: 'Teal' },
  { value: '#2563eb', label: 'Blue' },
  { value: '#f97316', label: 'Orange' },
  { value: '#e11d48', label: 'Rose' },
  { value: '#171717', label: 'Black' },
];

<ColorPicker
  aria-label="Accent color"
  defaultValue="#f97316"
  swatches={swatches}
/>

制御モード

onChangeは#rrggbbを受け取ります。入力欄を空にしたときは''です。

value: #2563eb

tsx
const [color, setColor] = useState('#2563eb');

<ColorPicker
  aria-label="Accent color"
  onChange={setColor}
  swatches={swatches}
  value={color}
/>

無効

tsx
<ColorPicker aria-label="Accent color" defaultValue="#0d9488" disabled />

@k8ordo/formとの組み合わせ

formFieldsが作ったinputをそのまま展開できます。スキーマの.regex()はpatternとして渡り、組み込みの#[0-9a-fA-F]{6}を置き換えます。変更の有無とルール、エラーの解除、リセットもそのまま働きます。

tsx
// schema.ts
export const themeSchema = z.object({
  accent: z.string().regex(/^#[0-9a-f]{6}$/),
});

// theme-form.tsx
const accent = form.field('accent');

<FormControl
  errorText={accent.error}
  invalid={accent.invalid}
  label="Accent color"
  required={accent.required}
  renderInput={(props) => <ColorPicker {...props} {...accent.input} />}
/>

Props

defaultValue?
Type: string
Default: -
invalid?
Type: boolean
Default: false
onChange?
Type: (value: string) => void
Default: -
ref?
Type: Ref<HTMLInputElement>
Default: -
swatches?
Type: readonly ColorPickerSwatch[]
Default: -
type?
Type: string
Default: -
value?
Type: string
Default: -
PropTypeDefault
defaultValue?string-
invalid?booleanfalse
onChange?(value: string) => void-
ref?Ref<HTMLInputElement>-
swatches?readonly ColorPickerSwatch[]-
type?string-
value?string-

継承する属性(内部で固定するものを除く): InputHTMLAttributes<HTMLInputElement>

ラベルやプレースホルダーなど、このコンポーネントが描く文言は、propsで指定しないと文言辞書から読まれます。差し替え方は次を見てください: コンポーネントの文言

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。