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

مرحلهٔ انتشار از یک تگِ پرچمِ مودیفایر (@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[]

Parts نمایان‌شده در 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[]

لایه‌های Cascade (@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

متن جایگزینیِ منسوخ‌شدن در سطح کامپوننت، در صورت نگارش (آرگومانِ تگ @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

متن استفاده (Usage) از @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[]>

محتوای تگ‌های سفارشی ثبت‌شده (بلاک)، که با نام تگ بدون @ شاخص‌گذاری شده‌اند. فقط برای تگ‌هایی که از طریق پیکربندی اضافه شده‌اند پر می‌شود؛ تگ‌های ناشناخته ثبت‌نشده نادیده گرفته می‌شوند. وقتی هیچ‌کدام پیدا نشوند، موجود نیست.