pantoken / renderers/tinymce/src / CssDocEntry

Интерфейс: CssDocEntry ​

Одна документированная запись CSS: её базовый класс плюс всё, что выведено из CSS и комментариев документации.

Свойства ​

name ​

name: string

Имя записи из @component/@utility/@rule/@declaration/@name, например button.

kind ​

kind: CssRecordKind

Какого рода CSS‑поверхность документируется (по умолчанию component).

className ​

className: string

Базовый CSS‑селектор — класс (.button), атрибут ([data-layout="x"]), ID (#foo), или псевдо для shadow‑DOM (:host) — выводится из первого bare-class правила или задаётся явно через @selector. Всегда непустой (при неудаче вывод возвращается к .${name}).

summary? ​

optional summary?: string

Краткое однострочное резюме из @summary.

remarks? ​

optional remarks?: string

Расширенный прозаический текст из @remarks.

privateRemarks? ​

optional privateRemarks?: string

Только для внутреннего пользования — проза из @privateRemarks (эмиттеры могут опустить её в публичном выводе).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Стадия релиза из тега‑флага модификатора (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Версия, в которой введено, из @since.

group? ​

optional group?: string

Группа/категория документации, из @group/@category.

accessibility? ​

optional accessibility?: string

Рекомендации по доступности, из @a11y/@accessibility.

global? ​

optional global?: boolean

Устанавливается, когда эта запись имеет тег @global — её модификаторы (и флаги @global на модификатор) применяются к любому компоненту/макету/правилу/декларации, а не только к базовому классу записи. Используется при валидации и проверках потребления для разрешения соответствия модификаторов глобально.

modifiers ​

modifiers: CssModifier[]

Модификаторы, извлечённые из AST, с аннотацией прозаиком @modifier там, где она авторская.

parts ​

parts: CssPart[]

Подэлементы, извлечённые из AST (на основе классов), с аннотацией прозаиком @part там, где авторы её добавили.

shadowParts ​

shadowParts: CssPart[]

Exposed parts для shadow‑DOM (::part(name)), из @csspart или селектора ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Нативные псевдоэлементы, которыми компонент стилизует (::before, ::marker, …), из @pseudo или селектора.

states ​

states: CssState[]

Состояния, на которые реагирует компонент, из @cssstate, :state(), псевдо‑классов или класс‑состояний.

slots ​

slots: CssSlot[]

Именованные слоты, которые раскрывает оболочка компонента, из @slot.

elements? ​

optional elements?: CssElementConstraints

Разрешённые HTML‑элементы из @element (по умолчанию + опциональные именованные профили).

todos ​

todos: string[]

Внутренние заметки todo, из тегов @todo и inline‑комментариев /* @todo … */. Заметки разработки, не часть публичного API — эмиттеры могут их опустить (как CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Design‑токены, которые использует этот компонент: каждое пользовательское свойство --*, на которое есть ссылка через var(...) внутри его правил, каждое аннотированное прозаиком @tokens там, где авторы его добавили (и включая любые токены, объявленные через @tokens, которые не найдены буквально через var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Пользовательские свойства, которые объявляет этот компонент (@property) или документирует (@cssproperty).

functions ​

functions: CssFunction[]

CSS‑функции (custom functions) (@function), которые определяет этот компонент.

animations ​

animations: CssAnimation[]

Анимации (@keyframes), которые раскрывает этот компонент.

layers ​

layers: CssLayer[]

Слои каскада (cascade layers) (@layer), в которых участвует этот компонент.

conditions ​

conditions: CssCondition[]

Блоки условной поддержки (@container/@supports/@media), под которыми находятся правила.

examples ​

examples: string[]

Блоки @example, дословно.

structure? ​

optional structure?: StructureNode[]

Авторское дерево элементов @structure (узлы верхнего уровня), когда присутствует. Когда тело @structure использует блоки @variant (см. structureVariants), это содержит узлы только первого варианта, для обратной совместимости с кодом, который ещё не обновлён для чтения structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Альтернативные формы DOM для этого компонента, когда авторское тело @structure содержит один или более верхнеуровневых блоков @variant — отсутствует в обычном случае единственной, не‑вариантной структуры.

structureDescription? ​

optional structureDescription?: string

Опциональное прозаическое описание, предшествующее телу @structure, когда оно авторское.

demo? ​

optional demo?: string

@demo <spec> (e.g. self:button), when authored.

deprecated? ​

optional deprecated?: string

Текст замены при устаревании на уровне компонента, когда автор указан (аргумент тега @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Проза по использованию из @usage — как подключать таблицу стилей / использовать компонент.

annotations ​

annotations: CssAnnotation[]

Строки легенды локальных аннотаций из @annotations, в порядке автора.

refs ​

refs: number[]

Ссылки локальных аннотаций из @ref, в порядке автора.

decorators ​

decorators: CssDecorator[]

Декораторы объектной модели на уровне записи.

compat ​

compat: string[]

Заметки о поддержке в браузерах / совместимости функций из @compat.

related: CssRelated[]

Связанные компоненты из @related.

memberOf? ​

optional memberOf?: CssMemberOf

Заявленное членство в семействе из @memberOf — эта запись является членом другой именованной записи, опционально private (должно появляться только внутри родителя). Отсутствует, если не авторено.

members? ​

optional members?: string[]

Имена записей‑членов из @members — обратное направление, объявляемое на родителе.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Структурированные декларации членов со стороны родителя из повторяющихся тегов @member.

source? ​

optional source?: CssSource

Где запись была авторена, когда доступна информация о позиции (для ссылок на исходники).

customBlocks? ​

optional customBlocks?: Record<string, string[]>

Содержимое зарегистрированных пользовательских (блочных) тегов, индексируемое по имени тега без его @. Заполняется только для тегов, добавленных через конфигурацию; незарегистрированные неизвестные теги игнорируются. Отсутствует, если такие теги не найдены.