Coloris NPM

A lightweight and elegant JavaScript color picker written in vanilla ES6.
Convert any text input field into a color field.

Forked from https://github.com/mdbassit/Coloris so we could provide TypeScript and NPM support. Head over to Momo Bassit's original repo for user documentation.

NPM

You can download the color picker from NPM:

# using NPM
npm install @melloware/coloris
# using Yarn
yarn add @melloware/coloris

And then use it within a module environment, e.g. with browserify, rollup, webpack etc. In this case, you must initialize the color picker before its first use (which has several side-effects such as adding DOM elements):

import "@melloware/coloris/dist/coloris.css";
import Coloris from "@melloware/coloris";
Coloris.init();
Coloris({el: "#coloris"});

AMD

The color picker also works with AMD / require.js:

requirejs(['@melloware/coloris'], function (Coloris) {
  Coloris.init();
  Coloris({
    el: "#coloris",
  });
});

Java / Maven

The colorpicker can also be downloaded as a Java JAR for use in Java web applicatons:

<dependency>
   <groupId>org.webjars.npm</groupId>
   <artifactId>melloware__coloris</artifactId>
   <version>0.8.1</version>
</dependency>

TypeScript

This package includes TypeScript declarations. When you use it in a module environment, just import it:

import "@melloware/coloris/dist/coloris.css";
import Coloris from "@melloware/coloris";

Coloris.init();
Coloris({el: "#coloris"});
Coloris.close();

If you wish to write a global script file, use a triple slash reference:

/// <reference types="@melloware/coloris" />
Coloris({
    el: "#coloris",
});

Building from source

Clone the git repo:

git clone git@github.com:mdbassit/Coloris.git

Enter the Coloris directory and install the development dependencies:

cd Coloris && npm install

Run the build script:

npm run build

The built version will be in the dist directory in both minified and full copies.

Alternatively, you can start a gulp watch task to automatically build when the source files are modified:

npm run start

Publishing

Adjust the version in the package.json if necessary, then

npm login
# This will run npm run build automatically
npm publish --access public

Then upload code to github, create tag & release.

License

Copyright (c) 2021 Momo Bassit. Coloris is licensed under the MIT license.