YUI Library Home

Site Search (YDN & YUIBlog):

# YUI Library Examples: YUI Loader Utility: Using addModule to Add Custom (Non-YUI) Content with YUILoader

# YUI Loader Utility: Using addModule to Add Custom (Non-YUI) Content with YUILoader

The YUILoader Utility is designed, of course, to help you put YUI components on the page. But your applications will frequently consist of a YUI-component foundation with your own application logic built on top. In other words, when you're loading YUI components you'll often want to load your own components as well.

This example shows you how to create a custom (non-YUI) module and load it via YUILoader. Click the "Load Yahoo! Maps" button below to load the Yahoo! Maps widget using the Yahoo! Maps AJAX API. The Maps widget requires specific YUI functionality to be loaded before its own JavaScript files are loaded. YUI Loader accepts our definition of a new `yahoomaps` module and, when we request it, the required files are brought into the page in the correct order.

Note 1: As of YUI 2.4.1, defining custom modules that override existing YUI skins requires a specific syntax. See the example code below for details. Note 2: Opera is not fully supported by the Yahoo! Maps AJAX API.

View example in new window.

Click the button above; Yahoo! Maps will load here.

## Using `addModule` to Add Custom Modules via YUILoader

The purpose of this example is to illustrate one mechanism for adding custom (non-YUI) content to the page using the YUILoader Utility. For full documentation on this feature of the YUILoader, please refer to the "Using `addModule`" section of the YUILoader Utility User's Guide.

### Identifying an External Module to Load: The Yahoo! Maps AJAX API

Yahoo! Maps offers an excellent UI widget that allows you to put mapping magic on any HTML page. This widget requires some YUI base components, so an excellent way to put it on the page is to use the YUI Loader.

### Invoke `addModule` to Make YUILoader Aware of the Yahoo! Maps Module

This is a simple step in which we invoke `addModule` and pass in relevant metadata about our new module:

loader.addModule({ name: 'yahoomaps', //module name; must be unique type: 'js', //can be "js" or "css" // a variable that will be available when the script is loaded. Needed // in order to act on the script immediately in Safari 2.x and below: varName: "YahooMapsAPIAjax", //can use a path instead, extending base path: fullpath: 'http://l.yimg.com/d/lib/map/js/api/ymapapi_3_8_2_3.js', //the list of modules that this new module requires: requires: ['yahoo','dom','event','json','animation','dragdrop'] });

Note that in this case we're setting up a dependency relationship between the `yahoomaps` module and six standard YUI modules. YUI Loader, when asked to load `yahoomaps`, will look at the current environment and load any of these requirements that aren't already present before loading the `yahoomaps` module.

### Full Source for This Example

The `addModule` step is the most important elements of this example with respect to adding non-YUI content to the page via YUI Loader. The full source of the example, including the use of the YUI Button Control to actuate the loading of the maps widget, follows here.

The varName property is required for external scripts that need to run in Safari 2.x or lower. This is the name a variable that the downloaded script will contain. The `onSuccess` handler will only be executed once this property is detected.

<!--Container for our call-to-action button--> <div id="buttonContainer"></div> <!--Container for our Maps instance--> <div id="mapContainer">Click the button above; Yahoo! Maps will load here.</div> <script type="text/javascript"> //create our Button Instance which will trigger Loader to //load the JSON utility from json.org. YAHOO.example.buttoninit = function() { //Create the button instance: var oButton = new YAHOO.widget.Button({ id: "mapInsertButton", type: "button", label: "Click here to load Yahoo! Maps", container: "buttonContainer" }); YAHOO.log("Button created; click button to begin loading Yahoo! Maps.", "info", "example"); //Create a handler that handles the button click; //it logs the click, hides the button, then fires //the function (loaderinit) that brings in the Maps module: var onButtonClick = function() { YAHOO.log("Button clicked; hiding button now and loading Yahoo! Maps", "info", "example"); this.set("disabled", true); //disable the button YAHOO.example.loaderinit(); //initialize loader } //attach the handler to the Button's click event: oButton.on("click", onButtonClick); }; //Once the buttonContainer element is on the page, we can create //our button instance; in this case, the onContentReady deferral is unnecessary, //because we're writing the element to the page before this script, //but in many cases the onContentReady wrapper gives you added //flexibility and it comes at low expense: YAHOO.util.Event.onAvailable("buttonContainer", YAHOO.example.buttoninit); //Once Yahoo! Maps is loaded, we want to initialize the Maps display: YAHOO.example.onMapsLoaded = function(){ YAHOO.log("onMapsLoaded firing."); //The following lines employ the Yahoo! Maps //Ajax API: http://developer.yahoo.com/maps/ajax/ // Create a lat/lon object var myPoint = new YGeoPoint(37.754164,-122.454464); // Create a map object var map = new YMap(document.getElementById('mapContainer')); // Add a pan control map.addPanControl(); // Add a slider zoom control map.addZoomLong(); // Add map type control map.addTypeControl(); // Display the map centered on a latitude and longitude map.drawZoomAndCenter(myPoint, 6); //Log the completion of the process: YAHOO.log("Yahoo! Maps was successfully loaded into the page, and the Maps display was initialized. The process is complete.", "info", "example"); }; YAHOO.example.loaderinit = function() { YAHOO.log("YAHOO.example.loaderinit firing; we'll define our custom Maps module and load it now.", "info", "example"); //Begin by creating a new Loader instance: var loader = new YAHOO.util.YUILoader({ onSuccess: YAHOO.example.onMapsLoaded }); //Here we define the Yahoo! Maps API module //in YUI Loader: loader.addModule({ name: 'yahoomaps', //module name; must be unique type: 'js', //can be "js" or "css" // a variable that will be available when the script is loaded. Needed // in order to act on the script immediately in Safari 2.x and below: varName: "YahooMapsAPIAjax", //can use a path instead, extending base path: fullpath: 'http://l.yimg.com/d/lib/map/js/api/ymapapi_3_8_2_3.js', //the list of modules that this new module requires: requires: ['yahoo','dom','event','json','animation','dragdrop'] }); //This appid, available from //http://developer.yahoo.com/maps/ajax/ , must come before //the insert method is called. And yes, this must be a global variable: YMAPPID = "YUIBlogger"; loader.require("yahoomaps"); //include the new module //Insert JSON utility on the page, passing in our callback: loader.insert(); }; </script>

### Overriding skins

In version 2.4.1 of the YUI Loader, defining modules that override existing YUI skins requires that you load them in two phases: 1) The YUI component, 2) The custom component:

// first load treeview new YAHOO.util.YUILoader({ require: ['treeview'], onSuccess: function() { // when treeview is finished loading, define and load the custom tree modules var loader = new YAHOO.util.YUILoader(); // define the css module that overrides the default treeview css loader.addModule({ name:'customtreecss', type:'css', fullpath:'http://domain/customtree.css', requires:['treeview'] }); // define the script module that extends treeview loader.addModule({ name:'customtree', type:'js', fullpath:'http://domain/customtree.js', // make the css file a requirement for the script requires:['customtreecss'] }); loader.onSuccess = function() { // build the custom tree }; loader.insert(); } }).insert(); // insert the treeview component immediately });

## 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:

### YUI Loader Utility Examples:

- Using YUI Loader to Load the Calendar Control
- Using YUI Loader to Place Additional Components on a Page
- Using addModule to Add Custom (Non-YUI) Content with YUILoader
- Use YUILoader to list requirements for a set of components.
- Skinning via Progressive Enhancement using the Event Utility and the YUILoader (included with examples for Event Utility)
- Complex Application (included with examples for Layout Manager)

### More YUI Loader Utility 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