Stepper

제목과 설명이 있는 번호 단계입니다.

InstallAdd the package
ConfigureRegister the plugin
WriteAdd pages

가져오기

import {
  Stepper,
  StepperList,
  StepperItem,
  StepperIndicator,
  StepperTitle,
  StepperDescription,
  StepperSeparator,
} from "@pelagornis/page/components";

예제

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

import { Fragment, useState } from "react";
import {
  Stepper,
  StepperDescription,
  StepperIndicator,
  StepperItem,
  StepperList,
  StepperSeparator,
  StepperTitle,
} from "@pelagornis/page/components";

const steps = [
  { title: "Install", description: "Add the package" },
  { title: "Configure", description: "Register the plugin" },
  { title: "Write", description: "Add pages" },
];

export default function StepperDemo() {
  const [step, setStep] = useState(1);

  return (
    <Stepper value={step} onValueChange={setStep} className="w-full">
      <StepperList>
        {steps.map((item, index) => (
          <Fragment key={item.title}>
            {index > 0 && <StepperSeparator />}
            <StepperItem value={index}>
              <StepperIndicator>{index + 1}</StepperIndicator>
              <StepperTitle>{item.title}</StepperTitle>
              <StepperDescription>{item.description}</StepperDescription>
            </StepperItem>
          </Fragment>
        ))}
      </StepperList>
    </Stepper>
  );
}

MDX에서 사용

Stepper 컴포넌트는 React 상태를 공유하는 여러 부분으로 이루어집니다. MDX에 적은 자식은 각각 별도의 아일랜드로 렌더링되어 부분끼리 서로 닿지 않습니다. 위 예제처럼 .tsx 파일에서 조합한 뒤 그 파일을 가져오세요.

---
title: Example
---

import StepperExample from "../../components/StepperExample";

<StepperExample client:load />

client:load는 페이지를 불러올 때 아일랜드를 하이드레이션합니다. 페이지 아래쪽에 있는 콘텐츠에는 client:visible을 쓰세요.

Markdoc에서 사용

Markdoc 태그는 Astro 컴포넌트를 렌더링하는데, 이 컴포넌트는 클라이언트 상태가 필요합니다. 예제를 하이드레이션하는 .astro 파일로 감싼 뒤, 그 파일을 태그로 등록하세요.

---
import StepperExample from "../StepperExample";
---

<StepperExample client:load />

import { component, defineMarkdocConfig } from "@astrojs/markdoc/config";
import starlightMarkdoc from "@astrojs/starlight-markdoc";
import pageMarkdoc from "@pelagornis/page/markdoc";

export default defineMarkdocConfig({
  extends: [starlightMarkdoc(), pageMarkdoc()],
  tags: {
    "stepper-example": {
      render: component("./src/components/markdoc/StepperExample.astro"),
      selfClosing: true,
    },
  },
});

{% stepper-example /%}

구조

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

부분	역할
`root`	stepper
`content`	stepper-content
`description`	stepper-description
`indicator`	stepper-indicator
`item`	stepper-item
`list`	stepper-list
`separator`	stepper-separator
`separator_fill`	stepper-separator-fill
`separator_rail`	stepper-separator-rail
`separator_track`	stepper-separator-track
`title`	stepper-title

상태

컴포넌트가 스타일을 적용하는 상태입니다. 컴포넌트 상태는 data 속성으로 드러납니다.

종류	상태
data-state	`complete` `current` `upcoming`

키보드

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

키	동작
`Enter`	activate
`Space`	activate

참고

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