Label

Name *

Large labelDisabled label

导入

import { Label, LabelRequired } from "@pelagornis/page/components";

示例

上方预览渲染的就是这个文件。把它复制到 src/components/ 即可开始使用。

src/components/LabelExample.tsx

import { Input, Label, LabelRequired, Stack } from "@pelagornis/page/components";

export default function LabelDemo() {
  return (
    <Stack gap="sizeLarge" className="w-full max-w-sm">
      <Stack gap="sizeXSmall">
        <Label htmlFor="label-name">
          Name <LabelRequired />
        </Label>
        <Input id="label-name" placeholder="Jane Doe" fullWidth />
      </Stack>
      <Label size="lg">Large label</Label>
      <Label disabled>Disabled label</Label>
    </Stack>
  );
}

在 MDX 中使用

Label 可以直接写在 .mdx 页面中。在 frontmatter 下方导入即可。它在服务器端渲染，不需要 client 指令。

src/content/docs/example.mdx

---
title: Example
---

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

<Label htmlFor="email" required>Email address</Label>

在 Markdoc 中使用

pageMarkdoc() 会为这个组件注册 label 标签。在 markdoc.config.mjs 中添加一次预设（见在 Markdoc 中使用），就能在任意 .mdoc 页面中使用该标签。

src/content/docs/example.mdoc

{% label htmlFor="email" required=true %}Email address{% /label %}

属性的名称和取值与 React props 相同。

变体

每个 variant prop 可接受的取值。

Prop	取值
size	sm md lg

结构

组件的组成部分，以及每个部分渲染的 data-refineui 角色。

部件	角色
root	label
required	label-required

参考

• 设计指南和令牌细节见 RefineUI · Label。
• 通用规则见在 MDX 中使用和在 Markdoc 中使用。