pantoken / renderers/tinymce/src / CssDocEntry

Giao diện: CssDocEntry ​

Một bản ghi CSS được tài liệu hoá: lớp cơ sở của nó cùng mọi thứ được sinh ra từ CSS + chú thích tài liệu.

Thuộc tính ​

name ​

name: string

Tên bản ghi từ @component/@utility/@rule/@declaration/@name, ví dụ button.

kind ​

kind: CssRecordKind

Loại bề mặt CSS mà mục này tài liệu hoá (mặc định là component).

className ​

className: string

Bộ chọn CSS cơ sở — một class (.button), thuộc tính ([data-layout="x"]), ID (#foo), hoặc pseudo shadow-DOM (:host) — suy ra từ quy tắc bare-class đầu tiên hoặc được đặt rõ bằng @selector. Luôn không rỗng (sẽ dùng .${name} khi suy luận thất bại).

summary? ​

optional summary?: string

Tóm tắt một dòng từ @summary.

remarks? ​

optional remarks?: string

Văn bản mở rộng từ @remarks.

privateRemarks? ​

optional privateRemarks?: string

Văn bản chỉ nội bộ từ @privateRemarks (emitters có thể chọn loại bỏ nó khỏi đầu ra công khai).

releaseStage? ​

optional releaseStage?: CssReleaseStage

Giai đoạn phát hành từ một thẻ cờ modifier (@alpha/@beta/@experimental/@internal/@public).

since? ​

optional since?: string

Phiên bản giới thiệu, từ @since.

group? ​

optional group?: string

Một nhóm/loại tài liệu, từ @group/@category.

accessibility? ​

optional accessibility?: string

Hướng dẫn tiếp cận (accessibility), từ @a11y/@accessibility.

global? ​

optional global?: boolean

Được đặt khi bản ghi này mang thẻ @global — các modifier của nó (và các cờ @global theo modifier) áp dụng cho bất kỳ component/layout/rule/declaration nào, không chỉ lớp cơ sở của bản ghi này. Dùng trong việc kiểm tra và tiêu thụ để giải quyết khớp modifier ở phạm vi toàn cục.

modifiers ​

modifiers: CssModifier[]

Các modifier trích xuất từ AST, được chú thích bằng văn bản @modifier nơi được tác giả viết.

parts ​

parts: CssPart[]

Các phần con-đơn vị trích xuất từ AST (dựa trên class), được chú thích bằng văn bản @part nơi được tác giả viết.

shadowParts ​

shadowParts: CssPart[]

Các part được phơi bày của Shadow-DOM (::part(name)), từ @csspart hoặc một selector ::part().

pseudoElements ​

pseudoElements: CssPseudoElement[]

Pseudo-element gốc mà component style hỗ trợ (::before, ::marker, …), từ @pseudo hoặc một selector.

states ​

states: CssState[]

Các trạng thái mà component phản ứng, từ @cssstate, :state(), pseudo-classes, hoặc các lớp trạng thái.

slots ​

slots: CssSlot[]

Các slot có tên mà shell component phơi bày, từ @slot.

elements? ​

optional elements?: CssElementConstraints

Các phần tử HTML được phép từ @element (hồ sơ mặc định + tùy chọn có tên).

todos ​

todos: string[]

Ghi chú todo nội bộ, từ các thẻ @todo và chú thích nội tuyến /* @todo … */. Ghi chú phát triển, không phải API công khai — emitters có thể bỏ chúng (như CssDocEntry.privateRemarks).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

Các design token mà component này sử dụng: mọi --* custom property được tham chiếu qua var(...) bên trong các quy tắc của nó, mỗi cái được chú thích bằng văn bản @tokens nơi được tác giả viết (và bao gồm bất kỳ token nào được khai báo bằng @tokens nhưng không thực sự tìm thấy qua var()).

cssPropertiesDeclared ​

cssPropertiesDeclared: CssPropertyDeclared[]

Các custom property mà component này khai báo (@property) hoặc tài liệu hoá (@cssproperty).

functions ​

functions: CssFunction[]

Các hàm tuỳ chỉnh CSS (@function) mà component này định nghĩa.

animations ​

animations: CssAnimation[]

Các animation (@keyframes) mà component này phơi bày.

layers ​

layers: CssLayer[]

Các cascade layer (@layer) mà component này tham gia.

conditions ​

conditions: CssCondition[]

Các block hỗ trợ điều kiện (@container/@supports/@media) mà các quy tắc đặt dưới đó.

examples ​

examples: string[]

Các block @example, nguyên văn.

structure? ​

optional structure?: StructureNode[]

Cây phần tử @structure do tác giả viết (các node cấp trên), khi có. Khi thân @structure được viết sử dụng các block @variant (xem structureVariants), mục này giữ node của biến thể đầu tiên thôi, để tương thích ngược với code chưa cập nhật để đọc structureVariants.

structureVariants? ​

optional structureVariants?: StructureVariant[]

Các hình dạng DOM thay thế cho component này, khi thân @structure do tác giả viết chứa một hoặc nhiều block @variant cấp trên — không có cho trường hợp phổ biến là chỉ một cấu trúc không biến thể.

structureDescription? ​

optional structureDescription?: string

Một mô tả văn xuôi tuỳ chọn dẫn đầu thân @structure, khi được tác giả viết.

demo? ​

optional demo?: string

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

deprecated? ​

optional deprecated?: string

Văn bản thay thế khi deprecate ở cấp component, khi được tác giả viết (đối số cho một thẻ @deprecated).

see ​

see: string[]

@see <ref> cross-references.

usage? ​

optional usage?: string

Văn bản sử dụng từ @usage — cách bao gồm stylesheet / sử dụng component.

annotations ​

annotations: CssAnnotation[]

Các hàng chú giải chú thích cục bộ từ @annotations, theo thứ tự tác giả.

refs ​

refs: number[]

Các tham chiếu chú thích cục bộ từ @ref, theo thứ tự tác giả.

decorators ​

decorators: CssDecorator[]

Các decorator mô hình-đối-tượng ở cấp bản ghi.

compat ​

compat: string[]

Ghi chú hỗ trợ trình duyệt / tương thích tính năng từ @compat.

related: CssRelated[]

Các component liên quan từ @related.

memberOf? ​

optional memberOf?: CssMemberOf

Khai báo thành viên họ (family) từ @memberOf — bản ghi này là thành viên của một bản ghi khác được đặt tên, tuỳ chọn private (phải chỉ xuất hiện bên trong parent đó). Không có khi không được tác giả viết.

members? ​

optional members?: string[]

Tên bản ghi thành viên từ @members — hướng ngược lại, khai báo trên parent.

memberDeclarations? ​

optional memberDeclarations?: CssMemberDeclaration[]

Các khai báo thành viên có cấu trúc phía parent từ các thẻ @member lặp lại.

source? ​

optional source?: CssSource

Nơi bản ghi được tác giả hoá, khi thông tin vị trí có sẵn (dành cho liên kết nguồn).

customBlocks? ​

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

Nội dung của các thẻ tùy chỉnh (block) đã đăng ký, được lập chỉ mục theo tên thẻ mà không bao gồm @. Chỉ được điền cho các thẻ được thêm thông qua cấu hình; các thẻ chưa đăng ký sẽ bị bỏ qua. Không có khi không tìm thấy thẻ nào.