Spin Button

増減ボタンを持つ数値入力です。

インポート

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

例

上のプレビューはこのファイルを描画したものです。src/components/ にコピーして使い始めてください。

import { useState } from "react";
import { SpinButton } from "@pelagornis/page/components";

export default function SpinButtonDemo() {
  const [quantity, setQuantity] = useState(2);

  return <SpinButton value={quantity} onChange={setQuantity} min={0} max={10} aria-label="Quantity" />;
}

MDX で使う

Spin Button は React の状態を共有する複数のパーツで構成されます。MDX に書いた子要素はそれぞれ別のアイランドとして描画されるため、パーツ同士がつながりません。上の例のように .tsx ファイルで組み立て、そのファイルをインポートしてください。

---
title: Example
---

import SpinButtonExample from "../../components/SpinButtonExample";

<SpinButtonExample client:load />

client:load はページの読み込み時にアイランドをハイドレートします。ページの下の方にあるコンテンツには client:visible を使ってください。

Markdoc で使う

Markdoc のタグは Astro コンポーネントを描画しますが、このコンポーネントにはクライアントの状態が必要です。例をハイドレートする .astro ファイルで包み、そのファイルをタグとして登録してください。

---
import SpinButtonExample from "../SpinButtonExample";
---

<SpinButtonExample 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: {
    "spin-button-example": {
      render: component("./src/components/markdoc/SpinButtonExample.astro"),
      selfClosing: true,
    },
  },
});

{% spin-button-example /%}

バリアント

各 variant prop が受け付ける値です。

Prop	値
`size`	`sm` `md` `lg`

構造

コンポーネントを構成するパーツと、それぞれが描画する data-refineui のロールです。

パーツ	ロール
`root`	spinbutton
`step`	spinbutton-step

状態

コンポーネントがスタイルを当てる状態です。コンポーネントの状態は data 属性として公開されます。

種類	状態
疑似クラス	`focus-visible`

参考

デザインのガイドとトークンの詳細は RefineUI · Spin Button を参照してください。
共通のルールは MDX で使うと Markdoc で使うを参照してください。