Penpot plugins API
    Preparing search index...

    Interface TokenBase

    Represents the base properties and methods of a Design Token in Penpot, shared by all token types.

    interface TokenBase {
        id: string;
        name: string;
        description: string;
        duplicate(): Token;
        remove(): void;
        resolvedValueString: string | undefined;
        applyToShapes(
            shapes: Shape[],
            properties: TokenProperty[] | undefined,
        ): void;
        applyToSelected(properties: TokenProperty[] | undefined): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id name description resolvedValueString

    Methods

    duplicate remove applyToShapes applyToSelected

    Properties

    id: string

    The unique identifier for this token, used only internally inside Penpot. This one is not exported or synced with external Design Token sources.

    name: string

    The name of the token. It may include a group path separated by ..

    description: string

    An optional description text.

    resolvedValueString: string | undefined

    The value calculated by finding all tokens with the same name in active sets and resolving the references.

    It's converted to string, regardless of the data type of the value depending on the token type. It can be undefined if no value has been found in active sets.

    Methods

    • Adds to the set that contains this Token a new one equal to this one but with a new id.

      Returns Token

    • Removes this token from the catalog.

      It will NOT be unapplied from any shape, since there may be other tokens with the same name.

      Returns void

    • Applies this token to one or more properties of the given shapes.

      Parameters

      • shapes: Shape[]

        is an array of shapes to apply it.

      • properties: TokenProperty[] | undefined

        an optional list of property names. If omitted, the default properties will be applied.

        NOTE that the tokens application is by name and not by id. If there exist several tokens with the same name in different sets, the actual token applied and the value set to the attributes will depend on which sets are active (and will change if different sets or themes are activated later).

      Returns void

    • Applies this token to the currently selected shapes.

      Parameters and warnings are the same as above.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods