Blockbench Reference Docs
    Preparing search index...

    Class ColorPicker

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    category? color? condition default_keybind? description events icon? id jq keybind name node nodes onChange? plugin? sub_keybinds? toolbars type uniqueNode? value variations? work_in_dialog? constructing

    Methods

    addLabel addListener addSubKeybind change conditionMet confirm delete dispatchEvent get getNode hide on once pushToolbar removeListener set toElement

    Constructors

    Properties

    category?: string
    color?: string
    condition: ConditionResolvable
    default_keybind?: Keybind
    description: string
    events: Record<string, EventListener[]>
    icon?: string | (() => string)
    id: string
    jq: JQuery
    keybind: Keybind
    name: string
    node: HTMLElement
    nodes: HTMLElement[]
    onChange?: (color: Instance) => void
    plugin?: string

    The plugin that this was added by

    sub_keybinds?: Record<string, SubKeybind>
    toolbars: Toolbar[]
    type: string
    uniqueNode?: boolean
    value: Instance
    variations?: { [key: string]: { description?: string; name: string } }
    work_in_dialog?: boolean
    constructing: BarItem

    Methods

    • Adds a label to the HTML element of the bar item

      Parameters

      • Optionalin_bar: boolean

        Set to true to generate an in-bar label, as opposed to a regular on-hover label

      • Optionalaction: any

        Provide the action to generate the label. This defaults to self and is only needed in special cases

      Returns void

    • Parameters

      • id: string
      • name: string
      • default_keybind: Keybind
      • trigger: any

      Returns void

    • Parameters

      • color: Instance

      Returns void

    • Returns boolean

    • Returns void

    • Returns void

    • Parameters

      • event_name: string
      • data: any

      Returns any

    • Returns Instance

    • Gets a copy of the elements HTML node that is not yet in use.

      Parameters

      • Optionalignore_disconnected: boolean

      Returns HTMLElement

    • Returns void

    • Parameters

      Returns void

    • Parameters

      • color: ColorInput

      Returns this

    • Appends the bar item to a HTML element

      Parameters

      • destination: string | HTMLElement

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods