pantoken / renderers/tinymce/src / CssDocEntry

Rhyngwyneb: CssDocEntry ​

Un cofnod CSS wedi'i ddogfennu: ei ddosbarth sylfaenol yn ogystal â phopeth a ddeilliodd o'r CSS + sylwadau dogfen.

Eiddo ​

name ​

name: string

Enw'r cofnod o @component/@utility/@rule/@declaration/@name, e.e. button.

kind ​

kind: CssRecordKind

Pa fath o arwyneb CSS y mae hyn yn ei ddogfennu (yn ddiofyn i component).

className ​

className: string

Y dewiswr CSS sylfaenol — dosbarth (.button), atribut ([data-layout="x"]), ID (#foo), neu pseudo shadow-DOM (:host) — a wahanwyd o'r rheol bare-class gyntaf neu a osodwyd yn eglur drwy @selector. Bob amser yn anempty (yn dychwelyd i .${name} pan fydd dyfalu'n methu).

summary? ​

optional summary?: string

Crynodeb un linell o @summary.

remarks? ​

optional remarks?: string

Prose ymestynnol o @remarks.

privateRemarks? ​

optional privateRemarks?: string

Prose ar gyfer defnydd mewnol yn unig o @privateRemarks (gall emitters benderfynu peidio â'i gynnwys yn allbwn cyhoeddus).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Cam rhyddhau o'r tag baner modifier (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Fersiwn lle cafodd ei gyflwyno, o @since.

group? ​

optional group?: string

Grŵp/categori dogfen, o @group/@category.

accessibility? ​

optional accessibility?: string

Canllawiau hygyrchedd, o @a11y/@accessibility.

global? ​

optional global?: boolean

Wedi'i gosod pan fydd y cofnod hwn yn cario tag @global — mae ei modifieres (a baneri @global fesul-modifier) yn gymwys i unrhyw gydran/lanwaith/rheol/datganiad, nid dim ond dosbarth sylfaen y cofnod hwn. Defnyddir yn ystod dilysu a gwiriadau defnydd i ddatrys cydymffurfiadau modifier yn fyd-eang.

modifiers ​

modifiers: CssModifier[]

Modifieres a echdrwyd o'r AST, wedi'u nodi gyda prose @modifier lle y'u hysgrifennwyd.

parts ​

parts: CssPart[]

Rhanau is-elfen a echdrwyd o'r AST (seiliedig ar ddosbarth), wedi'u nodi gyda prose @part lle y'u hysgrifennwyd.

shadowParts ​

shadowParts: CssPart[]

Rannau a ddatgelir yn Shadow-DOM (::part(name)), o @csspart neu ddewiswr ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Pseudo-elynau brodorol y mae'r gydran yn eu steilio (::before, ::marker, …), o @pseudo neu ddewiswr.

states ​

states: CssState[]

Statwsau y mae'r gydran yn ymateb iddynt, o @cssstate, :state(), pseudo-dosbarthiadau, neu ddosbarthiadau statws.

slots ​

slots: CssSlot[]

Slotiau enwedig y mae sîl y gydran yn eu datgelu, o @slot.

elements? ​

optional elements?: CssElementConstraints

Ellyllau HTML a ganiateir o @element (diofyn + proffiliau enwadol dewisol).

todos ​

todos: string[]

Nodiadau i'w gwneud mewnol, o dagiau @todo a sylwadau mewnol /* @todo … */. Nodiadau datblygu, nid API cyhoeddus — gall emitters eu hepgor (fel CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Tocynnau dylunio y mae'r gydran hon yn eu defnyddio: pob eiddo personol --* a gyfeirir ato drwy var(...) o fewn ei rheolau, pob un wedi'i nodi gyda prose @tokens lle y'u hysgrifennwyd (gan gynnwys unrhyw docynnau a ddatganwyd gan @tokens adnodd nad ydynt yn cael eu darganfod yn llythrennol drwy var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Eiddo personol y mae'r gydran hon yn eu datgan (@property) neu'n eu dogfennu (@cssproperty).

functions ​

functions: CssFunction[]

Swyddogaethau personol CSS (@function) a ddiffinnir gan y gydran hon.

animations ​

animations: CssAnimation[]

Anifailiadau (@keyframes) y mae'r gydran hon yn eu datgelu.

layers ​

layers: CssLayer[]

Hadau cascade (@layer) y mae'r gydran hon yn cymryd rhan ynddynt.

conditions ​

conditions: CssCondition[]

Blociau cefnogaeth-amodol (@container/@supports/@media) y mae'r rheolau o danynt.

examples ​

examples: string[]

Blociau @example, verbatim.

structure? ​

optional structure?: StructureNode[]

Y coeden elfennol @structure a awdurwyd (nodoedd uchaf), pan fo'n bresennol. Pan fydd corff @structure y awdur yn defnyddio blociau @variant (gweler structureVariants), mae hyn yn dal nodau'r amrywiad cyntaf yn unig, er cefnforgad gyda chod nad yw wedi'i ddiweddaru i ddarllen structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Siapiau DOM amgen ar gyfer y gydran hon, pan fo corff @structure a awdurwyd yn cynnwys un neu fwy o blociau uchaf @variant — yn absennol ar gyfer yr achos cyffredin o un strwythur sengl, heb amrywiad.

structureDescription? ​

optional structureDescription?: string

Disgrifiad prose dewisol sy'n arwain corff @structure, pan fo wedi'i awdurdodi.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Testun disodli datgaredig ar lefel y gydran, pan fo wedi'i awdurdodi (y dadleuon i dag @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Prose defnydd o @usage — sut i gynnwys y sheitlys / defnyddio'r gydran.

annotations ​

annotations: CssAnnotation[]

Rhesi legend nodiadau lleol o @annotations, yn nhrefn yr awdur.

refs ​

refs: number[]

Cyfeiriadau nodiadau lleol o @ref, yn nhrefn yr awdur.

decorators ​

decorators: CssDecorator[]

Addurnwyr model-objec ar lefel y cofnod.

compat ​

compat: string[]

Nodiadau cefnogaeth porwr / cydnawsedd nodwedd o @compat.

related: CssRelated[]

Cydrannau cysylltiedig o @related.

memberOf? ​

optional memberOf?: CssMemberOf

Aelodaeth teulu a ddatganwyd o @memberOf — mae'r cofnod hwn yn aelod o gofnod enwadol arall, yn ddewisol private (rhaid dim ond ymddangos o fewn y rhiant hwnnw). Yn absennol pan nad yw wedi'i awdurdodi.

members? ​

optional members?: string[]

Enwau cofnod aelod o @members — y cyfeiriad gwrthwyth, a ddatganir ar y rhiant.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Datganiadau aelodau strwythuredig ar ochr y rhiant o dagiau @member a ailadroddir.

source? ​

optional source?: CssSource

Lle cafodd y cofnod ei awdurdodi, pan fo gwybodaeth safle ar gael (ar gyfer dolenni ffynhonnell).

customBlocks? ​

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

Cynnwys tagiau arferol (bloc) cofrestredig, wedi'u allweddaru gan enw'r tag heb ei @. Wedi'i lenwi dim ond ar gyfer tagiau a ychwanegwyd drwy'r ffurfweddiad; anwybyddir tagiau anhysbys heb eu cofrestru. Yn absennol pan na chanfuwyd unrhyw un.