pantoken / renderers/tinymce/src / CssDocEntry

ממשק: CssDocEntry ​

רשומת CSS אחת מתועדת: המחלקה הבסיסית שלה וכל מה שמקורו ב‑CSS + הערות התיעוד.

תכונות ​

name ​

name: string

שם הרשומה מ‑@component/@utility/@rule/@declaration/@name, לדוגמה button.

kind ​

kind: CssRecordKind

איזה סוג משטח CSS זה מתעד (ברירת מחדל component).

className ​

className: string

בורר ה‑CSS הבסיסי — מחלקה (.button), מאפיין ([data-layout="x"]), מזהה (#foo), או פסאודו של shadow-DOM (:host) — נגזר מהחוק bare-class הראשון או מוגדר במפורש באמצעות @selector. תמיד לא ריק (נופל חזרה ל‑.${name} כשאינפורנס נכשל).

summary? ​

optional summary?: string

סיכום שורה‑אחת מ‑@summary.

remarks? ​

optional remarks?: string

פרוזה מורחבת מ‑@remarks.

privateRemarks? ​

optional privateRemarks?: string

פרוזה פנימית בלבד מ‑@privateRemarks (מייצרים עשויים לבחור להשמיט אותה מתוך הפלט הציבורי).

releaseStage? ​

optional releaseStage?: CssReleaseStage

שלב ההפצה מתוך תג דגל 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

נקבע כאשר רשומה זו נושאת תג @global — המודיפיירים שלה (וטעמי @global לכל מודיפייר) חלים על כל קומפוננטה/פריסת‑עיצוב/חוק/הצהרה, לא רק על המחלקה הבסיסית של רשומה זו. משמש במהלך בדיקות ולצריכה כדי לפתור התאמות מודיפייר באופן גלובלי.

modifiers ​

modifiers: CssModifier[]

מודיפיירים שהתמצאו מ‑AST, מתועדים עם פרוזת @modifier היכן שנכתבה.

parts ​

parts: CssPart[]

חלוקות‑תת־אלמנטים שהתמצאו מ‑AST (מבוססות‑מחלקה), מתועדות עם פרוזת @part היכן שנכתבה.

shadowParts ​

shadowParts: CssPart[]

חלקי Shadow‑DOM החשופים (::part(name)), מתוך @csspart או בורר ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

פסאודו‑אלמנטים מקומיים שהקומפוננטה מעצבת (::before, ::marker, …), מתוך @pseudo או בורר.

states ​

states: CssState[]

מצבים שהקומפוננטה מגיבה אליהם, מתוך @cssstate, :state(), פסאודו‑קלאסים, או מחלקות מצב.

slots ​

slots: CssSlot[]

סלוטים ממוספרים שהעטיפה של הקומפוננטה חושפת, מתוך @slot.

elements? ​

optional elements?: CssElementConstraints

אלמנטים HTML מותרים מתוך @element (ברירת‑מחדל + פרופילים ממוספרים אופציונליים).

todos ​

todos: string[]

הערות עבודה פנימיות, מתוך תגי @todo והערות פנימיות /* @todo … */. הערות פיתוח, לא API ציבורי — מייצרים עשויים להשמיט אותן (כמו CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

עוגני עיצוב שהקומפוננטה צורכת: כל נכס מותאם אישית --* המוזכר דרך var(...) בתוך חוקיה, כל אחד מתועד עם פרוזת @tokens היכן שנכתבה (וקולל כל אסמכתא @tokens שהוכרזה ולא נמצאה מילולית דרך var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

נכסים מותאמים אישית שהקומפוננטה מכריזה עליהם (@property) או מתעדת (@cssproperty).

functions ​

functions: CssFunction[]

פונקציות מותאמות של CSS (@function) שהקומפוננטה מגדירה.

animations ​

animations: CssAnimation[]

אנימציות (@keyframes) שהקומפוננטה חושפת.

layers ​

layers: CssLayer[]

שכבות קסקדה (@layer) שהקומפוננטה משתתפת בהן.

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 חלופיות עבור קומפוננטה זו, כאשר גוף @structure שנכתב מכיל אחד או יותר בלוקי @variant ברמת‑העל — חסר במקרה הרגיל של מבנה יחיד, ללא ווריאנטים.

structureDescription? ​

optional structureDescription?: string

תיאור פרוזה אופציונלי המוביל את גוף @structure, כאשר נכתב.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

טקסט החלפה עבור תיעוד ה‑deprecation ברמת הקומפוננטה, כאשר נכתב (הארגומנט ל‑תג @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

פרוזת שימוש מ‑@usage — כיצד לשלב את גיליון הסגנונות / להשתמש בקומפוננטה.

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[]>

תוכן של תגים מותאמים (בלוק) הרשומים, ממופה לפי שם התג ללא ה@. מתמלא רק עבור תגים שנוספו באמצעות התצורה; תגים לא רשומים ובלתי מוכרים מתעלמים. נעדר כאשר לא נמצאו כאלו.