pantoken / renderers/tinymce/src / CssDocEntry

Διεπαφή: CssDocEntry ​

Ένα τεκμηριωμένο CSS record: η βασική κλάση του και όλα όσα προέρχονται από το CSS + τα σχόλια τεκμηρίωσης.

Ιδιότητες ​

name ​

name: string

Το όνομα του record από @component/@utility/@rule/@declaration/@name, π.χ. button.

kind ​

kind: CssRecordKind

Τι είδους επιφάνεια CSS τεκμηριώνει αυτό (προεπιλογή component).

className ​

className: string

Ο βασικός CSS selector — μια κλάση (.button), ένα attribute ([data-layout="x"]), ένα ID (#foo), ή ψευδο-στοιχείο shadow-DOM (:host) — προκύπτει από τον πρώτο bare-class κανόνα ή ορίζεται ρητά μέσω @selector. Πάντα μη-κενό (επιστρέφει σε .${name} όταν η επαγωγή αποτύχει).

summary? ​

optional summary?: string

Μονοσέλιδη περίληψη από @summary.

remarks? ​

optional remarks?: string

Εκτεταμένη πρόζα από @remarks.

privateRemarks? ​

optional privateRemarks?: string

Πρόζα μόνο για εσωτερική χρήση από @privateRemarks (οι emitters μπορεί να επιλέξουν να την παραλείψουν από την δημόσια έξοδο).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Το στάδιο κυκλοφορίας από ετικέτα flag modifier (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Η έκδοση που εισήχθη, από @since.

group? ​

optional group?: string

Μια ομάδα/κατηγορία τεκμηρίωσης, από @group/@category.

accessibility? ​

optional accessibility?: string

Κατευθύνσεις προσβασιμότητας, από @a11y/@accessibility.

global? ​

optional global?: boolean

Ορίζεται όταν αυτό το record φέρει ετικέτα @global — οι modifier του (και ανά-modifier @global flags) εφαρμόζονται σε οποιοδήποτε component/layout/rule/declaration, όχι μόνο στη βασική κλάση αυτού του record. Χρησιμοποιείται κατά τους ελέγχους επικύρωσης και κατανάλωσης για την επίλυση ταιριασμάτων modifier παγκοσμίως.

modifiers ​

modifiers: CssModifier[]

Modifiers εξαγόμενοι από AST, σχολιασμένοι με @modifier πρόζα όπου έχουν γραφτεί.

parts ​

parts: CssPart[]

Υπο-στοιχειώδεις (sub-element) μέρη εξαγόμενα από AST (με βάση κλάσεις), σχολιασμένα με @part πρόζα όπου έχουν γραφτεί.

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM exposed parts (::part(name)), από @csspart ή έναν selector ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Φυσικά ψευδο-στοιχεία που στιλιζούν το component (::before, ::marker, …), από @pseudo ή έναν selector.

states ​

states: CssState[]

Καταστάσεις στις οποίες αντιδρά το component, από @cssstate, :state(), ψευδο-κλάσεις ή κλάσεις κατάστασης.

slots ​

slots: CssSlot[]

Ονοματισμένα slots που εκθέτει το component shell, από @slot.

elements? ​

optional elements?: CssElementConstraints

Επιτρεπόμενα HTML στοιχεία από @element (προεπιλογή + προαιρετικά ονοματισμένα προφίλ).

todos ​

todos: string[]

Εσωτερικές σημειώσεις to-do, από ετικέτες @todo και inline σχόλια /* @todo … */. Σημειώσεις ανάπτυξης, όχι δημόσιο API — οι emitters μπορεί να τις παραλείψουν (όπως CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Design tokens που καταναλώνει αυτό το component: κάθε --* custom property που αναφέρεται μέσω var(...) μέσα στους κανόνες του, κάθε ένα σχολιασμένο με @tokens πρόζα όπου έχει γραφτεί (και περιλαμβάνοντας οποιοδήποτε @tokens-δηλωμένο token που δεν βρέθηκε κυριολεκτικά μέσω var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Custom properties που δηλώνει (@property) ή τεκμηριώνει (@cssproperty) αυτό το component.

functions ​

functions: CssFunction[]

CSS custom functions (@function) που ορίζει αυτό το component.

animations ​

animations: CssAnimation[]

Κινήσεις/animations (@keyframes) που εκθέτει αυτό το component.

layers ​

layers: CssLayer[]

Cascade layers (@layer) στις οποίες συμμετέχει αυτό το component.

conditions ​

conditions: CssCondition[]

Μπλοκ υποστήριξης με όρους (@container/@supports/@media) κάτω από τα οποία βρίσκονται οι κανόνες.

examples ​

examples: string[]

Μπλοκ @example, όπως είναι (verbatim).

structure? ​

optional structure?: StructureNode[]

Το γραμμένο δέντρο στοιχείων @structure (κορυφαίοι κόμβοι), όταν υπάρχει. Όταν το σώμα @structure χρησιμοποιεί @variant μπλοκ (βλ. structureVariants), αυτό περιέχει μόνο τους κόμβους της πρώτης παραλλαγής, για συμβατότητα προς τα πίσω με κώδικα που δεν έχει ενημερωθεί για να διαβάζει structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Εναλλακτικά σχήματα DOM για αυτό το component, όταν το γραμμένο σώμα @structure περιέχει ένα ή περισσότερα κορυφαία @variant μπλοκ — απουσιάζει στην κοινή περίπτωση ενός μοναδικού, μη-παραλλαγμένου structure.

structureDescription? ​

optional structureDescription?: string

Προαιρετική περιγραφική πρόζα που προηγείται του σώματος @structure, όταν έχει γραφτεί.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Κείμενο αντικατάστασης αποσυρμένης λειτουργίας σε επίπεδο component, όταν έχει γραφτεί (το όρισμα σε μια ετικέτα @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Πρόζα χρήσης από @usage — πώς να συμπεριλάβετε το stylesheet / να χρησιμοποιήσετε το component.

annotations ​

annotations: CssAnnotation[]

Γραμμές τοπικού λεξικού σχολιασμών από @annotations, με την σειρά του συντάκτη.

refs ​

refs: number[]

Τοπικές αναφορές σχολιασμών από @ref, με την σειρά του συντάκτη.

decorators ​

decorators: CssDecorator[]

Διακοσμητές (decorators) του αντικειμενοστραφούς μοντέλου σε επίπεδο record.

compat ​

compat: string[]

Σημειώσεις υποστήριξης φυλλομετρητή / συμβατότητας χαρακτηριστικών από @compat.

related: CssRelated[]

Σχετικά components από @related.

memberOf? ​

optional memberOf?: CssMemberOf

Δηλωμένη συμμετοχή σε οικογένεια από @memberOf — αυτό το record είναι μέλος ενός άλλου ονοματισμένου record, προαιρετικά private (πρέπει να εμφανίζεται μόνο μέσα σε εκείνο το parent). Απουσιάζει όταν δεν έχει γραφτεί.

members? ​

optional members?: string[]

Ονόματα member records από @members — η αντίθετη κατεύθυνση, δηλωμένη στο parent.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Δομημένες δηλώσεις μελών από την πλευρά του γονέα, από επαναλαμβανόμενες ετικέτες @member.

source? ​

optional source?: CssSource

Πού γράφτηκε το record, όταν οι πληροφορίες θέσης είναι διαθέσιμες (για συνδέσμους πηγής).

customBlocks? ​

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

Περιεχόμενο των καταχωρημένων προσαρμοσμένων (block) ετικετών, ευρετηριασμένο με το όνομα της ετικέτας χωρίς το @. Γεμίζεται μόνο για eτικέτες που προστέθηκαν μέσω διαμόρφωσης; οι μη καταχωρημένες άγνωστες ετικέτες αγνοούνται. Απουσιάζει όταν δεν βρέθηκε καμία.