aframe-colorwheel-component
v1.2.1
Published
A-Frame Color Wheel component, designed for A-Frame Material
Downloads
14
Maintainers
devladReadme
aframe-colorwheel-component
A-Frame Color Wheel component, designed to be used with A-Frame Material
NOTE: A-Frame Material is not required to use this component
For A-Frame.
Examples
API
| Property | Description | Default Value | | -------- | ----------- | ------------- | | disabled | Wether the color wheel responds to clicks or taps | false | | backgroundcolor | Background color of the UI | #fff | | wheelSize | Size (m) if the color wheel element. Note: This will determine the UI size automatically and assumes a a square element | 0.4 (40cm) | | showSelection | Show the color-selected circle (top left corner of UI) | true | | selectionSize | Size (m) of the selection circle, if enabled | 0.10 (10cm) | | showHexValue | Show the color as a hex value (Note: currently output only). If enabled, you can click on the value to copy the contents to your clipboard on selected devices only | false | | showSwatches | Show a collection of swatch colors, specified by the swatches property | false | | swatches | If showSwatches is set to true, the following colors will be available | ['#000000', '#FFFFFF', '#ff0000', '#2aa8dc', '#ffed00', '#4c881d', '#b14bff'] |
Installation
Browser
- Install and use by directly including the browser files:
- Create a listener component to listen for changes
<head>
<title>My Cool A-Frame Scene</title>
<script src="https://aframe.io/releases/0.6.1/aframe.min.js"></script>
<script src="https://unpkg.com/aframe-colorwheel-component/dist/aframe-colorwheel-component.min.js"></script>
<script type="text/javascript">
//Example of using the color wheel with events
AFRAME.registerComponent('color-listener', {
init: function(){
const el = this.el;
document.body.addEventListener('didchangecolor', function(evt){
//Available return formats from colorwheel
let style = evt.detail.style
let rgb = evt.detail.rgb
let hsv = evt.detail.hsv
let hex = evt.detail.hex
el.setAttribute('color', hex)
})
}
})
</script>
</head>
<body>
<a-scene>
<a-entity colorwheel></a-entity>
<a-sky color="#6EBAA7" color-listener></a-sky>
</a-scene>
</body>npm
Install via npm:
npm install aframe-colorwheel-componentThen require and use.
require('aframe');
require('aframe-colorwheel-component');TODO / Roadmap
- Enable setting swatch colors
- Deeper customisation (padding, background colors, shader style)
- Interop testing