Color

Generates a text input with the spectrum colourpicker.

Example usage

{{
    form.color({
        'label': 'Pick colour',
        'id': 'foo',
        'value': '123456'
    })
}}

Outputs:

<div class="form__group colorpicker js-colorpicker">
    <label for="foo" class="control__label">Pick colour</label>
    <div class="controls">
        <div class="input-group">
            <span class="input-group-addon">#</span>
            <input id="foo" value="123456" type="text" class="form__control">    
        </div>
    </div>
</div>

Options applied to parent wrapper

Option Type Description
append string Text or markup to include after the input element
append_type string Use only when appending a button. button is the only valid value
class string A space separated list of class names
guidance string Text to be displayed in a popover, adds a (?) icon after the input
guidance-container string Element to bind guidance popover scroll behaviour to (default body)
help string Additional guidance information to be displayed next to the input
label string Text for the <label> companion element
prepend string Text or markup to include before the input element
prepend_type string Use only when prepending a button. buttonis the only valid value
required bool Visually indicates that the field must be completed

Options applied to input

Option Type Description
autofocus bool Whether the field should have input focus on page load
disabled bool Stops the element from being interactive if true
form string Specific one or more forms this label belongs to
id string A unique identifier, if required
name string The name of this control
placeholder string A short hint that describes the expected value
required bool Adds required and aria-required="true" attributes
value string Specifies the value of the input
data-* string Data attributes, eg: 'data-foo': 'bar'

Any other options not listed here will be applied to the input.

Error state

{{
    form.colour({
        'label': 'Pick a colour',
        'error': 'Something went wrong',
        ...

results matching ""

    No results matching ""