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)، أو pseudo الخاص بـ 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 — تعد modifierاته (وعلامات @global لكل مُعدل) قابلة للتطبيق على أي مكوّن/تخطيط/قاعدة/تصريح، وليس فقط فئة السجل الأساسية. تُستخدم أثناء التحقق والاستهلاك لحل مطابقات المعدل على مستوى العالم.

modifiers ​

modifiers: CssModifier[]

المعدلات المستخرجة من AST، مُشَرَّحة بنص @modifier حيث كُتِبت.

parts ​

parts: CssPart[]

أجزاء العناصر الفرعية المستخرجة من AST (معتمدة على الفئات)، مُشَرَّحة بنص @part حيث كُتِبت.

shadowParts ​

shadowParts: CssPart[]

الأجزاء المكشوفة في Shadow-DOM (::part(name))، من @csspart أو محدد ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

pseudo-elements الأصلية التي تُطبّقها أنماط المكوّن (::before, ::marker, …)، من @pseudo أو محدد.

states ​

states: CssState[]

الحالات التي يستجيب لها المكوّن، من @cssstate, :state(), pseudo-classes، أو فئات الحالة.

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 حرفيًا.

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

نص استبدال عند إهمال على مستوى المكوّن، عند تأليفه (الحجة لوسم @deprecated).

see ​

see: string[]

المرجع المتبادل @see <ref>.

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

محتوى الوسوم المخصصة المسجلة (الكتل)، مفهرس باسم الوسم بدون @. يُملأ فقط ل الوسوم المضافة عبر التكوين؛ تُتجاهل الوسوم غير المسجلة وغير المعروفة. يكون غائبًا عندما لا يُعثر على أي منها.