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, p.ex. button.

kind ​

kind: CssRecordKind

Que 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 sem prefixo ou definido explicitamente via @selector. Sempre não vazio (recuará para .${name} quando a inferência falhar).

summary? ​

optional summary?: string

Resumo em uma linha vindo de @summary.

remarks? ​

optional remarks?: string

Prosa estendida de @remarks.

privateRemarks? ​

optional privateRemarks?: string

Prosa apenas interna de @privateRemarks (emitters podem optar por omitir 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, de @since.

group? ​

optional group?: string

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

accessibility? ​

optional accessibility?: string

Orientações 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) se aplicam a qualquer componente/layout/regra/declaration, 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 autoria foi fornecida.

parts ​

parts: CssPart[]

Partes de sub-elementos extraídas do AST (baseadas em classe), anotadas com prosa @part quando autoria foi fornecida.

shadowParts ​

shadowParts: CssPart[]

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

pseudoElements ​

pseudoElements: CssPseudoElement[]

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

states ​

states: CssState[]

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

slots ​

slots: CssSlot[]

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

elements? ​

optional elements?: CssElementConstraints

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

todos ​

todos: string[]

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

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Tokens de design que este componente consome: toda propriedade customizada --* referenciada via var(...) dentro suas regras, cada uma anotada com prosa @tokens quando autoria foi fornecida (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 CSS customizadas (@function) que este componente define.

animations ​

animations: CssAnimation[]

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

layers ​

layers: CssLayer[]

Layers de cascade (@layer) em que este componente participa.

conditions ​

conditions: CssCondition[]

Blocos de suporte condicional (@container/@supports/@media) sob os quais as regras estão.

examples ​

examples: string[]

Blocos @example, literalmente.

structure? ​

optional structure?: StructureNode[]

A árvore de elementos @structure autoria (nós de nível superior), quando presente. Quando o corpo @structure usa blocos @variant (veja 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 DOM alternativas para este componente, quando o corpo @structure autoria contém um ou mais blocos @variant de nível superior — ausente no caso comum de uma única estrutura não-variant.

structureDescription? ​

optional structureDescription?: string

Uma descrição em prosa opcional que introduz o corpo @structure, quando autoria foi fornecida.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Texto de substituição de depreciação em nível de componente, quando autoria foi fornecida (o argumento para uma tag @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Prosa de uso de @usage — como incluir a stylesheet / 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-objeto ao nível do registro.

compat ​

compat: string[]

Notas de compatibilidade de navegador / recursos de @compat.

related: CssRelated[]

Componentes relacionados de @related.

memberOf? ​

optional memberOf?: CssMemberOf

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

members? ​

optional members?: string[]

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

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

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

source? ​

optional source?: CssSource

Onde o registro foi autoria, 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 registradas (do tipo bloco), 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.