YUI Library Home

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.

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:

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.

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:

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.

Copyright © 2009 Yahoo! Inc. All rights reserved.

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