Package Exports
- vue-color-palette
- vue-color-palette/index.css
- vue-color-palette/package.json
- vue-color-palette/theme.css
Readme
vue-color-palette
pnpm add vue-color-palette
Usage
Styles
You need to import the component styles:
import 'vue-color-palette/index.css'[!IMPORTANT] 🚧 Only import
theme.cssif you are NOT using shadcn-schema in your project:
import 'vue-color-palette/theme.css'Basic Usage
ColorPicker renders the panel directly. Use ColorPickerTrigger if you need a trigger button:
<script setup lang="ts">
import { ref } from 'vue'
import { ColorPicker, ColorPickerTrigger } from 'vue-color-palette'
import 'vue-color-palette/index.css'
const color = ref('#1447e6')
</script>
<template>
<!-- Direct panel -->
<ColorPicker v-model:value="color" />
<!-- With trigger button -->
<ColorPickerTrigger v-model:value="color" />
</template>Props
ColorPickerProps
value- Current color value (supports solid colors and gradients)defaultValue- Default color valuecolorModes- Available color modes:'monochrome' | 'linear-gradient' | 'radial-gradient'format- Color format:'HEX' | 'RGB' | 'HSL' | 'HSV' | 'CMYK'disabled- Whether the picker is disabledenableModePicker- Enable mode picker (solid/gradient)enableFormatPicker- Enable format pickerenableInput- Enable color input fieldsenableAlpha- Enable alpha channel controlenableEyeDrop- Enable eye dropper toolrecentColors- Recent colors array orfalseto disableswatchColors- Swatch colors array ortrueto use default colorslocale- Locale string or custom locale configisDark- Force dark mode (undefined for auto detection)
ColorPickerTriggerProps
Extends ColorPickerProps with:
placeholder- Placeholder text for the trigger button
Credits
- react-best-gradient-color-picker - UI design is largely inspired by this project
- TDesign - Built-in color presets are based on TDesign
- vue3-color-picker
License
MIT License © jinghaihan