Taster

진단부품톤 고르기
부품 갤러리 / Checkbox group

Checkbox group

Form and input

On state fills with the accent token; labels are part of the control so the whole row is the hit area.

내 사이트에서 가져오기

색을 고르면 아래 부품이 그 색으로 바뀝니다.

실제로 돌아가는 부품입니다. 눌러 보고 입력해 보세요.

내 앱에 넣기

  1. 아직 npm 패키지가 없어서 Taster 리포를 받아 그 안의 명령을 씁니다. 내 앱 폴더가 들어 있는 폴더에서 한 번만 받습니다.

    git clone https://github.com/makim-414/taster.git && npm ci --prefix taster/packages/engine
  2. 내 앱 폴더에서 이 부품을 넣습니다. 부품 파일과 토큰 파일이 src/components/taster 에 들어갑니다.

    node ../taster/packages/engine/cli.mjs add blocks/checkbox-group --from https://taster-six.vercel.app --dir src/components/taster
  3. 부품은 Tailwind 클래스로 그리고, Taster 프리셋이 그 클래스를 토큰에 연결합니다. Tailwind CSS 를 설치하고, tokens.css 를 앱 루트에서 한 번 불러온 뒤, 앱 루트에 이 설정을 둡니다. 프리셋이 없으면 빌드는 되어도 부품이 스타일 없이 나옵니다.

    // tailwind.config.cjs
    module.exports = {
      presets: [require('./src/components/taster/tailwind-preset.cjs')],
      content: ['./index.html', './src/**/*.{ts,tsx}'],
    };

    Tailwind v3 는 이 파일을 그대로 읽습니다. v4 는 Tailwind 를 불러오는 src/ 의 스타일시트 맨 위에 이 두 줄을 넣습니다.

    @import "tailwindcss";
    @config "../tailwind.config.cjs";

    tokens.css 는 :root 에 --bg, --text, --border, --accent 를 정의합니다. 내 앱의 스타일시트가 같은 이름을 뒤에서 다시 정의하면 그쪽 색이 이깁니다. 새 Vite 앱의 스타터 CSS 처럼 그런 변수가 있으면 지우거나 이름을 바꾸세요.

언제 쓰나요

  • Checkbox and switchOn state fills with the accent token; labels are part of the control so the whole row is the hit area.

정보

설치할 패키지
tailwindcss
라이선스
MIT
코드 보기
'use client'

import * as React from 'react'
import { cn } from './_cn'

// CheckboxGroup. A fieldset of checkboxes with an optional "select all" row that shows the mixed state
// (aria-checked="mixed" through the native indeterminate flag). On state fills with the accent token; each label is
// the hit area. Use it when several values can be kept at once; for one of many use RadioGroup.

export interface CheckboxOption {
  value: string
  label: React.ReactNode
  description?: React.ReactNode
  disabled?: boolean
}

export interface CheckboxGroupProps extends Omit<React.FieldsetHTMLAttributes<HTMLFieldSetElement>, 'onChange'> {
  legend: React.ReactNode
  options: CheckboxOption[]
  value: string[]
  onValueChange: (value: string[]) => void
  /** Adds a parent checkbox that selects or clears every enabled option. */
  selectAllLabel?: string
  hint?: React.ReactNode
}

function Box({ state, disabled }: { state: 'on' | 'off' | 'mixed'; disabled?: boolean }) {
  return (
    <span
      aria-hidden="true"
      className={cn(
        'mt-0.5 flex size-4 shrink-0 items-center justify-center rounded-sm border transition-colors duration-press',
        'peer-focus-visible:ring-2 peer-focus-visible:ring-ring',
        disabled && 'opacity-50',
        state === 'off' ? 'border-border-input bg-transparent text-transparent' : 'border-transparent bg-accent text-accent-fg',
      )}
    >
      <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth={2.25} strokeLinecap="round" strokeLinejoin="round" className="size-3">
        {state === 'mixed' ? <path d="M6 12h12" /> : <path d="M5 13l4 4 10-10" />}
      </svg>
    </span>
  )
}

function Row({
  id,
  checked,
  mixed,
  disabled,
  onChange,
  label,
  description,
  strong,
}: {
  id: string
  checked: boolean
  mixed?: boolean
  disabled?: boolean
  onChange: (checked: boolean) => void
  label: React.ReactNode
  description?: React.ReactNode
  strong?: boolean
}) {
  const ref = React.useRef<HTMLInputElement>(null)
  React.useEffect(() => {
    if (ref.current) ref.current.indeterminate = Boolean(mixed)
  }, [mixed])
  return (
    <label
      htmlFor={id}
      className={cn(
        'flex min-h-11 select-none items-start gap-3 py-2.5 text-sm desk:min-h-0 desk:py-1.5',
        // A disabled row keeps readable text (the reason is often in the description); only the box fades.
        disabled ? 'cursor-not-allowed' : 'cursor-pointer',
      )}
    >
      <input
        ref={ref}
        id={id}
        type="checkbox"
        checked={checked}
        disabled={disabled}
        onChange={(e) => onChange(e.target.checked)}
        className="peer sr-only"
      />
      <Box state={mixed ? 'mixed' : checked ? 'on' : 'off'} disabled={disabled} />
      <span className="flex min-w-0 flex-col gap-0.5">
        <span className={cn(disabled ? 'text-text-muted' : 'text-text', strong && 'font-medium')}>{label}</span>
        {description && <span className="text-label text-text-muted">{description}</span>}
      </span>
    </label>
  )
}

export function CheckboxGroup({
  legend,
  options,
  value,
  onValueChange,
  selectAllLabel,
  hint,
  className,
  ...props
}: CheckboxGroupProps) {
  const reactId = React.useId()
  const hintId = hint ? `cbg-${reactId}-hint` : undefined
  const enabled = options.filter((o) => !o.disabled).map((o) => o.value)
  const chosen = enabled.filter((v) => value.includes(v))
  const all = enabled.length > 0 && chosen.length === enabled.length
  const some = chosen.length > 0 && !all

  return (
    <fieldset className={cn('m-0 min-w-0 border-0 p-0', className)} aria-describedby={hintId} {...props}>
      <legend className="mb-2 p-0 text-sm font-medium text-text">{legend}</legend>
      {hint && (
        <p id={hintId} className="-mt-1 mb-2 text-label text-text-muted">
          {hint}
        </p>
      )}
      {selectAllLabel && (
        <div className="border-b border-border">
          <Row
            id={`cbg-${reactId}-all`}
            checked={all}
            mixed={some}
            onChange={() => {
              const keepDisabled = value.filter((v) => !enabled.includes(v))
              onValueChange(all ? keepDisabled : [...keepDisabled, ...enabled])
            }}
            label={selectAllLabel}
            strong
          />
        </div>
      )}
      <div className={cn('flex flex-col', selectAllLabel && 'pl-7')}>
        {options.map((o) => (
          <Row
            key={o.value}
            id={`cbg-${reactId}-${o.value}`}
            checked={value.includes(o.value)}
            disabled={o.disabled}
            onChange={(on) => onValueChange(on ? [...value, o.value] : value.filter((v) => v !== o.value))}
            label={o.label}
            description={o.description}
          />
        ))}
      </div>
    </fieldset>
  )
}