pantoken-root / packages/core/src / PantokenPlugin

Ինտերֆեյս: PantokenPlugin ​

Բետա

Pantoken plugin: Ամեն hook-ը ընտրովի է; plugin-ը մասնակցում է միայն այն փուլերին, որտեղ այն սահմանում է hook: Նույն plugin-ը կարող է ինեկցիա անել ավելի քան մեկ շերտում:

Առանձնահատկություններ ​

name ​

name: string

Բետա

Յուրահատուկ, մարդկային ընթեռնելի plugin անունը:

Մեթոդներ ​

tokens()? ​

optional tokens(ctx): void | Token[]

Բետա

Token փուլ` վերադարձնել տեղադրման token ամբողջ ցանկը:

Պարամետրեր ​

ctx ​

TokenHookContext

Վերադարձվող արժեք ​

void | Token[]

icons()? ​

optional icons(ctx): void | IconEntry[]

Բետա

Պատկերակի փուլ վերադարձնել նոր [IconEntry](IconEntry.md) գրառումներ գրանցելու համար որպես <image> tokens: Վերադարձնել undefined կամ դատարկ array-ը թողնում է ընթացիկ հավաքածուն անփոփոխ:

Պարամետրեր ​

ctx ​

IconHookContext

Վերադարձվող արժեք ​

void | IconEntry[]

css()? ​

optional css(ctx): void | CssContribution

Բետա

CSS փուլ` ներդրում կամ CSS հետ-մշակում:

Պարամետրեր ​

ctx ​

CssHookContext

Վերադարձվող արժեք ​

void | CssContribution

rehype()? ​

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

Բետա

Rehype փուլ` տրամադրել resolver-ը միացված rehype plugin-ի մեջ:

Պարամետրեր ​

ctx ​

RehypeHookContext

Վերադարձվող արժեք ​

void | { resolve?: IconResolver; }

native()? ​

optional native(ctx): void

Բետա

Բնական փուլ (Style Dictionary)` գրանցել transforms/formats:

Պարամետրեր ​

ctx ​

unknown

Վերադարձվող արժեք ​

void