pantoken / renderers/tinymce/src / CssDocEntry

Interface: CssDocEntry ​

Um registro CSS documentado: sua classe base mais tudo derivado do CSS + comentários de documentação.

Propriedades ​

name ​

name: string

O nome do registro de @component/@utility/@rule/@declaration/@name, por exemplo button.

kind ​

kind: CssRecordKind

Qual tipo de superfície CSS isto documenta (padrão: component).

className ​

className: string

O seletor CSS base — uma classe (.button), atributo ([data-layout="x"]), ID (#foo), ou pseudo do shadow-DOM (:host) — inferido a partir da primeira regra de classe simples ou definido explicitamente via @selector. Sempre não vazio (usa .${name} como fallback quando a inferência falha).

summary? ​

optional summary?: string

Resumo de uma linha de @summary.

remarks? ​

optional remarks?: string

Texto extenso de @remarks.

privateRemarks? ​

optional privateRemarks?: string

Texto interno-only de @privateRemarks (os emissores podem optar por omiti-lo da saída pública).

releaseStage? ​

optional releaseStage?: CssReleaseStage

O estágio de lançamento a partir de uma tag de flag de modificador (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Versão em que foi introduzido, a partir de @since.

group? ​

optional group?: string

Um grupo/categoria de documentação, de @group/@category.

accessibility? ​

optional accessibility?: string

Orientação de acessibilidade, de @a11y/@accessibility.

global? ​

optional global?: boolean

Definido quando este registro carrega uma tag @global — seus modificadores (e por-modificador as flags @global) aplicam-se a qualquer componente/layout/regra/declaracao, não apenas à classe base deste registro. Usado durante validações e verificações de consumo para resolver correspondências de modificadores globalmente.

modifiers ​

modifiers: CssModifier[]

Modificadores extraídos do AST, anotados com prosa @modifier quando escritos.

parts ​

parts: CssPart[]

Partes de sub-elemento extraídas do AST (baseadas em classe), anotadas com prosa @part quando escritas.

shadowParts ​

shadowParts: CssPart[]

Parts expostas do Shadow-DOM (::part(name)), a partir de @csspart ou um seletor ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Pseudo-elementos nativos que o componente estiliza (::before, ::marker, …), a partir de @pseudo ou um seletor.

states ​

states: CssState[]

Estados aos quais o componente reage, a partir de @cssstate, :state(), pseudo-classes ou classes de estado.

slots ​

slots: CssSlot[]

Slots nomeados que o invólucro do componente expõe, a partir de @slot.

elements? ​

optional elements?: CssElementConstraints

Elementos HTML permitidos de @element (perfil padrão + perfis nomeados opcionais).

todos ​

todos: string[]

Notas internas de tarefas, de tags @todo e comentários inline /* @todo … */. Notas de desenvolvimento, não API pública — emissores podem omiti-las (como CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Tokens de design que este componente consome: toda propriedade customizada --* referenciada via var(...) dentro das suas regras, cada uma anotada com prosa @tokens quando escrita (e incluindo qualquer token declarado por @tokens que não seja literalmente encontrado via var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Propriedades customizadas que este componente declara (@property) ou documenta (@cssproperty).

functions ​

functions: CssFunction[]

Funções customizadas de CSS (@function) que este componente define.

animations ​

animations: CssAnimation[]

Animações (@keyframes) que este componente expõe.

layers ​

layers: CssLayer[]

Camadas de cascade (@layer) nas quais este componente participa.

conditions ​

conditions: CssCondition[]

Blocos de suporte condicional (@container/@supports/@media) sob os quais as regras se situam.

examples ​

examples: string[]

Blocos @example, verbatim.

structure? ​

optional structure?: StructureNode[]

A árvore de elementos @structure escrita (nós de topo), quando presente. Quando o corpo @structure usa blocos @variant (ver structureVariants), isto contém apenas os nós da primeira variante, para compatibilidade retroativa com qualquer código que não tenha sido atualizado para ler structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Formas alternativas do DOM para este componente, quando o corpo @structure escrito contém um ou mais blocos de topo @variant — ausente no caso comum de uma única estrutura não-variant.

structureDescription? ​

optional structureDescription?: string

Uma descrição em prosa opcional que lidera o corpo @structure, quando escrita.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Texto de substituição por deprecação em nível de componente, quando escrito (o argumento de uma tag @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Prosa de uso de @usage — como incluir a folha de estilos / usar o componente.

annotations ​

annotations: CssAnnotation[]

Linhas da legenda de anotações locais de @annotations, na ordem do autor.

refs ​

refs: number[]

Referências de anotações locais de @ref, na ordem do autor.

decorators ​

decorators: CssDecorator[]

Decoradores do modelo de objeto ao nível do registro.

compat ​

compat: string[]

Notas de suporte/compatibilidade de recursos de navegadores de @compat.

related: CssRelated[]

Componentes relacionados de @related.

memberOf? ​

optional memberOf?: CssMemberOf

Membro de família declarado a partir de @memberOf — este registro é membro de outro registro nomeado, opcionalmente private (deve aparecer apenas dentro daquele pai). Ausente quando não escrito.

members? ​

optional members?: string[]

Nomes de registros membros de @members — a direção inversa, declarada no pai.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Declarações estruturadas do lado do pai sobre membros a partir de tags @member repetidas.

source? ​

optional source?: CssSource

Onde o registro foi escrito, quando informações de posição estão disponíveis (para links de origem).

customBlocks? ​

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

Conteúdo das tags personalizadas (bloco) registradas, indexado pelo nome da tag sem seu @. Preenchido apenas para tags adicionadas via configuração; tags desconhecidas não registradas são ignoradas. Ausente quando nenhuma for encontrada.