webgui/www/extras/yui/examples/yuiloader/yl-addmodule.html
2008-03-25 16:13:25 +00:00

376 lines
24 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>YUI Library Examples: YUI Loader Utility (beta): Using addModule to Add Custom (Non-YUI) Content with YUILoader</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >
<style>
/*Supplemental CSS for the YUI distribution*/
#custom-doc { width: 95%; min-width: 950px; }
#pagetitle {background-image: url(../../assets/bg_hd.gif);}
#pagetitle h1 {background-image: url(../../assets/title_h_bg.gif);}
</style>
<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
<!--Script and CSS includes for YUI dependencies on this page-->
<link rel="stylesheet" type="text/css" href="../../build/logger/assets/skins/sam/logger.css" />
<link rel="stylesheet" type="text/css" href="../../build/button/assets/skins/sam/button.css" />
<script type="text/javascript" src="../../build/yuiloader/yuiloader-beta-debug.js"></script>
<script type="text/javascript" src="../../build/event/event-min.js"></script>
<script type="text/javascript" src="../../build/dom/dom-min.js"></script>
<script type="text/javascript" src="../../build/logger/logger-min.js"></script>
<script type="text/javascript" src="../../build/element/element-beta-min.js"></script>
<script type="text/javascript" src="../../build/button/button-min.js"></script>
<!--begin custom header content for this example-->
<style type="text/css">
/*no custom styles for this example*/
</style>
<!--end custom header content for this example-->
</head>
<body id="yahoo-com" class=" yui-skin-sam">
<div id="custom-doc" class="yui-t2">
<div id="hd">
<div id="ygunav">
<p><em>
<a href="http://developer.yahoo.com">Yahoo! Developer Network Home</a> <i> - </i>
<a href="http://help.yahoo.com/help/us/ysearch">Help</a>
</em>
</p>
<form action="http://search.yahoo.com/search"><label for="ygsp">YDN Site Search</label>
<input name="vs" type="hidden" value="developer.yahoo.com">
<input name="fr" type="hidden" value="ush-myweb">
<input id="ygsp" name="va" size="22">
<input type="submit" value="Search" class="ygbt"></form>
</div>
<div id="ygma"><a href="../../"><img src="../../assets/yui.gif" border="0" width="378" height="28"></a></div>
<div id="pagetitle"><h1>YUI Library Examples: YUI Loader Utility (beta): Using addModule to Add Custom (Non-YUI) Content with YUILoader</h1></div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-ge">
<div class="yui-u first example">
<div class="promo">
<h1>YUI Loader Utility (beta): Using addModule to Add Custom (Non-YUI) Content with YUILoader</h1>
<div class="exampleIntro">
<p><a href="http://developer.yahoo.com/yui/yuiloader/">The YUILoader Utility</a> 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.</p>
<p>This example shows you how to create a custom (non-YUI) module and load it via YUILoader. Click the "Load JSON" button below to load Douglas Crockford's JSON utility from <a href="http://json.org/">JSON.org</a> via YUILoader. Keep an eye on the Logger Control console at right to follow the logic as it executes after you click the button.</p>
<p>Note: in 2.4.1 Defining custom modules that override existing YUI skins requires a specific syntax. See
the <a href="#overrideskins">example code</a> below for details.</p>
</div>
<div class="example-container module ">
<div id="example-canvas" class="bd">
<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== -->
<!--Container for our call-to-action button-->
<div id="jsonInsertButtonContainer"></div>
<!--Container to which we'll append success message-->
<div id="jsonContainer"></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: "jsonInsertButton",
type: "button",
label: "Click here to load JSON Utility",
container: "jsonInsertButtonContainer"
});
YAHOO.log("Button created; click button to begin loading JSON.", "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 JSON:
var onButtonClick = function() {
YAHOO.log("Button clicked; hiding button now and loading JSON", "info", "example");
YAHOO.util.Dom.setStyle("jsonInsertButtonContainer", "display", "none");
YAHOO.example.loaderinit();
}
//attach the handler to the Button's click event:
oButton.on("click", onButtonClick);
};
//Once the jsonInsertButtonContainer 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("jsonInsertButtonContainer",
YAHOO.example.buttoninit);
//Once JSON is loaded, we want to simply display a message that indicates
//we were successful in bringing it into the page:
YAHOO.example.onJsonLoad = function( ){
//Indicate on the page that the operation succeeded:
YAHOO.util.Dom.get("jsonContainer").innerHTML = "The JSON utility was successfully loaded into the page. Scroll through the Logger Console output at right to review the timeline of steps that were followed by the script; note that most recent log messages appear at the top.";
//Log the completion of the process:
YAHOO.log("JSON utility was successfully loaded into the page, and the page was updated to indicate success. The process is complete.", "info", "example");
};
YAHOO.example.loaderinit = function() {
YAHOO.log("YAHOO.example.loaderinit firing; we'll define our custom JSON module and load it now.", "info", "example");
//Begin by creating a new Loader instance:
var loader = new YAHOO.util.YUILoader();
//Add the module to YUILoader
loader.addModule({
name: "json", //module name; must be unique
type: "js", //can be "js" or "css"
fullpath: "http://www.json.org/json2.js", //can use a path instead, extending base path
varName: "JSON" // 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.
//requires: ['yahoo', 'event'] //if this module had dependencies, we could define here
});
loader.require("json"); //include the new module
//Insert JSON utility on the page, passing in our callback:
loader.insert({
onSuccess: YAHOO.example.onJsonLoad
});
};
</script>
<!--END SOURCE CODE FOR EXAMPLE =============================== -->
</div>
</div>
</div>
<h2 class="first">Using <code>addModule</code> to Add Custom Modules via YUILoader</h2>
<p>The purpose of this example is to illustrate one mechanism for adding custom (non-YUI) content to the page using the <a href="http://developer.yahoo.com/yui/yuiloader/">YUILoader Utility</a>. For full documentation on this feature of the YUILoader, please refer to the <a href="http://developer.yahoo.com/yui/yuiloader/#addmodule">"Using <code>addModule</code>" section of the YUILoader Utility User's Guide</a>.</p>
<h3>Identifying an External Module to Load: The JSON Utility</h3>
<p>Douglas Crockford, the inventor of <a href="http://json.org">JSON</a>, has written a <a href="http://www.json.org/json.js">JSON Utility</a> that helps you verify that information you've brought into the page as JSON is indeed limited to constructs that fit the JSON specification; this utility helps prevent some forms of malicious attacks embedded in JSON data from being successful in damaging you application or compromising its security.</p>
<p>In this example, we'll use YUILoader's <code>addModule</code> function to load the JSON Utility from <code>http://www.json.org/json.js</code>.</p>
<h3>Invoke <code>addModule</code> to Make YUILoader Aware of the JSON Utility</h3>
<pThis is a simple step in which we invoke <code>addModule</code> and pass in relevant metadata about our new module:</p>
<textarea name="code" class="JScript" cols="60" rows="1">//Add the module to YUILoader
loader.addModule({
name: "json", //module name; must be unique
type: "js", //can be "js" or "css"
fullpath: "http://www.json.org/json2.js", //can use a path instead, extending base path
varName: "JSON" // 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.
//requires: ['yahoo', 'event'] //if this module had dependencies, we could define here
});</textarea>
<p>Note that in this case we're not setting up a dependency relationship between the JSON Utility and any other YUI components. However, in the commented-out last line above, we could use the <code>requires</code> member of the configuration object to make the JSON Utility depend on other YUI components or other custom components that we've defined.</p>
<h3>Full Source for This Example</h3>
<p>The <code>addModule</code> step is the most important elements of this example with respect to adding non-YUI content to the page via YUILoader. The full source of the example, including the use of the YUI Button Control to actuate the loading of the JSON Utility, follows here.</p>
<p>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.</p>
<textarea name="code" class="JScript" cols="60" rows="1"><!--Container for our call-to-action button-->
<div id="jsonInsertButtonContainer"></div>
<!--Container to which we'll append success message-->
<div id="jsonContainer"></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: "jsonInsertButton",
type: "button",
label: "Click here to load JSON Utility",
container: "jsonInsertButtonContainer"
});
YAHOO.log("Button created; click button to begin loading JSON.", "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 JSON:
var onButtonClick = function() {
YAHOO.log("Button clicked; hiding button now and loading JSON", "info", "example");
YAHOO.util.Dom.setStyle("jsonInsertButtonContainer", "display", "none");
YAHOO.example.loaderinit();
}
//attach the handler to the Button's click event:
oButton.on("click", onButtonClick);
};
//Once the jsonInsertButtonContainer 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("jsonInsertButtonContainer",
YAHOO.example.buttoninit);
//Once JSON is loaded, we want to simply display a message that indicates
//we were successful in bringing it into the page:
YAHOO.example.onJsonLoad = function( ){
//Indicate on the page that the operation succeeded:
YAHOO.util.Dom.get("jsonContainer").innerHTML = "The JSON utility was successfully loaded into the page. Scroll through the Logger Console output at right to review the timeline of steps that were followed by the script; note that most recent log messages appear at the top.";
//Log the completion of the process:
YAHOO.log("JSON utility was successfully loaded into the page, and the page was updated to indicate success. The process is complete.", "info", "example");
};
YAHOO.example.loaderinit = function() {
YAHOO.log("YAHOO.example.loaderinit firing; we'll define our custom JSON module and load it now.", "info", "example");
//Begin by creating a new Loader instance:
var loader = new YAHOO.util.YUILoader();
//Add the module to YUILoader
loader.addModule({
name: "json", //module name; must be unique
type: "js", //can be "js" or "css"
fullpath: "http://www.json.org/json2.js", //can use a path instead, extending base path
varName: "JSON" // 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.
//requires: ['yahoo', 'event'] //if this module had dependencies, we could define here
});
loader.require("json"); //include the new module
// set the function that should exectute when the file loads
loader.onSuccess = YAHOO.example.onJsonLoad;
//Insert JSON utility on the page
loader.insert();
};
</script></textarea>
<h3 id="overrideskins">Overriding skins</h3>
<p>In version 2.4.1 of the YUILoader, defining modules that override existing YUI
skins requires that you load them in two phases: 1) The YUI component, 2) The custom component:</p>
<textarea name="code" class="JScript" cols="60" rows="1">// 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
});</textarea>
</div>
<div class="yui-u">
<div id="loggerModule" class="yui-skin-sam">
<h3 class="firstContent">YUI Logger Output:</h3>
<div id="loggerDiv"></div>
</div>
<div id="examples">
<h3>YUI Loader Utility (beta) Examples:</h3>
<div id="exampleToc">
<ul>
<li><a href='../yuiloader/yl-basic.html'>Using YUI Loader to Load the Calendar Control</a></li><li><a href='../yuiloader/yl-insert.html'>Using YUI Loader to Place Additional Components on a Page</a></li><li class='selected'><a href='../yuiloader/yl-addmodule.html'>Using addModule to Add Custom (Non-YUI) Content with YUILoader</a></li><li><a href='../yuiloader/yl-list.html'>Use YUILoader to list requirements for a set of components.</a></li><li><a href='../layout/adv_layout.html'>Complex Application (included with examples for Layout Manager (beta))</a></li> </ul>
</div>
</div>
<div id="module">
<h3>More YUI Loader Utility (beta) Resources:</h3>
<ul>
<li><a href="http://developer.yahoo.com/yui/yuiloader/">User's Guide</a> (external)</li>
<li><a href="../../docs/module_yuiloader.html">API Documentation</a></li>
<li><a href="http://yuiblog.com/assets/pdf/cheatsheets/yuiloader.pdf">Cheat Sheet PDF</a> (external)</li></ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b" id="tocWrapper">
<!-- TABLE OF CONTENTS -->
<div id="toc">
<ul>
<li class="sect first">Yahoo! UI Library</li><li class="item"><a title="The Yahoo! User Interface Library (YUI)" href="http://developer.yahoo.com/yui/">Home (external)</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUIBlog (external)</a></li><li class="item"><a title="The Yahoo! Group YDN-JavaScript hosts the YUI community forum" href="http://tech.groups.yahoo.com/group/ydn-javascript/">YUI Discussion Forum (external)</a></li><li class="item"><a title="The YUI Library can be downloaded from SourceForge" href="http://sourceforge.net/projects/yui/">YUI on Sourceforge (external)</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../docs/index.html">API Documentation</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">Functional Examples</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License (external)</a></li><li class="sect">YUI Functional Examples</li><li class="item"><a title="The YUI Animation Utility - Functional Examples" href="../../examples/animation/index.html">Animation</a></li><li class="item"><a title="The YUI AutoComplete Control - Functional Examples" href="../../examples/autocomplete/index.html">AutoComplete</a></li><li class="item"><a title="The YUI Browser History Manager - Functional Examples" href="../../examples/history/index.html">Browser History Manager</a></li><li class="item"><a title="The YUI Button Control - Functional Examples" href="../../examples/button/index.html">Button</a></li><li class="item"><a title="The YUI Calendar Control - Functional Examples" href="../../examples/calendar/index.html">Calendar</a></li><li class="item"><a title="The YUI Charts Control - Functional Examples" href="../../examples/charts/index.html">Charts (experimental)</a></li><li class="item"><a title="The YUI Color Picker Control - Functional Examples" href="../../examples/colorpicker/index.html">Color Picker</a></li><li class="item"><a title="The YUI Cookie Utility - Functional Examples" href="../../examples/cookie/index.html">Cookie (beta)</a></li><li class="item"><a title="The YUI Connection Manager (AJAX) - Functional Examples" href="../../examples/connection/index.html">Connection Manager</a></li><li class="item"><a title="The YUI Container Family (Module, Overlay, Tooltip, Panel, Dialog, SimpleDialog) - Functional Examples" href="../../examples/container/index.html">Container</a></li><li class="item"><a title="The YUI DataTable Control - Functional Examples" href="../../examples/datatable/index.html">DataTable (beta)</a></li><li class="item"><a title="The YUI Dom Collection - Functional Examples" href="../../examples/dom/index.html">Dom</a></li><li class="item"><a title="The YUI Drag &amp; Drop Utility - Functional Examples" href="../../examples/dragdrop/index.html">Drag &amp; Drop</a></li><li class="item"><a title="The YUI Event Utility - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="The YUI Get Utility - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="The YUI ImageCropper Control - Functional Examples" href="../../examples/imagecropper/index.html">ImageCropper (beta)</a></li><li class="item"><a title="The YUI ImageLoader Utility - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="The YUI JSON Utility - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="The YUI Layout Manager - Functional Examples" href="../../examples/layout/index.html">Layout Manager (beta)</a></li><li class="item"><a title="The YUI Logger Control - Functional Examples" href="../../examples/logger/index.html">Logger</a></li><li class="item"><a title="The YUI Menu Control - Functional Examples" href="../../examples/menu/index.html">Menu</a></li><li class="item"><a title="The YUI Profiler Utility - Functional Examples" href="../../examples/profiler/index.html">Profiler (beta)</a></li><li class="item"><a title="The YUI ProfileViewer Control - Functional Examples" href="../../examples/profilerviewer/index.html">ProfilerViewer (beta)</a></li><li class="item"><a title="The YUI Resize Utility - Functional Examples" href="../../examples/resize/index.html">Resize (beta)</a></li><li class="item"><a title="The YUI Rich Text Editor - Functional Examples" href="../../examples/editor/index.html">Rich Text Editor (beta)</a></li><li class="item"><a title="The YUI Selector Utility - Functional Examples" href="../../examples/selector/index.html">Selector (beta)</a></li><li class="item"><a title="The YUI Slider Control - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="item"><a title="The YUI TabView Control - Functional Examples" href="../../examples/tabview/index.html">TabView</a></li><li class="item"><a title="The YUI TreeView Control - Functional Examples" href="../../examples/treeview/index.html">TreeView</a></li><li class="item"><a title="The YUI Uploader Utility - Functional Examples" href="../../examples/uploader/index.html">Uploader (experimental)</a></li><li class="item"><a title="The YUI YAHOO Global Object - Functional Examples" href="../../examples/yahoo/index.html">YAHOO Global Object</a></li><li class="selected "><a title="The YUI Loader Utility - Functional Examples" href="../../examples/yuiloader/index.html">YUI Loader (beta)</a></li><li class="item"><a title="The YUI Test Utility - Functional Examples" href="../../examples/yuitest/index.html">YUI Test</a></li><li class="item"><a title="YUI Reset CSS - Functional Examples" href="../../examples/reset/index.html">Reset CSS</a></li><li class="item"><a title="YUI Base CSS - Functional Examples" href="../../examples/base/index.html">Base CSS</a></li><li class="item"><a title="YUI Fonts CSS - Functional Examples" href="../../examples/fonts/index.html">Fonts CSS</a></li><li class="item"><a title="YUI Grids CSS - Functional Examples" href="../../examples/grids/index.html">Grids CSS</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li><li class="item"><a title="Best practices for working with web services while protecting user privacy" href="http://developer.yahoo.com/security/">Security Best Practices (external)</a></li></ul>
</div>
</div>
</div><!--closes bd-->
<div id="ft">
<p class="first">Copyright &copy; 2008 Yahoo! Inc. All rights reserved.</p>
<p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> -
<a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> -
<a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> -
<a href="http://careers.yahoo.com/">Job Openings</a></p>
</div>
</div>
<script src="../../assets/dpSyntaxHighlighter.js"></script>
<script language="javascript">
dp.SyntaxHighlighter.HighlightAll('code');
</script>
<script src='../../assets/YUIexamples.js'></script>
</body>
</html>