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"]), ID (#foo), หรือ pseudo ของ shadow-DOM (:host) — อนุมานจากกฎ bare-class แรกหรือตั้งโดยชัดเจนผ่าน @selector. มักไม่ว่างเปล่า (ตกกลับไปที่ .${name} เมื่อการอนุมานล้มเหลว)

summary? ​

optional summary?: string

สรุปหนึ่งบรรทัดจาก @summary

remarks? ​

optional remarks?: string

บทความขยายจาก @remarks

privateRemarks? ​

optional privateRemarks?: string

เนื้อหาภายในเท่านั้นจาก @privateRemarks (emitters อาจเลือกละเว้นจากผลลัพธ์สาธารณะ)

releaseStage? ​

optional releaseStage?: CssReleaseStage

ขั้นการปล่อยจากแท็กธงตัวแก้ (@alpha/@beta/@experimental/@internal/@public)

since? ​

optional since?: string

เวอร์ชันที่แนะนำเข้ามา, จาก @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[]

parts ที่เปิดเผยของ Shadow-DOM (::part(name)), จาก @csspart หรือ selector แบบ ::part()

pseudoElements ​

pseudoElements: CssPseudoElement[]

pseudo-elements ดั้งเดิมที่คอมโพเนนต์สไตล์ (::before, ::marker, …), จาก @pseudo หรือ selector

states ​

states: CssState[]

สถานะที่คอมโพเนนต์ตอบสนอง, จาก @cssstate, :state(), pseudo-classes หรือคลาสสถานะ

slots ​

slots: CssSlot[]

named slots ที่เชลล์คอมโพเนนต์เปิดเผย, จาก @slot

elements? ​

optional elements?: CssElementConstraints

องค์ประกอบ HTML ที่อนุญาตจาก @element (ค่าเริ่มต้น + โปรไฟล์ชื่อที่เป็นทางเลือก)

todos ​

todos: string[]

บันทึกสิ่งที่ต้องทำภายใน, จากแท็ก @todo และความคิดเห็นแบบ inline /* @todo … */. โน้ตการพัฒนา, ไม่ใช่ API สาธารณะ — emitters อาจละเว้น (เช่น CssDocEntry.privateRemarks)

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

design tokens ที่คอมโพเนนต์นี้ใช้: ทุก --* custom property ที่อ้างอิงผ่าน 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 layers) (@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> (e.g. self:button), when authored.

deprecated? ​

optional deprecated?: string

ข้อความการแทนที่การเลิกใช้งานระดับคอมโพเนนต์ เมื่อมีการเขียนไว้ (อาร์กิวเมนต์ของแท็ก @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[]>

เนื้อหาของแท็กกำหนดเอง (แบบบล็อก) ที่ลงทะเบียนไว้ จัดเก็บโดยใช้ชื่อแท็กเป็นคีย์โดยไม่รวม @. จะถูกเติมเฉพาะสำหรับ แท็กที่เพิ่มผ่านการกำหนดค่า; แท็กที่ไม่ได้ลงทะเบียนหรือไม่รู้จักจะถูกละไว้เมื่อไม่พบแท็กใดๆ.