pantoken / renderers/tinymce/src / CssDocEntry

Interface: CssDocEntry ​

Un enregistrement CSS documenté : sa classe de base plus tout ce qui est dérivé du CSS + des commentaires de doc.

Propriétés ​

name ​

name: string

Le nom de l'enregistrement issu de @component/@utility/@rule/@declaration/@name, p. ex. button.

kind ​

kind: CssRecordKind

Quel type de surface CSS ceci documente (par défaut component).

className ​

className: string

Le sélecteur CSS de base — une classe (.button), un attribut ([data-layout="x"]), un ID (#foo), ou un pseudo shadow-DOM (:host) — inféré depuis la première règle bare-class ou défini explicitement via @selector. Toujours non vide (retombe sur .${name} lorsque l'inférence échoue).

summary? ​

optional summary?: string

Résumé sur une ligne provenant de @summary.

remarks? ​

optional remarks?: string

Texte étendu provenant de @remarks.

privateRemarks? ​

optional privateRemarks?: string

Texte interne uniquement provenant de @privateRemarks (les émetteurs peuvent choisir de l'omettre de la sortie publique).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Le stade de publication provenant d'un tag de drapeau de modificateur (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Version d'introduction, depuis @since.

group? ​

optional group?: string

Un groupe/catégorie de documentation, depuis @group/@category.

accessibility? ​

optional accessibility?: string

Conseils d'accessibilité, depuis @a11y/@accessibility.

global? ​

optional global?: boolean

Défini lorsque cet enregistrement porte un tag @global — ses modificateurs (et les drapeaux @global par modificateur) s'appliquent à tout composant/mise en page/règle/déclaration, pas seulement à la classe de base de cet enregistrement. Utilisé lors des validations et des vérifications de consommation pour résoudre les correspondances de modificateurs globalement.

modifiers ​

modifiers: CssModifier[]

Modificateurs extraits de l'AST, annotés avec le texte @modifier quand rédigé.

parts ​

parts: CssPart[]

Sous-éléments extraits de l'AST (basés sur des classes), annotés avec le texte @part quand rédigé.

shadowParts ​

shadowParts: CssPart[]

Parts exposées du Shadow-DOM (::part(name)), provenant de @csspart ou d'un sélecteur ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Pseudo-éléments natifs que le composant stylise (::before, ::marker, …), depuis @pseudo ou un sélecteur.

states ​

states: CssState[]

États auxquels le composant réagit, depuis @cssstate, :state(), des pseudo-classes, ou des classes d'état.

slots ​

slots: CssSlot[]

Emplacements nommés (slots) que le shell du composant expose, depuis @slot.

elements? ​

optional elements?: CssElementConstraints

Éléments HTML autorisés depuis @element (profil par défaut + profils nommés optionnels).

todos ​

todos: string[]

Notes internes à faire, provenant des tags @todo et des commentaires inline /* @todo … */. Notes de développement, pas une API publique — les émetteurs peuvent les omettre (comme CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Tokens de design que ce composant consomme : chaque propriété personnalisée --* référencée via var(...) à l'intérieur de ses règles, chacune annotée avec le texte @tokens quand rédigé (et incluant tout token déclaré par @tokens non littéralement trouvé via var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Propriétés personnalisées que ce composant déclare (@property) ou documente (@cssproperty).

functions ​

functions: CssFunction[]

Fonctions personnalisées CSS (@function) que ce composant définit.

animations ​

animations: CssAnimation[]

Animations (@keyframes) exposées par ce composant.

layers ​

layers: CssLayer[]

Couches de cascade (@layer) auxquelles ce composant participe.

conditions ​

conditions: CssCondition[]

Blocs de support conditionnel (@container/@supports/@media) sous lesquels les règles sont placées.

examples ​

examples: string[]

Blocs @example, littéraux.

structure? ​

optional structure?: StructureNode[]

L'arbre d'éléments @structure rédigé (nœuds de premier niveau), lorsque présent. Quand le corps @structure utilise des blocs @variant (voir structureVariants), ceci contient uniquement les nœuds de la première variante, pour compatibilité arrière avec le code qui n'a pas été mis à jour pour lire structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Formes DOM alternatives pour ce composant, lorsque le corps @structure rédigé contient une ou plusieurs blocs @variant de premier niveau — absent dans le cas courant d'une structure unique, non-variant.

structureDescription? ​

optional structureDescription?: string

Une description en prose optionnelle précédant le corps @structure, lorsqu'elle est rédigée.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Texte de remplacement de mise en dépréciation au niveau composant, lorsqu'il est rédigé (l'argument d'un tag @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Texte d'utilisation provenant de @usage — comment inclure la feuille de style / utiliser le composant.

annotations ​

annotations: CssAnnotation[]

Lignes de légende d'annotation locale depuis @annotations, dans l'ordre de l'auteur.

refs ​

refs: number[]

Références d'annotation locale depuis @ref, dans l'ordre de l'auteur.

decorators ​

decorators: CssDecorator[]

Décorateurs du modèle-objet au niveau de l'enregistrement.

compat ​

compat: string[]

Notes de compatibilité/prise en charge du navigateur depuis @compat.

related: CssRelated[]

Composants liés depuis @related.

memberOf? ​

optional memberOf?: CssMemberOf

Appartenance déclarée à une famille depuis @memberOf — cet enregistrement est membre d'un autre enregistrement nommé, optionnellement private (ne doit apparaître qu'à l'intérieur de ce parent). Absent quand non rédigé.

members? ​

optional members?: string[]

Noms des enregistrements membres depuis @members — la direction inverse, déclarée sur le parent.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Déclarations structurées côté parent pour les membres depuis des tags @member répétés.

source? ​

optional source?: CssSource

Où l'enregistrement a été rédigé, lorsque l'information de position est disponible (pour des liens vers la source).

customBlocks? ​

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

Contenu des balises personnalisées (bloc) enregistrées, indexé par nom de balise sans son @. Rempli uniquement pour les balises ajoutées via la configuration ; les balises inconnues non enregistrées sont ignorées. Absent lorsqu'aucune n'a été trouvée.