YUI Library Home

Site Search (YDN & YUIBlog):

# YUI Library Examples: Color Picker Control: Example of Color Picker Built in a Dialog via JavaScript

# Color Picker Control: Example of Color Picker Built in a Dialog via JavaScript

This example explores the implementation of a Color Picker Control within the context of a popup Dialog. The control can be called up in the floating Dialog, a color can be chosen, and upon submission of the Color Picker's value the color data is submitted to the server using Dialog's built-in support for Connection Manager.

Click the "Show Color Picker" button to get started. Use the other buttons on the configuration dashboard to explore different configurations of the Color Picker Controls. When you submit your color choice, the example uses Connection Manager to echo back the form fields that were passed to the server.

View example in new window.

Please choose a color:
Server response will be displayed in this area

## Using a Color Picker in a Dialog Control

The focus in this example is on the use of Color Picker Control within a Dialog Control.

In many cases, you'll want to use this implementation for Color Picker as it allows you to avoid reserving space inline in the page for the Color Picker interface. Dialog is ideally suited for this purpose because it floats above the page and is designed to collect and submit form data. Here we'll use Dialog's built-in support for Connection Manager and use that mechanism to process the color information gathered via Color Picker.

We'll also use a configuration dashboard that allows us to selectively enable/disable aspects of the Color Picker interface.

Here's the markup we need to get started:

<!--begin Color Picker configuration dashboard: --> <div> <button id="show">Show Color Picker</button> <button id="hide">Hide Color Picker</button> <button id="btnhsv">Show/hide HSV fields</button> <button id="btnhex">Show/hide HEX field</button> <button id="btnrgb">Show/hide RGB field</button> <button id="btnhexsummary">Show/hide HEX summary info</button> </div> <!--begin Dialog markup in standard module format; see the Container Family documentation for more about what markup is required for these controls--> <div id="yui-picker-panel" class="yui-picker-panel"> <div class="hd">Please choose a color:</div> <div class="bd"> <form name="yui-picker-form" id="yui-picker-form" method="post" action="assets/post.php"> <div class="yui-picker" id="yui-picker"></div> </form> </div> <div class="ft"></div> </div> <!--begin form for server response--> <div id="resp">Server response will be displayed in this area</div>

This markup provides us with a containing element for our Dialog instance (`yui-picker-panel`) and another containing element for our Color Picker (`yui-picker`). From here, we can begin our JavaScript. We'll use the Module Pattern to construct our code, beginning by creating a namespace for our example code and some useful shortcuts to commonly-used YUI components.

//create a namespace object in the example namespace: YAHOO.namespace("example.colorpicker") //create a new object for this module: YAHOO.example.colorpicker.inDialog = function() { //Some shortcuts to use in our example: var Event=YAHOO.util.Event, Dom=YAHOO.util.Dom, lang=YAHOO.lang;

The object `YAHOO.example.colorpicker.inDialog` is returned from our anonymous function. Its first member is our `init` function, wherein we create the Dialog instance:

//In our initialization function, we'll create the dialog; //in its render event, we'll create our Color Picker instance. init: function() { // Instantiate the Dialog this.dialog = new YAHOO.widget.Dialog("yui-picker-panel", { width : "500px", fixedcenter : true, visible : false, constraintoviewport : true, buttons : [ { text:"Submit", handler:this.handleSubmit, isDefault:true }, { text:"Cancel", handler:this.handleCancel } ] });

We don't want to create our Color Picker until the Dialog has rendered, so we tie our Color Picker's instantiation block to the Dialog's `renderEvent`:

// Once the Dialog renders, we want to create our Color Picker // instance. this.dialog.renderEvent.subscribe(function() { if (!this.picker) { //make sure that we haven't already created our Color Picker YAHOO.log("Instantiating the color picker", "info", "example"); this.picker = new YAHOO.widget.ColorPicker("yui-picker", { container: this.dialog, images: { PICKER_THUMB: "assets/picker_thumb.png", HUE_THUMB: "assets/hue_thumb.png" } //Here are some other configurations we could use for our Picker: //showcontrols: false, // default is true, false hides the entire set of controls //showhexcontrols: true, // default is false //showhsvcontrols: true // default is false }); //listen to rgbChange to be notified about new values this.picker.on("rgbChange", function(o) { YAHOO.log(lang.dump(o), "info", "example"); }); } });

Outside of our initialization function, we create success and failure handlers to deal with data as it comes back from Connection Manager. Those are then accessible to us as we initialize, and we can wire them up to our Dialog's callback object:

// Wire up the success and failure handlers this.dialog.callback = { success: this.handleSuccess, thisfailure: this.handleFailure };

The last step in our initialization is to render our dialog:

// We're all set up with our Dialog's configurations; // now, render the Dialog this.dialog.render();

When our `YAHOO.example.colorpicker.inDialog` object is created, we can then set its init function to fire `onDOMReady`:

//The earliest safe moment to instantiate a Dialog (or any //Container element is onDOMReady; we'll initialize then: YAHOO.util.Event.onDOMReady(YAHOO.example.colorpicker.inDialog.init, YAHOO.example.colorpicker.inDialog, true);

We've only called out some of the more significant parts of this example's code in the description above; to see the full example's source code, view this example via its "new window" button and view the page source.

## Configuration for This Example

You can load the necessary JavaScript and CSS for this example from Yahoo's servers. Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured.

### YUI Logger Output:

Note: Logging and debugging is currently turned off for this example.

Reload with logging
and debugging enabled.

### Color Picker Control Examples:

- Inline Color Picker Control from Script
- Example of Color Picker Built in a Dialog via JavaScript
- Example of Color Picker Built in a Dialog from Markup
- Example of Specifying Custom Labels and Element IDs for Color Picker
- Skinning Example
- Color Picker Button (included with examples for Button Control)

### More Color Picker Control Resources:

- User's Guide (external)
- API Documentation
- Cheat Sheet PDF (external)

Copyright © 2010 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings