Box

Surface box with large padding

Outlined section

インポート

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

例

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

src/components/BoxExample.tsx

import { Box, Stack, Text } from "@pelagornis/page/components";

export default function BoxDemo() {
  return (
    <Stack gap="sizeMedium" className="w-full">
      <Box padding="sizeLarge" background="backgroundSurface" radius="roundedLarge">
        <Text variant="bodyMd">Surface box with large padding</Text>
      </Box>
      <Box
        as="section"
        paddingX="sizeLarge"
        paddingY="sizeSmall"
        border="strokeWidthThin"
        borderColor="borderDefault"
        radius="roundedLarge"
      >
        <Text variant="bodyMd">Outlined section</Text>
      </Box>
    </Stack>
  );
}

MDX で使う

Box は .mdx ページにそのまま書けます。frontmatter の下でインポートしてください。サーバーで描画されるので、client ディレクティブは要りません。

src/content/docs/example.mdx

---
title: Example
---

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

<Box padding="sizeLarge" background="backgroundSurface" radius="roundedLarge">
  Surface box
</Box>

Markdoc で使う

pageMarkdoc() がこのコンポーネントの box タグを登録します。markdoc.config.mjs にプリセットを一度追加すれば（Markdoc で使うを参照）、どの .mdoc ページでもタグを書けます。

src/content/docs/example.mdoc

{% box padding="sizeLarge" background="backgroundSurface" radius="roundedLarge" %}
Surface box
{% /box %}

属性の名前と値は React の props と同じです。

構造

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

パーツ	ロール
root	box

参考

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