pantoken-root / packages/core/src / PantokenPlugin

Schnittstelle: PantokenPlugin ​

Beta

Ein pantoken-Plugin. Jeder Hook ist optional; ein Plugin nimmt nur an den Stufen teil, für die es einen Hook definiert. Dasselbe Plugin kann daher auf mehr als einer Ebene eingreifen.

Eigenschaften ​

name ​

name: string

Beta

Ein eindeutiger, für Menschen lesbarer Plugin-Name.

Methoden ​

tokens()? ​

optional tokens(ctx): void | Token[]

Beta

Token-Stufe: gibt die vollständige Liste der Ersetzungstoken zurück.

Parameter ​

ctx ​

TokenHookContext

Rückgabe ​

void | Token[]

icons()? ​

optional icons(ctx): void | IconEntry[]

Beta

Icon stage: return new IconEntry records to register as <image> tokens. Returning undefined or an empty array leaves the current set unchanged.

Parameter ​

ctx ​

IconHookContext

Rückgabe ​

void | IconEntry[]

css()? ​

optional css(ctx): void | CssContribution

Beta

CSS-Stufe: CSS beisteuern oder nachverarbeiten.

Parameter ​

ctx ​

CssHookContext

Rückgabe ​

void | CssContribution

rehype()? ​

optional rehype(ctx): void | { resolve?: IconResolver; }

Beta

Rehype-Stufe: stellt einen Resolver bereit, der in das Rehype-Plugin eingebunden wird.

Parameter ​

ctx ​

RehypeHookContext

Rückgabe ​

void | { resolve?: IconResolver; }

native()? ​

optional native(ctx): void

Beta

Native-Stufe (Style Dictionary): Transforms/Formate registrieren.

Parameter ​

ctx ​

unknown

Rückgabe ​

void