# Компоненты

Onedocs регистрирует набор компонентов Fumadocs UI для ваших файлов MDX, чтобы использовать их без импорта.

## Использование компонентов

Передайте `mdxComponents` содержимому MDX:

```tsx title="src/app/docs/[[...slug]]/page.tsx"
import { DocsPage, mdxComponents } from "onedocs";

// In your page component:
<MDX components={mdxComponents} />
```

`mdxComponents` содержит стандартные компоненты Fumadocs UI (заголовки с якорными ссылками, блоки кода, ссылки, изображения, таблицы, `Card`, `Cards` и `Callout`), а также `Tab`, `Tabs`, `Step`, `Steps`, `Accordion`, `Accordions`, `File`, `Folder`, `Files`, `ImageZoom` и `TypeTable`. Все приведенные ниже примеры работают без изменений.

## Информационные блоки

Выделяйте важную информацию. `type` принимает одно из значений: `info` (по умолчанию), `warn`, `error`, `success` или `idea`:

```mdx
<Callout type="info">
  This is an informational callout.
</Callout>

<Callout type="warn">
  This is a warning callout.
</Callout>

<Callout type="error">
  This is an error callout.
</Callout>
```

Добавьте заголовок с помощью `title`:

```mdx
<Callout type="warn" title="Breaking change">
  The `docs` option was removed in version 2.
</Callout>
```

## Вкладки

Организуйте содержимое по вкладкам. Каждый `Tab` `value` соответствует записи в `items`:

```mdx
<Tabs items={["npm", "yarn", "pnpm", "bun"]}>
  <Tab value="npm">npm install onedocs</Tab>
  <Tab value="yarn">yarn add onedocs</Tab>
  <Tab value="pnpm">pnpm add onedocs</Tab>
  <Tab value="bun">bun add onedocs</Tab>
</Tabs>
```

## Карточки

Ссылайтесь на другие страницы с помощью сетки карточек:

```mdx
<Cards>
  <Card title="Getting Started" href="/docs/getting-started">
    Learn how to set up Onedocs
  </Card>
  <Card title="Configuration" href="/docs/configuration">
    Configure your documentation
  </Card>
</Cards>
```

## Шаги

Покажите пронумерованные шаги:

```mdx
<Steps>
  <Step>Install Onedocs</Step>
  <Step>Create configuration</Step>
  <Step>Write documentation</Step>
</Steps>
```

## Аккордеон

Сворачиваемое содержимое для часто задаваемых вопросов и дополнительных сведений. Одновременно открыт только один элемент:

```mdx
<Accordions>
  <Accordion title="What is Onedocs?">
    Layouts, components and SEO helpers for documentation sites built with Next.js and Fumadocs.
  </Accordion>
  <Accordion title="How do I install it?">
    Follow the install step in Getting Started.
  </Accordion>
</Accordions>
```

## Файлы

Покажите деревья файлов:

```mdx
<Files>
  <Folder name="content" defaultOpen>
    <Folder name="docs" defaultOpen>
      <File name="index.mdx" />
      <File name="getting-started.mdx" />
    </Folder>
  </Folder>
  <File name="onedocs.config.ts" />
</Files>
```

## Масштабирование изображений

Изображение, которое при нажатии открывается в полном размере. Для изображений из `public/` обязательны `width` и `height`:

```mdx
<ImageZoom src="/screenshot.png" alt="Dashboard" width={1200} height={800} />
```

## Таблица типов

Описывайте свойства или параметры API:

```mdx
<TypeTable
  type={{
    title: {
      type: "string",
      description: "Site name shown in the navbar.",
    },
    description: {
      type: "string",
      description: "Used for meta tags and the home page.",
      default: "undefined",
    },
  }}
/>
```

## Другие компоненты

`InstallBlock` и `CodeBlock` из `onedocs` отсутствуют в `mdxComponents`. Чтобы использовать их в MDX, добавьте их в передаваемый объект:

```tsx title="src/app/docs/[[...slug]]/page.tsx"
import { CodeBlock, DocsPage, InstallBlock, mdxComponents } from "onedocs";

// In your page component:
<MDX components={{ ...mdxComponents, InstallBlock, CodeBlock }} />
```

Для всего остального импортируйте компонент из Fumadocs UI в файл MDX или добавьте его таким же способом:

```ts
import { Banner } from "fumadocs-ui/components/banner";
import { InlineTOC } from "fumadocs-ui/components/inline-toc";
```

Полный список см. в документации [Fumadocs](https://fumadocs.dev/docs/ui/components).