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 中使用。