pantoken / renderers/tinymce/src / CssDocEntry

Arayüz: CssDocEntry ​

Belgelenmiş tek bir CSS kaydı: temel sınıfı ve CSS + dökümantasyon yorumlarından türetilen her şey.

Özellikler ​

name ​

name: string

@component/@utility/@rule/@declaration/@name içinden kayıt adı, örn. button.

kind ​

kind: CssRecordKind

Bu belgenin hangi tür CSS yüzeyini anlattığı (varsayılan component).

className ​

className: string

Temel CSS seçici — bir sınıf (.button), öznitelik ([data-layout="x"]), ID (#foo), veya shadow-DOM sözcüğü (:host) — ilk çıplak-sınıf kuralından türetilir veya açıkça @selector ile ayarlanır. Her zaman boş değildir (türetme başarısız olursa .${name}'e geri döner).

summary? ​

optional summary?: string

@summary'den tek satırlık özet.

remarks? ​

optional remarks?: string

@remarks'den genişletilmiş düzyazı.

privateRemarks? ​

optional privateRemarks?: string

@privateRemarks'den yalnızca dahili amaçlı düzyazı (emitörler bunu genel çıktıya dahil etmeyebilir).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Bir modifikatör bayrak etiketi (@alpha/@beta/@experimental/@internal/@public) tarafından belirtilen sürüm aşaması.

since? ​

optional since?: string

Tanıtıldığı sürüm, @since'den.

group? ​

optional group?: string

Bir belgelenme grubu/kategorisi, @group/@category'den.

accessibility? ​

optional accessibility?: string

Erişilebilirlik rehberi, @a11y/@accessibility'den.

global? ​

optional global?: boolean

Bu kaydın bir @global etiketi taşıdığı durumlarda ayarlanır — bunun modifikatörleri (ve modifikatör başına @global bayrakları) bir bileşen/yerleşim/kural/beyan için, sadece bu kaydın temel sınıfı için değil, tümü için geçerli olur. Doğrulama ve tüketim kontrolleri sırasında modifikatör eşleşmelerini küresel olarak çözmek için kullanılır.

modifiers ​

modifiers: CssModifier[]

AST'den çıkarılmış modifikatörler, yazıldıkları yerde @modifier düzyazısı ile notlandırılmış.

parts ​

parts: CssPart[]

AST'den çıkarılmış alt-eleman parçaları (sınıfa dayalı), yazıldıkları yerde @part düzyazısı ile notlandırılmış.

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM tarafından açığa çıkan parçalar (::part(name)), @csspart'den veya bir ::part() seçicisinden.

pseudoElements ​

pseudoElements: CssPseudoElement[]

Bileşenin stillerinin hedeflediği yerel pseödo-elementler (::before, ::marker, …), @pseudo'den veya bir seçiciden.

states ​

states: CssState[]

Bileşenin tepki verdiği durumlar, @cssstate, :state(), pseödo-sınıflar veya durum sınıflarından.

slots ​

slots: CssSlot[]

Bileşen kabuğunun açığa çıkardığı adlandırılmış slotlar, @slot'den.

elements? ​

optional elements?: CssElementConstraints

İzin verilen HTML öğeleri, @element'den (varsayılan + isteğe bağlı adlandırılmış profiller).

todos ​

todos: string[]

Dahili yapılacak notları, @todo etiketleri ve /* @todo … */ satır içi yorumlarından. Geliştirme notları, kamusal API değildir — emitörler bunları atlayabilir (ör. [CssDocEntry.privateRemarks]).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Bu bileşenin tükettiği tasarım tokenları: kurallarında var(...) ile başvurulan her --* özel değişkeni, her biri yazıldıkları yerde @tokens düzyazısı ile açıklanmış (ve herhangi bir @tokens ile ilân edilmiş ama var() ile kelimenin tam anlamıyla bulunmamış tokenlar dahil).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Bu bileşenin beyan ettiği (@property) veya belgelendirdiği (@cssproperty) özel değişkenler.

functions ​

functions: CssFunction[]

Bu bileşenin tanımladığı CSS özel fonksiyonları (@function).

animations ​

animations: CssAnimation[]

Bu bileşenin açığa çıkardığı animasyonlar (@keyframes).

layers ​

layers: CssLayer[]

Bu bileşenin yer aldığı cascade katmanları (@layer).

conditions ​

conditions: CssCondition[]

Kuralların altında bulunduğu koşullu-destek blokları (@container/@supports/@media).

examples ​

examples: string[]

@example blokları, olduğu gibi.

structure? ​

optional structure?: StructureNode[]

Yazılmış olan @structure öğe ağacı (üst düzey düğümler), mevcutsa. @structure gövdesi @variant blokları kullanıyorsa (bkz. [structureVariants]), bu burada yalnızca ilk varyantın düğümlerini tutar, henüz structureVariants okumak için güncellenmemiş kodla geriye dönük uyumluluk için.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Bu bileşen için alternatif DOM şekilleri, yazılmış @structure gövdesi bir veya daha fazla üst düzey @variant blok içerdiğinde — tek, varyant olmayan yapı için yoktur.

structureDescription? ​

optional structureDescription?: string

Yazılmışsa, @structure gövdesini başlatan isteğe bağlı bir düzyazı açıklaması.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Yazılmışsa bileşen düzeyinde kullanım dışı bırakma (deprecation) yerine koyma metni (bir @deprecated etiketinin argümanı).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

@usage'den kullanım düzyazısı — stil sayfasını nasıl dahil edeceğiniz / bileşeni nasıl kullanacağınız.

annotations ​

annotations: CssAnnotation[]

Yazar sırasıyla @annotations'den yerel açıklama efsane satırları.

refs ​

refs: number[]

Yazar sırasıyla @ref'den yerel açıklama referansları.

decorators ​

decorators: CssDecorator[]

Kayıt düzeyi nesne-modeli dekoratörleri.

compat ​

compat: string[]

@compat'den tarayıcı-destek / özellik-uyumluluk notları.

related: CssRelated[]

@related'den ilişkili bileşenler.

memberOf? ​

optional memberOf?: CssMemberOf

@memberOf'den beyan edilmiş aile üyeliği — bu kayıt başka bir adlandırılmış kaydın üyesidir, isteğe bağlı olarak private (sadece o üst öğe içinde görünebilir). Yazılmamışsa yoktur.

members? ​

optional members?: string[]

@members'den üye kayıt adları — üstte beyan edilen ters yön.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Tekrarlanan @member etiketlerinden yapılandırılmış ebeveyn-tarafı üye beyanları.

source? ​

optional source?: CssSource

Kayıdın nerede yazıldığı (konum bilgisi mevcutsa, kaynak bağlantıları için).

customBlocks? ​

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

Kayıtlı özel (blok) etiketlerin içeriği, etiket adının @ olmadan anahtarlanmış. Yalnızca yapılandırma yoluyla eklenen etiketler için doldurulur; kaydı olmayan bilinmeyen etiketler yoksayılır. Hiç bulunmazsa mevcut değildir.