pantoken / renderers/tinymce/src / CssDocEntry

Interfaz: CssDocEntry ​

Un registro CSS documentado: su clase base más todo lo derivado del CSS + comentarios de documentación.

Propiedades ​

name ​

name: string

El nombre del registro desde @component/@utility/@rule/@declaration/@name, p. ej. button.

kind ​

kind: CssRecordKind

Qué tipo de superficie CSS documenta esto (por defecto component).

className ​

className: string

El selector CSS base — una clase (.button), atributo ([data-layout="x"]), ID (#foo), o pseudo del shadow-DOM (:host) — inferido desde la primera regla de clase desnuda o establecido explícitamente vía @selector. Siempre no vacío (cae a .${name} cuando la inferencia falla).

summary? ​

optional summary?: string

Resumen de una línea desde @summary.

remarks? ​

optional remarks?: string

Prosa extendida desde @remarks.

privateRemarks? ​

optional privateRemarks?: string

Prosa solo interna desde @privateRemarks (los emisores pueden omitirla en la salida pública).

releaseStage? ​

optional releaseStage?: CssReleaseStage

La fase de lanzamiento desde una etiqueta de modificador (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Versión en la que se introdujo, desde @since.

group? ​

optional group?: string

Un grupo/categoría de documentación, desde @group/@category.

accessibility? ​

optional accessibility?: string

Guía de accesibilidad, desde @a11y/@accessibility.

global? ​

optional global?: boolean

Se establece cuando este registro lleva una etiqueta @global — sus modificadores (y las banderas @global por modificador) se aplican a cualquier componente/layout/regla/declaración, no solo a la clase base de este registro. Usado durante validaciones y comprobaciones de consumo para resolver coincidencias de modificadores globalmente.

modifiers ​

modifiers: CssModifier[]

Modificadores extraídos del AST, anotados con prosa @modifier donde se autorizaron.

parts ​

parts: CssPart[]

Partes de sub-elementos extraídas del AST (basadas en clases), anotadas con prosa @part donde se autorizaron.

shadowParts ​

shadowParts: CssPart[]

Partes expuestas del Shadow-DOM (::part(name)), desde @csspart o un selector ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Pseudo-elementos nativos que estilizan el componente (::before, ::marker, …), desde @pseudo o un selector.

states ​

states: CssState[]

Estados a los que reacciona el componente, desde @cssstate, :state(), pseudo-clases o clases de estado.

slots ​

slots: CssSlot[]

Ranuras con nombre que expone la envoltura del componente, desde @slot.

elements? ​

optional elements?: CssElementConstraints

Elementos HTML permitidos desde @element (perfiles predeterminados + opcionales con nombre).

todos ​

todos: string[]

Notas internas pendientes, desde etiquetas @todo y comentarios inline /* @todo … */. Notas de desarrollo, no API pública — los emisores pueden omitirlas (como CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Tokens de diseño que consume este componente: cada propiedad personalizada --* referenciada vía var(...) dentro de sus reglas, cada una anotada con prosa @tokens donde se autorizaron (e incluyendo cualquier token declarado por @tokens no hallado literalmente vía var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Propiedades personalizadas que este componente declara (@property) o documenta (@cssproperty).

functions ​

functions: CssFunction[]

Funciones personalizadas CSS (@function) que este componente define.

animations ​

animations: CssAnimation[]

Animaciones (@keyframes) que expone este componente.

layers ​

layers: CssLayer[]

Capas de cascada (@layer) en las que participa este componente.

conditions ​

conditions: CssCondition[]

Bloques de soporte condicional (@container/@supports/@media) bajo los que se sitúan las reglas.

examples ​

examples: string[]

Bloques @example, literalmente.

structure? ​

optional structure?: StructureNode[]

El árbol de elementos @structure escrito (nodos de primer nivel), cuando está presente. Cuando el cuerpo @structure usa bloques @variant (ver structureVariants), esto contiene solo los nodos de la primera variante, para compatibilidad con código que aún no se ha actualizado para leer structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Formas DOM alternativas para este componente, cuando el cuerpo @structure escrito contiene una o más bloques @variant de primer nivel — ausente en el caso común de una estructura única, no variante.

structureDescription? ​

optional structureDescription?: string

Una descripción en prosa opcional que precede el cuerpo @structure, cuando está escrita.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Texto de reemplazo por deprecación a nivel de componente, cuando está escrito (el argumento de una etiqueta @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Prosa de uso desde @usage — cómo incluir la hoja de estilos / usar el componente.

annotations ​

annotations: CssAnnotation[]

Filas de leyenda de anotaciones locales desde @annotations, en orden del autor.

refs ​

refs: number[]

Referencias de anotaciones locales desde @ref, en orden del autor.

decorators ​

decorators: CssDecorator[]

Decoradores del modelo de objeto a nivel de registro.

compat ​

compat: string[]

Notas de compatibilidad/navegador / compatibilidad de características desde @compat.

related: CssRelated[]

Componentes relacionados desde @related.

memberOf? ​

optional memberOf?: CssMemberOf

Membresía de familia declarada desde @memberOf — este registro es miembro de otro registro nombrado, opcionalmente private (solo debe aparecer dentro de ese padre). Ausente cuando no está escrito.

members? ​

optional members?: string[]

Nombres de registros miembro desde @members — la dirección inversa, declarada en el padre.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Declaraciones estructuradas de miembros del lado del padre desde etiquetas repetidas @member.

source? ​

optional source?: CssSource

Dónde se autoró el registro, cuando la información de posición está disponible (para enlaces a la fuente).

customBlocks? ​

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

Contenido de las etiquetas personalizadas (de bloque) registradas, indexado por el nombre de la etiqueta sin su @. Poblado solo para etiquetas añadidas mediante la configuración; las etiquetas desconocidas no registradas se ignoran. Ausente cuando no se encontraron.