Socket
Socket
Sign inDemoInstall

@baianat/colorpicker

Package Overview
Dependencies
1
Maintainers
2
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @baianat/colorpicker

ES6 colorpicker


Version published
Weekly downloads
14
increased by180%
Maintainers
2
Install size
186 kB
Created
Weekly downloads
 

Readme

Source

Colorpicker

ES6 color picker extension for Base framework.

Getting Started

Installation

You can install colorpicker as part of base.extensions.

npm install @baianat/base.extensions

# or using yarn
yarn add @baianat/base.extensions

If you want the standalone version.

npm install @baianat/colorpicker

yarn add @baianat/colorpicker

Include necessary files

<head>
  <link rel="stylesheet" href="dist/css/colorpikcer.css">
</head>
<body>
    ...
    <script type="text/javascript" src="dist/js/colorpikcer.js"></script>
</body>

HTML Layout

You need an input element to track the color value.

<input id="myPicker">

<script>
  const picker = new Colorpicker('#myPicker', {
    // default starter color
    defaultColor = '#ffffff',
    // color wheel radius in px
    radius = 200,
    // output color mode 'rgb', 'hex' or 'hsl'
    mode = 'rgb',
    // array of colors to fill recent colors, max of 6 colors
    recentColors = ['#c1c1c1', '#000000', '#ffffff'],
    // events to fire
    events = {
      // fires before selecting a color
      beforeSelect() {},
      // fires after selecting a color
      afterSelect() {},
      // fires before opening color picker menu
      beforeOpen() {},
      // fires after opening color picker menu
      afterOpen() {},
      // fires before clicking submit button
      beforeSubmit() {},
      // fires after clicking submit button
      afterSubmit() {},
      // fires on clicking on any part of the picker menu
      clicked() {}
    }
  });

  // to track color changes
  picker.el.addEventListener('change', () => {
    // do something great!
  })
</script>

Methods

You can call method on Colorpicker instance

const newPicker = new Picker('#myPicker');
newPicker.selectColor('#ff00ff');
MethodArgumentDescription
selectColor[String] color, [Bool] muteyou can change the selected with color argument. If you want to stop the picker from dispatching events, you can set mute to true. It's false by default.
getColorFromSlidersIt returns the rgb sliders values as string e.g. "rgb(71, 182, 148)"
getColorFromWheel[Object] mouseIt accepts an object, holds the x and y location on the wheel {x: 100, y: 100}, then returns its rgb value
togglePickershow/hide picker menu
closePickerhide picker menu
openPickershow picker menu

License

MIT

Copyright (c) 2017 Baianat

FAQs

Last updated on 13 May 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc