pantoken / renderers/tinymce/src / CssDocEntry

Viðmót: CssDocEntry ​

Eitt skjalfest CSS-skjal: grunnflokkur þess auk alls sem er afleitt frá CSS + skjalatextum.

Eiginleikar ​

name ​

name: string

Heiti skraðarinnar úr @component/@utility/@rule/@declaration/@name, t.d. button.

kind ​

kind: CssRecordKind

Hvaða tegund af CSS-viðmóti þetta skjalfestar (sjálfgefið component).

className ​

className: string

Grunn CSS-valkosti — klasi (.button), eign ([data-layout="x"]), auðkenni (#foo), eða shadow-DOM pseudo (:host) — ályktað frá fyrstu beru-klasa reglu eða stillt sérstaklega með @selector. Að eilífu ekki tómt (fellur aftur á .${name} ef ályktun mistakast).

summary? ​

optional summary?: string

Einalínusamantekt úr @summary.

remarks? ​

optional remarks?: string

Útvíkkuð ritsmíðartexti úr @remarks.

privateRemarks? ​

optional privateRemarks?: string

Innri ritsmíðartexti eingöngu úr @privateRemarks (útgefarar geta valið að sleppa því frá opinberum úttaki).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Útgáfustigið úr breytingamerki (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Útgáfa þar sem það var kynnt, úr @since.

group? ​

optional group?: string

Skjalahópur/flokkur, úr @group/@category.

accessibility? ​

optional accessibility?: string

Leiðbeiningar um aðgengi, úr @a11y/@accessibility.

global? ​

optional global?: boolean

Stillt þegar þessi skrá ber @global merkimiða — breytur hennar (og fyrir-breyti @global fánar) gilda um hvaða íhlut/uppsetningu/reglu/yfirlýsingu sem er, ekki aðeins grunnflokk þessarar skrár. Notað við staðfestingu og neysluathuganir til að leysa breytusamsvörun á heimsvísu.

modifiers ​

modifiers: CssModifier[]

Breytingar unnar úr AST, merktar með @modifier ritsmíða þar sem þær voru skrifaðar.

parts ​

parts: CssPart[]

Undir-þáttaskiptingar úr AST (klassabundnar), merktar með @part ritsmíða þar sem þær voru skrifaðar.

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM sýnilegar parts (::part(name)), úr @csspart eða ::part() valkosti.

pseudoElements ​

pseudoElements: CssPseudoElement[]

Innbyggðir pseudo-þættir sem íhluturinn stílar (::before, ::marker, …), úr @pseudo eða valkosti.

states ​

states: CssState[]

Stöður sem íhluturinn bregst við, úr @cssstate, :state(), pseudo-flokkum eða stöðuflokkum.

slots ​

slots: CssSlot[]

Nefndar slotur sem íhlutarstykkið opnar, úr @slot.

elements? ​

optional elements?: CssElementConstraints

Leyfilegir HTML-þættir frá @element (sjálfgefið + valfrjáls nefnd sniðmát).

todos ​

todos: string[]

Innri „to-do“ athugasemdir, úr @todo merkjum og /* @todo … */ innfelldum athugasemdum. Þróunarnótur, ekki opinbert API — útgefarar geta sleppt þeim (eins og CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Hönnunarmerki sem þessi íhlutur notar: hver --* sérsniðin eign sem vísað er til með var(...) innan reglna hans, hver merkt með @tokens ritsmíða þar sem skrifað (og þar með taldar þær @tokens-tilkynntu merki sem ekki finnast bókstaflega með var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Sérsniðnar eignir sem þessi íhlutur tilkynnir (@property) eða skjalfestar (@cssproperty).

functions ​

functions: CssFunction[]

CSS sérsniðnar föll (@function) sem þessi íhlutur skilgreinir.

animations ​

animations: CssAnimation[]

Sýningar (animations) (@keyframes) sem þessi íhlutur opnar.

layers ​

layers: CssLayer[]

Cascade-lög (@layer) sem þessi íhlutur tekur þátt í.

conditions ​

conditions: CssCondition[]

Skilyrtar stuðningsblokkir (@container/@supports/@media) sem reglurnar eru undir.

examples ​

examples: string[]

@example blokkir, orðrétt.

structure? ​

optional structure?: StructureNode[]

Ritað @structure frumtrjá- (efnis)mynstur (efst í stigi) þegar það er til. Þegar @structure líkaminn notar @variant blokkir (sjá structureVariants), inniheldur þetta aðeins hnútana úr fyrsta afbrigði, til bakfærni með kóða sem ekki hefur verið uppfærður til að lesa structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Valfrjálsar DOM-lögun fyrir þennan íhlut, þegar ritaði @structure líkaminn inniheldur eina eða fleiri efstu @variant blokkir — fjarverandi fyrir hið algenga tilvik af einu, ekki-afbrigðilegu útliti.

structureDescription? ​

optional structureDescription?: string

Valfrjáls ritsmíðar-lýsing sem leiðir @structure líkamann, þegar hún er rituð.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Íhlutasvæðisbundin úreltunar-íhlutmtexti, þegar ritað (rök í @deprecated merki).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Notkunarritstæður úr @usage — hvernig á að innleiða stílblaðið / nota íhlutinn.

annotations ​

annotations: CssAnnotation[]

Staðbundnar skýringalínu lýsigögn úr @annotations, í röð höfundar.

refs ​

refs: number[]

Staðbundnar skýringatengingar úr @ref, í röð höfundar.

decorators ​

decorators: CssDecorator[]

Skjalar-stigs hlutalíkans-auðkenningar (decorators).

compat ​

compat: string[]

Vafra-/aðgerða-samhæfisathugasemdir úr @compat.

related: CssRelated[]

Tengd íhlutir úr @related.

memberOf? ​

optional memberOf?: CssMemberOf

Tilkynnt meðlimasamband úr @memberOf — þessi skrá er meðlimur annars nefnds skjals, valfrjáls private (má aðeins birtast innan foreldrisins). Fjarverandi ef ekki ritað.

members? ​

optional members?: string[]

Nöfn meðlimaskráa úr @members — öfug stefna, tilkynnt á foreldri.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Uppbyggðar yfirlýsingar foreldra-hlið meðlimi úr endurteknum @member merkjum.

source? ​

optional source?: CssSource

Hvar skráin var rituð, þegar staðsetningargögn eru tiltæk (fyrir heimildartengla).

customBlocks? ​

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

Innihald skráðra sérsniðinna (block) merkja, með lykli sem er nafn merkisins án @. Fyllist aðeins fyrir merki sem bætt var við í stillingum; óskráð óþekkt merki eru hunsuð. Fjarverandi þegar engin fundust.