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), 또는 섀도우 DOM 의사요소(:host) — 첫 번째 노출된 클래스 규칙에서 추론되거나 @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[]

섀도우 DOM에 노출된 파트들(::part(name)), @csspart 또는 ::part() 선택자에서 가져옴.

pseudoElements ​

pseudoElements: CssPseudoElement[]

컴포넌트 스타일이 다루는 네이티브 의사요소들(::before, ::marker, …), @pseudo 또는 선택자에서 가져옴.

states ​

states: CssState[]

컴포넌트가 반응하는 상태들, @cssstate, :state(), 의사클래스 또는 상태 클래스에서 가져옴.

slots ​

slots: CssSlot[]

컴포넌트 셸이 노출하는 명명된 슬롯들, @slot에서 가져옴.

elements? ​

optional elements?: CssElementConstraints

@element에서 가져온 허용된 HTML 요소들(기본값 + 선택적 명명 프로필).

todos ​

todos: string[]

내부 할 일 노트, @todo 태그와 /* @todo … */ 인라인 주석에서 가져옴. 개발 메모로, 공개 API 아님 — 발행기는 이를 생략할 수 있음(예: [CssDocEntry.privateRemarks]).

cssPropertiesConsumed ​

cssPropertiesConsumed: CssTokenConsumed[]

이 컴포넌트가 소비하는 디자인 토큰들: 규칙 내에서 var(...)을 통해 참조된 모든 --* 커스텀 프로퍼티, 각각 작성된 경우 @tokens 서술문으로 주석 처리됨(그리고 var()로 문자 그대로 찾지 못하더라도 @tokens로 선언된 토큰 포함).

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 블록들, 그대로(원문).

structure? ​

optional structure?: StructureNode[]

작성된 @structure 요소 트리(최상위 노드), 존재할 경우. @structure 본문이 @variant 블록을 사용하는 경우(구조 변형 참조), 이는 첫 번째 변형의 노드만 보관함 — structureVariants를 읽도록 업데이트되지 않은 코드와의 하위 호환성 유지용.

structureVariants? ​

optional structureVariants?: StructureVariant[]

작성된 @structure 본문에 하나 이상의 최상위 @variant 블록이 포함된 경우의 대체 DOM 형태들 — 단일 비변형 구조의 일반적인 경우에는 없음.

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

등록된 사용자 정의(블록) 태그의 내용으로, 키는 태그 이름에서 @를 제외한 형태입니다. 구성(configuration)을 통해 추가된 태그에 대해서만 채워집니다; 등록되지 않은 알 수 없는 태그는 무시됩니다. 발견된 항목이 없으면 존재하지 않습니다.