colortap
v0.3.0
Published
A tiny, dependency-free, color input field helper that utilizes the native color picker.
Readme
ColorTap
A tiny, dependency-free, color input field helper that utilizes the native color picker.
A Five Fifteen Project
Demo
Visit https://colortap.js.org
Installation
Manual Download
Download the latest version of colortap and then place the following HTML in your page's head element:
<script type="text/javascript" src="dist/colortap.min.js"></script>
<link rel="stylesheet" href="dist/colortap.min.css" />CDN (Courtesy of jsDelivr)
Place the following HTML in your page's head element (check to make sure the version in the URLs are the version you want):
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/fivefifteen/[email protected]/dist/colortap.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/fivefifteen/[email protected]/dist/colortap.min.css" />NPM
npm install colortap --save// ES6
import colortap from 'colortap'
// CommonJS
const colortap = require('colortap')Fetcher
fetcher install fivefifteen/colortap --saveBower
bower install fivefifteen/colortap --saveUsage
Basic HTML Structure
<div class="colortap">
<input type="color" id="main-color" value="#5185b3">
<button type="button" class="colortap-open colortap-value" data-colortap-style-prop="background-color"></button>
</div>The colortap Function
Initiates colortap on any element that has the colortap class. This should be a container around your color input.
Example
window.addEventListener('load', function () {
colortap()
})Attributes/Classes
The
colortap-inputclass - Any input element with this class will have it's value set to the selected color any time the color is changed. The color will also be set to any value that is entered into this input field.The
colortap-openclass - Any element with this class will open the color picker when clicked.The
colortap-valueclass - Any element with this class will have it's text content set to the color when the color is changed. If this element is an input, it's value will be updated instead of text content.The
data-colortap-style-propattribute - Set this attribute to a style property (likebackgroundorcolor) on an element to have it's style updated when the color is changed. Multiple style properties can be defined by separating them with a comma (ie.background,color).
JavaScript Methods
The containing colortap element (the element with the colortap class) will have the following methods attached to it available for use:
var color = document.querySelector('.color')
color.open() // Opens the color picker
color.set('#00ff00') // Sets the color
var currentColor = color.get() // Gets the current color
// The `change` event bubbles up to the containing element so you can detect changes like so:
color.addEventListener('change', function () {
document.body.style.setProperty('--color', event.target.value)
})Related
FileBokz - A tiny, dependency-free, highly customizable and configurable, easy to use file input with some pretty sweet features.
GrowField - A tiny, dependency-free JavaScript module for making textarea elements grow with their content.
HashJump - A tiny, dependency-free JavaScript module for handling anchor links and scrolling elements into view.
Kloner - A tiny, dependency-free JavaScript module for cloning/repeating elements.
License
MIT. See the license file for more info.
