close

Callout theme-only

Компонент Callout используется для отображения выделенных информационных блоков, таких как советы, предупреждения и заметки.

Совет

Мы рекомендуем использовать синтаксис контейнера, который работает как в Markdown, так и в MDX-файлах.

Синтаксис контейнера

В большинстве случаев используйте синтаксис контейнера для создания callouts:

Отрендеренный результат
Синтаксис
Заметка

Это блок типа note

Совет

Это блок типа tip

Информация

Это блок типа info

Предупреждение

Это блок типа warning

Опасно

Это блок типа danger

Спойлер

Это блок типа details

Пользовательский заголовок

Это блок с пользовательским заголовком

Другой пользовательский заголовок

Это блок с другим пользовательским заголовком

Для получения дополнительной информации о синтаксисе контейнера см. Контейнер.

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

Вы также можете использовать компонент Callout непосредственно в MDX-файлах:

index.mdx
import { Callout } from '@rspress/core/theme-original';

<Callout type="tip">Это подсказка со стандартным заголовком</Callout>

<Callout type="warning" title="Предупреждение">
  Это предупреждение с пользовательским заголовком
</Callout>
Совет
Это подсказка со стандартным заголовком
Предупреждение

Это предупреждение с пользовательским заголовком

Настройка

Вы можете извлечь компонент Callout для настройки его стилей и поведения:

npx rspress eject Callout

Это скопирует компонент в theme/components/Callout. После настройки повторно экспортируйте его в вашем theme/index.tsx:

theme/index.tsx
export { Callout } from './components/Callout';
export * from '@rspress/core/theme-original';

Пропсы

interface CalloutProps {
  /**
   * Тип callout, который определяет его цвет и иконку.
   */
  type: 'tip' | 'note' | 'warning' | 'caution' | 'danger' | 'info' | 'details';
  /**
   * Пользовательский заголовок для callout. Если не указан, будет использован заглавный тип.
   */
  title?: string;
  /**
   * Содержимое для отображения внутри callout.
   */
  children: React.ReactNode;
}