@paperbits/common/styles/variationContract.ts

Paperbits common components.

import { PluginBag } from "./pluginBagContract";
import { StateBagContract } from "./stateBagContract";
import { ComponentBagContract } from "./componentBagContract";

export interface VariationContract extends PluginBag {
    /**
     * Unique identifier.
     */
    key: string;

    /**
     * Style display name.
     */
    displayName: string;

    /**
     * Style category, e.g. "appearance".
     */
    category?: string;

    /**
     * Allowed states, i.e. ["hover", "active"].
     */
    allowedStates?: string[];

    /**
     * Element states.
     */
    states?: StateBagContract;
    
    /**
     * Nested component styles.
     */
    components?: ComponentBagContract;
}