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) — виводиться з першого правила з голим класом або задається явно через @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[]

Частини, що виставляються 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 … */. Нотатки для розробки, не публічний API — еміттери можуть їх опускати (як CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Дизайн-токени, які споживає цей компонент: кожна кастомна властивість --*, посилана через var(...) всередині його правил, кожна анотована прозою @tokens там, де автори її додали (і включаючи будь-який токен, оголошений через @tokens, який не був буквально знайдений через var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Користувацькі властивості, які цей компонент оголошує (@property) або документує (@cssproperty).

functions ​

functions: CssFunction[]

CSS-користувацькі функції (@function), які визначає цей компонент.

animations ​

animations: CssAnimation[]

Анімації (@keyframes), які відкриває цей компонент.

layers ​

layers: CssLayer[]

Шари каскаду (@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[]>

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