Color

npm1.8.3

The color input component is used to allow users to select a color from a predefined set of options or to input a specific color value. The input should have a clear and consistent label that describes the option it represents.

Example

color

message text

code

<script type="module">
  import '@blueprintui/components/include/color.js';
</script>

<bp-field>
  <label>color</label>
  <bp-color></bp-color>
  <bp-field-message>message text</bp-field-message>
</bp-field>

Vertical

label

message text

disabled

disabled message

error

error message

success

success message

code

<bp-form-group layout="vertical">
  <bp-field layout="vertical">
    <label>label</label>
    <bp-color></bp-color>
    <bp-field-message>message text</bp-field-message>
  </bp-field>

  <bp-field layout="vertical">
    <label>disabled</label>
    <bp-color disabled></bp-color>
    <bp-field-message>disabled message</bp-field-message>
  </bp-field>

  <bp-field layout="vertical">
    <label>error</label>
    <bp-color></bp-color>
    <bp-field-message status="error">error message</bp-field-message>
  </bp-field>

  <bp-field layout="vertical">
    <label>success</label>
    <bp-color></bp-color>
    <bp-field-message status="success">success message</bp-field-message>
  </bp-field>
</bp-form-group>

Horizontal

label

message text

disabled

disabled message

error

error message

success

success message

code

<bp-form-group layout="horizontal">
  <bp-field layout="horizontal">
    <label>label</label>
    <bp-color></bp-color>
    <bp-field-message>message text</bp-field-message>
  </bp-field>

  <bp-field layout="horizontal">
    <label>disabled</label>
    <bp-color disabled></bp-color>
    <bp-field-message>disabled message</bp-field-message>
  </bp-field>

  <bp-field layout="horizontal" status="error">
    <label>error</label>
    <bp-color></bp-color>
    <bp-field-message status="error">error message</bp-field-message>
  </bp-field>

  <bp-field layout="horizontal" status="success">
    <label>success</label>
    <bp-color></bp-color>
    <bp-field-message status="success">success message</bp-field-message>
  </bp-field>
</bp-form-group>

Compact

label

message text

disabled

disabled message

error

error message

success

success message

code

<bp-form-group layout="compact">
  <bp-field layout="compact">
    <label>label</label>
    <bp-color></bp-color>
    <bp-field-message>message text</bp-field-message>
  </bp-field>

  <bp-field layout="compact">
    <label>disabled</label>
    <bp-color disabled></bp-color>
    <bp-field-message>disabled message</bp-field-message>
  </bp-field>

  <bp-field layout="compact" status="error">
    <label>error</label>
    <bp-color></bp-color>
    <bp-field-message status="error">error message</bp-field-message>
  </bp-field>

  <bp-field layout="compact" status="success">
    <label>success</label>
    <bp-color></bp-color>
    <bp-field-message status="success">success message</bp-field-message>
  </bp-field>
</bp-form-group>

Install

NPM

// npm package
import '@blueprintui/components/include/color.js';

CDN

<script type="module">
  import 'https://cdn.jsdelivr.net/npm/@blueprintui/components/include/color.js/+esm';
</script>

Accessibility

Use a label element or aria-labelledby or aria-label to provide a clear and concise description of the color picker option.

bp-color

Events

Name	Types	Description
`input`	`InputEvent`	occurs when the value changes
`change`	`InputEvent`	occurs when the value changes

Properties

Name	Types	Description
`type`	`string`
`value`	`string \| FormData`
`disabled`	`boolean`
`required`	`boolean`
`readonly`	`boolean \| undefined`
`multiple`	`boolean`
`autocomplete`	`string`
`name`	`string`
`pattern`	`string`
`placeholder`	`string`
`minLength`	`number`
`maxLength`	`number`
`min`	`number`
`max`	`number`
`size`	`number`
`valueAsNumber`
`formAssociated`	`boolean`

Attributes

Name	Types	Description
`type`	`string`
`value`	`string \| FormData`
`disabled`	`boolean`
`required`	`boolean`
`readonly`	`boolean \| undefined`
`multiple`	`boolean`
`autocomplete`	`string`
`name`	`string`
`pattern`	`string`
`placeholder`	`string`
`minLength`	`number`
`maxLength`	`number`
`min`	`number`
`max`	`number`
`size`	`number`

CSS Properties

Name	Types	Description
`--background`

Slots

Name	Types	Description
`prefix`		slot for prefix text or icons
`suffix`		slot for suffic text or icons