Getting a Script File with YUI Get : YUI « YUI Library « JavaScript DHTML






Getting a Script File with YUI Get

 


<!--
Software License Agreement (BSD License)
Copyright (c) 2009, Yahoo! Inc.
All rights reserved.

Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and the
      following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    * Neither the name of Yahoo! Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Sources of Intellectual Property Included in the YUI Library

YUI is issued by Yahoo! under the BSD license above. Below is a list of certain publicly available software that is the source of intellectual property in YUI, along with the licensing terms that pertain to thosesources of IP. This list is for informational purposes only and is not intended to represent an exhaustive list of third party contributions to the YUI.

    * Douglas Crockford's JSON parsing and stringifying methods: In the JSON Utility, Douglas Crockford's JSON parsing and stringifying methods are adapted from work published at JSON.org. The adapted work is in the public domain.
    * Robert Penner's animation-easing algorithms: In the Animation Utility, YUI makes use of Robert Penner's algorithms for easing.
    * Geoff Stearns's SWFObject: In the Charts Control and the Uploader versions through 2.7.0, YUI makes use of Geoff Stearns's SWFObject v1.5 for Flash Player detection and embedding. More information on SWFObject can be found here (http://blog.deconcept.com/swfobject/). SWFObject is (c) 2007 Geoff Stearns and is released under the MIT License (http://www.opensource.org/licenses/mit-license.php).
    * Diego Perini's IEContentLoaded technique: The Event Utility employs a technique developed by Diego Perini and licensed under GPL. YUI's use of this technique is included under our BSD license with the author's permission.

-->

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>


    <meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Quickstart Example: Getting a Script File with YUI Get</title>

<style type="text/css">
/*margin and padding on body element
  can introduce errors in determining
  element position and are not recommended;
  we turn them off as a foundation for YUI
  CSS treatments. */
body {
  margin:0;
  padding:0;
}
</style>

<link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/fonts/fonts-min.css" />
<link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/button/assets/skins/sam/button.css" />
<script type="text/javascript" src="yui_2.7.0b-lib/yuiloader-dom-event/yuiloader-dom-event.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/element/element-min.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/button/button-min.js"></script>


<!--begin custom header content for this example-->
<style type="text/css">
  #returnedData {background-color:#0000ff; color:#ffffff; padding:1em; margin-top:1em; white-space:normal;}
</style>

<!--end custom header content for this example-->

</head>

<body class=" yui-skin-sam">


<h1>Quickstart Example: Getting a Script File with YUI Get</h1>

<div class="exampleIntro">
  <p>This example explores the simplest and most common use case for the <a href="http://developer.yahoo.com/yui/get">YUI Get Utility</a>: fetching a script with <code>YAHOO.util.Get.script()</code> and making use of its contents.</p>

<p>Click the button to retrieve the script and output its data to the blue box.  The tutorial below gives you a full description of how to use this technique.</p>      
</div>

<!--BEGIN SOURCE CODE FOR EXAMPLE  -->

<div>
  <button id="getScript">Get Data from Script</button>
</div>

<pre id="returnedData">
  Data returned from the loaded script will appear here after you click the button above.
</pre>

<script language="JavaScript">
(function() {
  
  //We'll use a YUI Button to actuate our request for the script:
  var button = new YAHOO.widget.Button("getScript", {type: "link"});
  
  //When the button is clicked, we'll make the script request:
  button.on("click", function() {
    
    YAHOO.log("Button was clicked; loading script with Get Utility.", "info", "example");

    //We have a .js file at yui_2.7.0b-assets/get-assets/simple_get.js.  We will get
    //that script with the Get Utility:
    YAHOO.util.Get.script("yui_2.7.0b-assets/get-assets/simple_get.js", {
      
      //ALL OF THE CONFIGURATION OPTIONS BELOW ARE OPTIONAL;
      //IN MANY CASES, YOU'LL NEED ONLY TO DEFINE YOUR SUCCESS/
      //FAILURE HANDLERS.
      
      //callback to fire when the script is successfully loaded:
      onSuccess: function(obj) {
        YAHOO.log("Success handler was called. Transaction ID: " + obj.tId, "info", "example");
        document.getElementById("returnedData").innerHTML = YAHOO.lang.dump(YAHOO.simple_get.data, 3);
      },
      
      //callback to fire if the script does not successfully load:
      onFailure: function(o) {
        YAHOO.log("Failure handler was called. Transaction ID: " + obj.tId, "info", "example");
      },
      
      //context under which success and failure handlers should run;
      //default is the current window, which we'll use for this example:
      scope: window,
      
      //by default, the script will be added to the current
      //window; use this property to override that default
      //(we're just using the default in this example):
      win: window,
      
      //will be passed as a member of the callback object to
      //the success or failure handler:
      data: {testData: "value"},
      
      //For Safari 2.x, which does not support the script's onload
      //event to determine when the script is loaded; instead, Get
      //will check for the presence of this varName (which is
      //defined in the script we're retrieving) and use its presence
      //to determine when the script has been successfully loaded:
      varName: ["YAHOO.simple_get.data"]
    });
    
  });
  
})();
</script>
<!--END SOURCE CODE FOR EXAMPLE  -->

</body>
</html>
<!-- presentbright.corp.yahoo.com uncompressed/chunked Thu Feb 19 10:53:15 PST 2009 -->

   
  








yui_2.7.0b.zip( 4,431 k)

Related examples in the same category

1.Looks at the "standard module format" used by many components in YUI to represent modular content on the page.
2.Type-Checking Your Data
3.Adding new object members during parsing
4.Retrieving a Yahoo! Weather RSS Feed
5.Use YAHOO.env.ua to identify the user's browser and to branch JavaScript logic based on what browser is being used.