pantoken / renderers/tinymce/src / CssDocEntry

Ինտերֆեյս: CssDocEntry ​

Մեկ փաստագրված CSS գրանցում՝ նրա բազային դասը և CSS + doc մեկնաբանություններից արդյունահանված ամեն ինչը։

Առանձնահատկություններ ​

name ​

name: string

Գրանցման անունը՝ վերցված @component/@utility/@rule/@declaration/@name-ից, օրինակ՝ button։

kind ​

kind: CssRecordKind

Որ տեսակ CSS մակերես է փաստագրվում (ստանդարտը component)։

className ​

className: string

Բազային CSS ընտրողը — մի դաս (.button), ատրիբուտ ([data-layout="x"]), ID (#foo), կամ shadow-DOM պսևդո (:host) — եզրակացվում է առաջին բարդ-դաս կանոնից կամ հստակ սահմանվում է @selector-ով։ Միշտ ոչ դատարկ (վերադարձնում է .${name} երբ եզրակացությունը ձախողվում է)।

summary? ​

optional summary?: string

Մի տողանոց ամփոփում՝ վերցված @summary-ից։

remarks? ​

optional remarks?: string

Ըլքըրող տեքստը՝ վերցված @remarks-ից։

privateRemarks? ​

optional privateRemarks?: string

Ներքին միայն հասանելի տեքստը՝ @privateRemarks-ից (էմիտերները կարող են ընտրել այն չցուցադրել հանրային ելքում)։

releaseStage? ​

optional releaseStage?: CssReleaseStage

Թողարկման փուլը՝ վերցված փոփոխարարի դրագրակից տեգից (@alpha/@beta/@experimental/@internal/@public)։

since? ​

optional since?: string

Ներկայացվող տարբերակի (version) փաստաթղթավորված արժեքը՝ @since-ից։

group? ​

optional group?: string

Փաստաթղթավորման խումբ/կատեգորիա, @group/@category-ից։

accessibility? ​

optional accessibility?: string

Մատչելիության (accessibility) ուղեցույցը, @a11y/@accessibility-ից։

global? ​

optional global?: boolean

Սահմանվում է, երբ այս գրանցումն ունի @global տեգ — դրա փոփոխարարները (և յուրաքանչյուր փոփոխարարի @global դրագրակները) տարածվում են ցանկացած կոմպոնենտի/մակետ/կանոնի/արտահայտման վրա, ոչ միայն այս գրանցման բազային դասի վրա։ Օգտագործվում է վավերացման և սպառման ստուգումների ժամանակ՝ փոփոխարարների համընկնումները գլոբալ լուծելու համար։

modifiers ​

modifiers: CssModifier[]

AST-ով արդյունահանված փոփոխարարներ, նշված @modifier տեքստով այնտեղ, որտեղ դրանք գրել են։

parts ​

parts: CssPart[]

AST-ով արդյունահանված ենթամասներ (դաս-հիմնական), նշված @part տեքստով այնտեղ, որտեղ դրանք գրել են։

shadowParts ​

shadowParts: CssPart[]

Shadow-DOM‑ով բացահայտված parts (::part(name)), @csspart-ից կամ ::part() ընտրողից։

pseudoElements ​

pseudoElements: CssPseudoElement[]

Ի բնե պսևդո-էլեմենտներ, որոնց համար կոմպոնենտի ոճերն աշխատում են (::before, ::marker, …), @pseudo-ից կամ ընտրողից։

states ​

states: CssState[]

Ներկայացված պետություններ, որոնցին կոմպոնենտը արձագանքում է՝ @cssstate, :state(), պսևդո-կլասներ կամ պետության դասեր նշելով։

slots ​

slots: CssSlot[]

Անվանված slots, որոնք կոմպոնենտի շելի կողմից բացվում են, @slot-ից։

elements? ​

optional elements?: CssElementConstraints

Թույլատրելի HTML տարրեր՝ @element-ից (ստանդարտ + կցորդական անվանավորված պրոֆիլներ)։

todos ​

todos: string[]

Ներքին to-do գրառումներ, @todo տեգերից և /* @todo … */ inline մեկնաբանություններից։ Իրակնացման նշումներ, ոչ հանրային API — էմիտերները կարող են դրանք չցուցադրել (ինչպես CssDocEntry.privateRemarks)։

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Դիզայնի token-ներ, որոնք կիրառում է այս կոմպոնենտը՝ յուրաքանչյուր --* ֆարս-առանձնահատկություն, որն հղում է var(...)-ով իր կանոններում, յուրաքանչյուրն արտահայտված է @tokens տեքստով այնտեղ, որտեղ ստեղծողի կողմից գրված է (ներառյալ այն token-ները, որոնք @tokens-ով են հայտարարվել, թեև ոչ միշտ անձամբ գտնվել են var()-ով)։

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Պարամետրային տիրույթներ (custom properties), որոնք այս կոմպոնենտը հայտարարում (@property) կամ փաստագրում (@cssproperty)։

functions ​

functions: CssFunction[]

CSS հարմարեցված ֆունկցիաներ (@function), որոնք այս կոմպոնենտը սահմանում է։

animations ​

animations: CssAnimation[]

Անիմացիաներ (@keyframes), որոնք այս կոմպոնենտը ցույց է տալիս։

layers ​

layers: CssLayer[]

Cascade շերտեր (@layer), որոնցում այս կոմպոնենտը ներգրավված է։

conditions ​

conditions: CssCondition[]

Conditional-support բլոկներ (@container/@supports/@media), որոնց տակ գտնվում են կանոնները։

examples ​

examples: string[]

@example բլոկները՝ հստակ տեքստով (verbatim)।

structure? ​

optional structure?: StructureNode[]

Հեղինակած @structure էլեմենտ ծառը (ավազանի մակարդակի հանգույցներ), երբ միշտ կա։ Երբ @structure սերիան օգտագործում է @variant բլոկներ (տես structureVariants), սա պահում է միայն առաջին տարբերակի հանգույցները՝ հետադարձ համատեղելիության համար նրանց հետ, ովքեր դեռ չեն թարմացրել կոդը ՝ ընթերցելու համար structureVariants։

structureVariants? ​

optional structureVariants?: StructureVariant[]

Այս կոմպոնենտի այլընտրանք DOM-ձևերը, երբ հեղինակած @structure մարմինը պարունակում է մեկ կամ ավելի վերին մակարդակի @variant բլոկ — բացակայում է մեկ, ոչ տարբերակ կառուցվածքի ընդհանուր դեպքի համար։

structureDescription? ​

optional structureDescription?: string

Ընտրովի պրոզե դռնացույց՝ որոնք գլխավորում են @structure մարմինը, երբ դրանք հեղինակված են։

demo? ​

optional demo?: string

@demo <spec> (օր.՝ self:button), երբ հեղինակված է։

deprecated? ​

optional deprecated?: string

Կոմպոնենտ-մակերեսի հինացման (deprecation) փոխարինման տեքստը՝ երբ հեղինակված է (անվակարգը @deprecated տեգի):

see ​

see: string[]

@see <ref> խաչ-հղումներ (cross-references).

usage? ​

optional usage?: string

Օգտագործման տեքստ (@usage) — ինչպես ընդգրկել stylesheet-ը / օգտագործել կոմպոնենտը։

annotations ​

annotations: CssAnnotation[]

Տեղական նշումների լեգենդի տողերը @annotations-ից, հեղինակի կարգով։

refs ​

refs: number[]

Տեղական նշումների հղումներ @ref-ից, հեղինակի կարգով։

decorators ​

decorators: CssDecorator[]

Գրանցման մակարդակի օբյեկտ-մոդելի դեկորատորներ։

compat ​

compat: string[]

Բրաուզերների աջակցման / հատկությունների համատեղելիության նշումներ @compat-ից։

related: CssRelated[]

Առնչվող կոմպոնենտներ @related-ից։

memberOf? ​

optional memberOf?: CssMemberOf

Հայտարարած ընտանիքային անդամակցություն @memberOf-ից — այս գրանցումը անդամ է այլ անունային գրանցման, մասնավորապես հնարավոր է private (պետք է հայտնվի միայն այդ ծնողի ներսում)։ Առկա չէ, երբ չի հայտարարվել։

members? ​

optional members?: string[]

Անդամային գրանցումների անուններ @members-ից — հակադարձ ուղղությունը, որը հայտարարվում է ծնողով։

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Ստրուկտուրացված ծնողական կողմի անդամային հայտարարություններ՝ ըստ կրկնվող @member տեգերի։

source? ​

optional source?: CssSource

Որտեղ գրվել է նշումը, երբ դիրքի տվյալները հասանելի են (աղբյուրային հղումների համար).

customBlocks? ​

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

Գրանցված հարմարեցված (բլոկ) թեգերի բովանդակությունը, բանալի է թեգի անվամբ՝ առանց նրա @. Լցվում է միայն կոնֆիգուրացիայով ավելացված թեգերի համար; չգրանցված, անծանոթ թեգերը անտեսվում են. Առկա չէ, եթե ոչինչ չի գտնվել.