vue-accessible-color-picker

A color picker component for Vue.js 3.

This package’s files are distributed in the ES module format and have not been transpiled.

Links:

• demo
• npmjs.com/package/vue-accessible-color-picker
  • on BundlePhobia
• github.com/kleinfreund/vue-accessible-color-picker
  • code of conduct
  • contributing guidelines

Contents

• Installation
• Usage
• Documentation
  • Props
    • color
    • visibleFormats
    • defaultFormat
    • alphaChannel
    • id
  • Events
    • color-change
  • Slots
    • hue-range-input-label
    • alpha-range-input-label
    • copy-button
    • format-switch-button
• Versioning
• Design

Installation

npm install vue-accessible-color-picker

Usage

In a Vue single file component, import the ColorPicker component.

When using Vue’s composition API, you can directly use the component in the file’s template section.

<template>
	<ColorPicker />
</template>

<script setup>
import { ColorPicker } from 'vue-accessible-color-picker'
</script>

When using Vue’s options API, the component must first be registered using the components property on the Vue instance.

<template>
	<ColorPicker />
</template>

<script>
import { ColorPicker } from 'vue-accessible-color-picker'

export default {
	components: {
		ColorPicker,
	},
}
</script>

Unstyled component:

If you want to use the unstyled variant of the component, you need to adjust the import statement to use the module specifier “vue-accessible-color-picker/unstyled”:

import { ColorPicker } from 'vue-accessible-color-picker/unstyled'

Documentation

Props

color

• Description: Sets the color of the color picker. You can pass any valid CSS color string or an object matching the internal color representation for an HSL, HSV, HWB, or RGB color.

• Type: string, ColorHsl, ColorHsv, ColorHwb, or ColorRgb

• Required: false

• Default: #ffffffff

• Usage:

   <ColorPicker color="hsl(270 100% 50% / 0.8)" />

   <ColorPicker color="#f80b" />

   <ColorPicker :color="{ h: 0.75, s: 1, l: 0.5, a: 0.8 }" />

   <template>
   	<ColorPicker
   		:color="color"
   		@color-change="updateColor"
   	/>
   </template>
  
   <script setup>
   import { ref } from 'vue'
   import { ColorPicker } from 'vue-accessible-color-picker'
  
   const color = ref('hsl(270 100% 50% / 0.8)')
  
   function updateColor (eventData) {
   	color.value = eventData.cssColor
   }
   </script>

visibleFormats

• Description: A list of visible color formats. Controls for which formats the color input elements are shown and in which order the formats will be cycled through when activating the format switch button.

• Type: VisibleColorFormat[]

• Required: false

• Default: ['hex', 'hsl', 'hwb', 'rgb']

• Usage:

   <ColorPicker :visible-formats="['hsl', 'hwb']" />

defaultFormat

• Description: The color format to show by default when rendering the color picker. Must be one of the formats specified in visibleFormats.

• Type: VisibleColorFormat

• Required: false

• Default: 'rgb'

• Usage:

   <ColorPicker default-format="hwb" />

alphaChannel

• Description: Whether to show input controls for a color’s alpha channel. If set to 'hide', the alpha range input and the alpha channel input are hidden, the “Copy color” button will copy a CSS color value without alpha channel, and the object emitted in a color-change event will have a cssColor property value without alpha channel.

• Type: 'show' or 'hide'

• Required: false

• Default: 'show'

• Usage:

   <ColorPicker alpha-channel="hide" />

id

• Description: The ID value will be used to prefix all input elements’ id and label elements’ for attribute values. Set this prop if you use multiple instances of the color-picker component on one page.

• Type: string

• Required: false

• Default: 'color-picker'

• Usage:

   <ColorPicker id="color-picker-1" />

Events

color-change

• Description: An input event is emitted each time the internal colors object is updated.

• Data: The event emits an object containing both the internal colors object and a CSS color value as a string based on the currently active format. The cssColor property will respect alphaChannel.

   {
   	colors: {
   		hex: string
   		hsl: ColorHsl
   		hsv: ColorHsv
   		hwb: ColorHwb
   		rgb: ColorRgb
   	}
   	cssColor: string
   }

• Usage:

   <template>
   	<ColorPicker
   		color="hsl(270 100% 50% / 0.8)"
   		@color-change="updateColor"
   	/>
   </template>
  
   <script setup>
   import { ColorPicker } from 'vue-accessible-color-picker'
  
   function updateColor (eventData) {
   	console.log(eventData)
   }
   </script>

Slots

hue-range-input-label

• Description: Overrides the content of the hue range input’s label element.
• Default content: Hue

alpha-range-input-label

• Description: Overrides the content of the alpha range input’s label element.
• Default content: Alpha

copy-button

• Description: Overrides the content of the copy button element.
• Default content: Copy color (and SVG icon)

format-switch-button

• Description: Overrides the content of the format switch button element.
• Default content: Switch format (and SVG icon)

Versioning

This package uses semantic versioning.

Design

The color picker consists of the following main elements:

• Color space:

  For fine-tuning the saturation and lightness/value, a slice of the HSV cylinder for the currently selected hue is shown.

  The HSV cylinder is more convenient for this task than the HSL cylinder as it shows a color at 100% saturation and 100% value in the top right corner (i.e. one can drag the color space thumb into the corner as a quasi shortcut). The HSL cylinder’s slice has this color at the halfway point of the Y axis (i.e. at 50% lightness) which isn’t easy to select.

• Hue slider:

  A slider for selecting the current hue. This rotates the HSV cylinder; thus, it changes the slice of the HSV cylinder that’s shown in the color space.

• Alpha slider:

  A slider for selecting the current alpha value.

• Copy button:

  Copies the color formatted as a CSS color string in the active format.

• Color inputs:

  A set of text fields which allow you to enter the individual components of each color. The text fields are shown based on the active format.

• Switch format button:

  Cycles through the available color formats (currently HEX, HSL, HWB, and RGB).