Checkbox

Accept terms and conditions󰆘Enable notificationsReceive updates about releases󰆘CircularDisabled

가져오기

import { Checkbox } from "@pelagornis/page/components";

예제

위 미리보기는 이 파일을 렌더링한 것입니다. src/components/에 복사해서 시작하세요.

src/components/CheckboxExample.tsx

import { useState } from "react";
import { Checkbox, Stack } from "@pelagornis/page/components";

export default function CheckboxDemo() {
  const [notify, setNotify] = useState(true);

  return (
    <Stack gap="sizeSmall">
      <Checkbox label="Accept terms and conditions" />
      <Checkbox
        label="Enable notifications"
        description="Receive updates about releases"
        checked={notify}
        onChange={(event) => setNotify(event.target.checked)}
      />
      <Checkbox variant="circular" label="Circular" defaultChecked />
      <Checkbox label="Disabled" disabled />
    </Stack>
  );
}

MDX에서 사용

Checkbox 컴포넌트는 .mdx 페이지에 바로 쓸 수 있습니다. frontmatter 아래에서 가져오세요. 서버에서 렌더링되므로 client 지시어가 필요 없습니다.

src/content/docs/example.mdx

---
title: Example
---

import { Checkbox } from "@pelagornis/page/components";

<Checkbox label="Accept terms" description="Required to continue" />

Markdoc에서 사용

pageMarkdoc()가 이 컴포넌트의 checkbox 태그를 등록합니다. markdoc.config.mjs에 프리셋을 한 번 추가한 뒤(Markdoc에서 사용 참고), 어느 .mdoc 페이지에서나 태그를 쓰세요.

src/content/docs/example.mdoc

{% checkbox label="Accept terms" description="Required to continue" /%}

속성 이름과 값은 React props와 같습니다.

변형

각 variant prop에 넣을 수 있는 값입니다.

Prop	값
variant	default circular

구조

컴포넌트를 이루는 부분과 각 부분이 렌더링하는 data-refineui 역할입니다.

부분	역할
root	checkbox

키보드

포커스가 있을 때 컴포넌트가 처리하는 키입니다.

키	동작
Space	activate

참고

• 디자인 가이드와 토큰 상세는 RefineUI · Checkbox를 참고하세요.
• 공통 규칙은 MDX에서 사용과 Markdoc에서 사용을 참고하세요.