@lyra/color-input

@lyra/color-input

Color input for Lyra that stores selected colors in hex, hsl, hsv and rgb format.

Installation

lyra install @lyra/color-input

Usage

Use it in your schema types:

// [...]
{
  fields: [
    // [...]
    {
      name: 'favoriteColor',
      title: 'Favorite color',
      type: 'color'
    }
  ]
}

Note that the above only works if you import and use the all:part:@lyra/base/schema-type part in your schema. If you do not import this part to your schema, you can import the color schema from part:@lyra/color-input/schema.

Options

To disable the alpha option, set disableAlpha to true:

// ...fields...
{
  name: 'favoriteColor',
  title: 'Favorite color',
  type: 'color',
  options: {
    disableAlpha: true
  }
}

Data model

{
  _type: 'color',
  hex: '#29158a',
  alpha: 0.9,
  hsl: {
    h: 249.99999999999994,
    s: 0.7328000000000001,
    l: 0.313,
    a: 0.9
  },
  hsv: {
    h:249.99999999999994,
    s: 0.8457987072945522,
    v: 0.5423664,
    a: 0.9
  },
  rgb: {
    r: 41
    g: 21,
    b: 138,
    a: 0.9
  }
}

License

MIT-licensed. See LICENSE.