Vue-color-next NPM

vue-color-next

📎 Installation

$ npm i vue-color-next
# or
$ yarn add vue-color-next

🌎 CDN

CDN: https://unpkg.com/vue-color-next

<link rel="stylesheet" href="https://unpkg.com/vue-color-next/dist/index.min.css">
<script src="https://unpkg.com/vue-color-next"></script>
<script>
  Vue.createApp(App).use(VueColor.VueColor)
  ...
</script>

👽 Usage

main.js:

import { createApp } from 'vue'
import { VueColor } from 'vue-color-next'
import App from './App.vue'
import 'vue-color-next/dist/index.css'

const app = createApp(App)
app.use(VueColor)
app.mount('#app')

App.vue:

<script setup>
const colors = ref('#ff0000')
const colorObj = reactive({
  hex: '',
  hex8: '',
  rgb: {},
  rgba: {},
  hsl: {},
  hsla: {},
  hsv: {},
  hsva: {},
})
</script>

<template>
  <Sketch
    v-model="colors" v-model:rgb="colorObj.rgb" v-model:rgba="colorObj.rgba" v-model:hsl="colorObj.hsl"
    v-model:hsla="colorObj.hsla" v-model:hex="colorObj.hex" v-model:hex8="colorObj.hex8"
    v-model:hsv="colorObj.hsv"
    v-model:hsva="colorObj.hsva"
  />
</template>

v-model support value type see: Types ModelValue

Components

Sketch
Chrome
Photoshop
Material
Slider
Compact
Grayscale
Swatches
Twitter

Composables

useColor

Types

type ModelValue = tinycolor.ColorInput & OmitColorObject
type OmitColorObject = Omit<ColorObject, 'oldHue' | 'source'>
type Source = 'hsl' | 'hex' | 'hex8' | 'rgba' | 'rgb' | 'hsv' | 'hsva'
interface ColorObject {
  hsl?: tinycolor.ColorFormats.HSL;
  hsla?: tinycolor.ColorFormats.HSLA;
  hex?: string;
  hex8?: string;
  rgba?: tinycolor.ColorFormats.RGBA;
  rgb?: tinycolor.ColorFormats.RGB;
  hsv?: tinycolor.ColorFormats.HSV;
  hsva?: tinycolor.ColorFormats.HSVA;
  format?: string;
  oldHue?: number;
  a?: number;
  source?: Source;
}
type MaybeRef<T> = Ref<T> | T
function useColor(initValue: MaybeRef<ModelValue>): {
  setColor: (data: ColorObject | string) => void
  watchColor: (callback: (value: string | ModelValue) => void) => void
  colors: ColorObject
}