RichText
Контейнер для текста из CMS сайта. Принимает HTML-строку или ReactNode и задаёт базовые стили вложенной разметке: обнуляет отступы абзацев и списков, подчёркивает ссылки и меняет их цвет при наведении, ограничивает ширину изображений. Шрифт и цвет текста наследуются от родителя.
HTML-строка перед вставкой очищается от XSS через DOMPurify: удаляются скрипты, обработчики событий, ссылки javascript:, стили и элементы форм. Подробности — в разделе Источник содержимого.
Когда использовать
- Заголовок, подзаголовок или описание секции сайта, где разметка приходит из CMS (ссылки, переносы, списки).
- Статья или текстовый блок с вложенными изображениями.
Когда не нужен:
- Обычный текст без разметки:
- используйте
@cloud-ru/ds-typography.
- используйте
- Отдельная ссылка:
- используйте
@cloud-ru/ds-link.
- используйте
Анатомия
Стили применяются к вложенным элементам:
p— без внешних отступов.a— подчёркивание, цвет текста родителя, при наведении —primary/text.ul,ol— без внешних отступов, отступ слеваprimitive/dimension/20.img— ширина не больше контейнера, отступ снизуprimitive/dimension/24(кроме последнего).
Источник содержимого (content)
-
string— HTML-разметка. Перед вставкой очищается через DOMPurify (isomorphic-dompurify), одинаково на сервере и в браузере. Удаляются:- скрипты, обработчики
on*, ссылкиjavascript:; - теги и атрибуты
style; - элементы форм;
- SVG и MathML.
Ссылкам с
targetдобавляетсяrel="noopener noreferrer": открытая страница не получает доступ кwindow.opener. - скрипты, обработчики
-
ReactNode— рендерится как дочерние элементы, без очистки: React сам экранирует текст.
Tag (default div)
Тег корневого элемента:
div— блок с абзацами, списками и изображениями.span— строчный элемент внутри абзаца или подписи.h1–h4— заголовок: разметка вставляется прямо в заголовок, без вложенной обёртки. Так рендерит заголовок@cloud-ru/ds-site-section-title.
Тег задаёт только семантику: стили заголовков браузера по умолчанию (жирное начертание, крупный кегль, отступы) сброшены. Типографику задаёт родитель или className.
В span и заголовки передавайте только строчную разметку (a, strong, em, br): абзацы и списки внутри них недопустимы по HTML.
Установка
pnpm add @cloud-ru/ds-site-rich-text
import { RichText } from '@cloud-ru/ds-site-rich-text'
Примеры использования
HTML-строка
Облачная платформа для разработки и запуска приложений.
import { RichText } from '@cloud-ru/ds-site-rich-text';
const HTML = '<p>Облачная платформа для <a href="https://cloud.ru">разработки и запуска</a> приложений.</p>';
export function HtmlString() {
return <RichText content={HTML} />;
}ReactNode
Облачная платформа для разработки и запуска приложений.
import { RichText } from '@cloud-ru/ds-site-rich-text';
export function ReactNodeContent() {
return (
<RichText
content={
<p>
Облачная платформа для <a href='https://cloud.ru'>разработки и запуска</a> приложений.
</p>
}
/>
);
}Списки
- Виртуальные машины
- Managed Kubernetes
- Создайте проект
- Подключите репозиторий
import { RichText } from '@cloud-ru/ds-site-rich-text';
const HTML = [
'<ul><li>Виртуальные машины</li><li>Managed Kubernetes</li></ul>',
'<ol><li>Создайте проект</li><li>Подключите репозиторий</li></ol>',
].join('');
export function Lists() {
return <RichText content={HTML} />;
}Props
Types
RichTextProps| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
className | string | — | no | CSS-класс корневого элемента. |
content | ReactNode | | no | Содержимое блока. - `string` — HTML-разметка. Перед вставкой очищается DOMPurify: удаляются скрипты, обработчики `on*`, ссылки `javascript:`, стили, элементы форм, SVG и MathML. - `ReactNode` — рендерится как дочерние элементы. |
data-test-id | string | — | no | |
tag | "div" | "h1" | "h2" | "h3" | "h4" | "span" | div | no | Тег корневого элемента. Задаёт только семантику: стили заголовков браузера по умолчанию сброшены, типографику задаёт родитель или `className`. В строчный элемент и заголовок передавайте только строчную разметку (`a`, `strong`, `em`, `br`): абзацы и списки внутри них недопустимы по HTML. |