yui (advanced)

Saurabh Sahni YDN Developer, Hacker, Evangelist

YUI (ADVANCED)

Jai SanthoshYDN Engineer, Hacker, Frontend Guy

Yahoo!

What We’re Going to Cover

• Why YUI?

• Modularity

• YUI Infrastructure

• YUI Loader – Deep dive

• Extensibility– Native and Artificial Code Structuring

• YUI is Open!

http://yuilibrary.com/

• Why YUI?

• Modularity

• YUI is Open!

Good Architecture!!

What’s in Smart Software?

• Reliability

• Maintainability

• Compatibility

• Extensibility

• Why YUI?

• Modularity

• YUI is Open!

Javascript Modules

// yuiblog.com/blog/2007/06/12/module-pattern

myLibrary.fizzbuzz = (function () {var myPrivateVar = "Fizz";

return {fizzbuzz: myPrivateVar + "buzz";

};})();

YUIModules

// fizzbuzz.js

YUI.add("fizzbuzz", function(Y) {

// Private variablevar myPrivateVar = "fizz";

// Export as public varaibleY.fizzbuzz = myPrivateVar + "buzz";

YUIModules

// DOMYUI().use("node", function (Y) {......});

// Calendar widgetYUI().use("calendar", function (Y) {......});

// YQL clientYUI().use("yql", function (Y) {......});

• Why YUI?

• Modularity

• YUI is Open!

YUI Infrastructure• Attribute

• Base

• EventTarget

• Plugin

http://yuilibrary.com/yui/infrastructure/

• Base

• EventTarget

• Plugin

Y.Attribute// http://yuilibrary.com/yui/docs/attribute/#configurationYUI().use("attribute", function(Y) {

function MyClass(userValues) { // Use addAttrs, to setup default attributes for // your class, and mixing in user provided initial values var attributeConfig = { attrA : { // ... Configuration for attribute "attrA" ... }, attrB : { // ... Configuration for attribute "attrB" ... } }; this.addAttrs(attributeConfig, userValues);

Y.augment(MyClass, Y.Attribute);});

• Base

• EventTarget

• Plugin

Y.Base// http://yuilibrary.com/yui/docs/base/YUI().use("base", function(Y) { function MyClass(config) { // Invoke Base constructor, passing through arguments MyClass.superclass.constructor.apply(this, arguments); }

// Used to identify instances of this classMyClass.NAME = "myClass";

// "Associative Array", used to define the set of attributes

// added by this class.MyClass.ATTRS = { A : { // Attribute "A" configuration },

B : { // Attribute "B" configuration }};...

Y.Base...Y.extend(MyClass, Y.Base, { // Prototype methods for your new class // Tasks MyClass needs to perform during // the init() lifecycle phase initializer : function(cfg) { this._wrapper = Y.Node.create('<div

class="yui-wrapper"></div>'); },

// Tasks MyClass needs to perform during // the destroy() lifecycle phase destructor : function() { Y.Event.purgeElement(this._wrapper);

this._wrapper.get("parentNode").removeChild(this._wrapper);

this._wrapper = null; }

});});

• Base

• EventTarget

• Plugin

Y.EventTarget// http://yuilibrary.com/yui/docs/event-custom/YUI().use('event-custom', function (Y) { // EventTarget is available and ready for use.

// Add implementation code here.});

// Subscription callbacks receive fire() argumentsY.on('birthday', function (name, birthdate) { var age = new Date().getFullYear() - birthdate.getFullYear(); alert('Happy ' + age + ', ' + name + '!');});

// Fire EventsY.fire('birthday', { name: '"Uncle" Walt Whitman', birthdate: new Date(1819, 4, 31)});

• Base

• EventTarget

• Plugin

Y.Plugin// http://yuilibrary.com/yui/docs/event-custom/YUI().use('plugin', function (Y) {

// This AnchorPlugin is designed to be added to Node instances

function AnchorPlugin(config) { // Hold onto the host instance (a Node in this

case), this._node = config.host;}

// When plugged into a node instance, the plugin will be // available on the "anchors" property.AnchorPlugin.NS = "anchors";

AnchorPlugin.prototype = { disable: function() { var node = this._node; var anchors = node.queryAll("a"); anchors.addClass("disabled"); anchors.setAttribute("disabled", true); }};...

Y.Plugin...var container = Y.one("div.actions");

container.plug(AnchorPlugin);

container.anchors.disable();

container.unplug("anchors");

• Why YUI?

• Modularity

• YUI is Open!

• Async loading

• Dynamic dependency resolution

• On-demand module loading

• CSS support

• ... and more

YUI Loader

YUI Loader{

combine: true,comboUrl: 'http://yui.yahooapis.com/combo?',baseUrl: '3.4.1/build',modules: { },groups: {

ymaps: { combine: true, base: '/ajaxapi-4/modules/', comboBase: 'http://l.yimg.com/zz/combo?', root: 'a/lib/map/v4/4.0.0.579/modules/', modules: { }, patterns: {

'gallery-': {}}

YUI Loader – Module Options

• type• path• fullpath• requires• optional

• use• after• lang• condition

YUI Loadermodules: {

'ymaps-core': { path: 'ymaps-core/ymaps-core-min.js', requires: ['event'] }, 'ymaps-config': { path: 'ymaps-config/ymaps-config-min.js', requires: ['ymaps-core', 'intl'], lang: ['en-US', 'en-GB', 'es-ES', 'es-MX', 'es-US', 'fr-FR', 'fr-CA', 'it-IT', 'de-DE'] }, 'jQuery': { fullpath: 'http://ajax.googleapis.com/ajax/libs/jquery/1.5/jquery.min.js' },

YUI Loadermodules: {

'ymaps-stack': {use: ['node', 'event', 'event-custom']

}, 'gallery-graphics-vml': {

path: 'gallery-graphics-vml/gallery-graphics-vml-min.js', condition: {

test: function (Y) {var canvas =

document.createElement('canvas');return (!

document.implementation.hasFeature('http://www.w3.org/TR/SVG11/feature#BasicStructure', '1.1') && (!canvas || !canvas.getContext || !canvas.getContext('2d')));

},trigger: 'gallery-graphics',ua: 'ie',when: 'instead',

YUI Loader – Applying Config

• Instance Config

• YUI_config

• YUI.GlobalConfig

• YUI.applyConfig

YUI({ debug: true, combine: true, comboBase: 'http://mydomain.com/combo?', root: 'yui3/'}).use('node', function (Y) { // ...});

• Instance Config

YUI_config = { debug: true, combine: true, comboBase: 'http://mydomain.com/combo?', root: 'yui3/'};

• YUI_config

YUI.GlobalConfig = { debug: true, combine: true, comboBase: 'http://mydomain.com/combo?', root: 'yui3/'};

• YUI.GlobalConfig

YUI.applyConfig({ debug: true, combine: true});YUI.applyConfig({ comboBase: 'http://mydomain.com/combo?', root: 'yui3/'});

• YUI.applyConfig

• Why YUI?

• Modularity

• YUI is Open!

Good Extensibility=

Good Code Structure

• Pseudo-classical

• Prototypal

• Augmentation (Class A + Class B)

• Plugins

• Class extensions (mixins)

• MVC

Class Structure Strategies

Artificial

Native• Pseudo-classical

• Prototypal

• Augmentation

• Plugins

• Class extensions

• MVC

Class structure strategies

Native

• Pseudo-classical

• Prototypal

Pseudo-classical(Old school)

Pseudo-classical

function SubClass() { // constructor}

SubClass.prototype = new SuperClass();

SubClass.prototype.someProperty = "booga!";SubClass.prototype.someMethod = function () { ... };...

SubClass.someStaticMethod = function () { ... };...

Y.extend = function (SubClass, SuperClass, proto, static);

Y.extend(SubClass, SuperClass);

SubClass.prototype.someProperty = "booga!";SubClass.prototype.someMethod = function () { ... };...

Y.extend = function (SubClass, SuperClass, proto, static)

Pseudo-classical

Y.extend(SubClass, SuperClass, { someProperty: "booga!", someMethod : function () { ... }, ...});

Pseudo-classical

Y.extend(SubClass, SuperClass, { someProperty: "booga!", someMethod : function () { ... }, ...}, { someStaticMethod: function () { ... }, ...});

Pseudo-classical

Y.SubClass = Y.extend( function() { // constructor }, /* extends */ SuperClass, { // Instance members someProperty: "booga!", someMethod : function () { ... } }, { // Static members someStaticMethod: function () { ... } });

Pseudo-classical

Y.extend() PROs

• Creates a “clean” subclass relationship

• no YUI class requirement

• Preserves instanceof

• SubClass.superclass (not super, but close)

• Control superclass constructor execution

Y.extend() CONs

• No multiple inheritance

• Manual constructor chaining required

• Constructor chaining is awkward

• Constructor chaining may be costly

• Manual constructor chaining required

• Constructor chaining is awkward

• Constructor chaining may be costly

function SubClass() { // Chain superclass constructor SubClass.superclass.constructor.apply(this, arguments); // My constructor stuff ...}

AWKWARDCOSTLY?

Y.extend() CONs

To sum up

• Good for basic class inheritance

• If you can extend Y.Base, there are more options

Prototypal

Y.extend = function(SubClass, SuperClass,...) { var superProto = SuperClass.prototype, subProto = Y.Object(superProto);

SubClass.prototype = subProto; ...

Y.extend = function(SubClass, SuperClass,...) { var superProto = SuperClass.prototype, subProto = Y.Object(superProto);

SubClass.prototype = subProto; ...

Prototypal

Y.Object = (function () {

function F() {} return function (obj) { F.prototype = obj; return new F(); };

Prototypal

// Old and bustedSubClass.prototype = new SuperClass();

Constructor

SuperClass

Prototype{}

Constructor

SubClass

Prototype

f(n)Constructor

SuperClass

Prototype

Constructor

Prototype{}

Prototypal

EMPTY Constructor

(anon)

Y.Object = (function () { function F() {} return function (obj) { F.prototype = obj;’

return new F(); };})();

Constructor

SuperClass

Prototype

Constructor

SubClass

Prototype

{}Prototype

{}Prototype{} {}

Prototype

EMPTY Constructor

(anon)

Prototype

EMPTY Constructor

Prototypal

Y.Object = (function () { function F() {} return function (obj) { F.prototype = obj; return new F(); };})();

Any Object

EMPTY Constructor

(anon)f(n)

New Object{} {}

Prototype

EMPTY Constructor

(anon)f(n)

Prototype

Prototypal

Factory constructor

function Set() { var that = (this instanceof Set) ? this : Y.Object(Set.prototype); // use that instead of this [].push.apply(that._items, arguments); return that;}

var set = new Set(‘a’,’b’);

Factory constructor

var set = new Set(‘a’,’b’);

set instanceof Set; // true

Factory constructor

var set = Set(‘a’,’b’); // <-- OOPS! I forgot 'new'!

Factory constructor

var set = Set(‘a’,’b’);

set instanceof Set; // true

Factory constructor

Y.Object() PROs

• Avoids copying a lot of properties

• Can be used to make factory constructors

• Can be used to store original values for revert

• Any object can be the prototype

• Avoids class explosion

Y.Object() CONs

• Factory constructor can promote sloppiness

• Can’t use hasOwnProperty in for/in loops

To sum up

• Useful for some internal logic patterns

• Not a good fit for most web app problems

• Common use suggests need for a constructor

To sum up

var account1 = Y.Object(accountProto);account1.id = 1234;account1.holder = 'John Q. Consumer';

var account2 = Y.Object(accountProto);account2.id = 1235;account2.holder = 'Jane B. Investor';

To sum up

var account1 = Y.Object(accountProto);account1.id = 1234;account1.holder = 'John Q. Consumer';

var account2 = Y.Object(accountProto);account2.id = 1235;account2.holder = 'Jane B. Investor';

CONSTRUCTOR

To sum up

function Account(id, holder) { this.id = id; this.holder = holder;}

var account1 = new Account(1234, 'John Q. Consumer');var account2 = new Account(1235, 'Jane B. Invester');

Native✓ Pseudo-classical

✓ Prototypal

Artificial

• Augmentation

• Plugins

• Class extensions

• MVC

Augmentation

Y.ModelList = Y.extend( function () { /* constructor */ ModeList.superclass.constructor.apply(this, arguments); },

Y.Base,

{ /* prototype */ }, { /* static */ }); Y.augment(Y.ModelList, Y.ArrayList);

Y.augment = function (to, from, force, whitelist, config)

Y.Base,

Augmentation

Y.Base,

Augmentation

ModelList

Prototype

Constructor

create

Y.augment(Y.ModelList, Y.ArrayList);

var list = new Y.ModelList({ ... });

list.each(function (item) { ... });

ModelList

Prototype

Constructor

create

ArrayList

Prototype

Constructor

Prototype

create

itemPrototype

Constructor

augment

Augmentation

ArrayList

Prototype

Constructor

Y.augment(Y.ModelList, Y.ArrayList);

var list = new Y.ModelList({ ... });

list.each(function (item) { ... });

ModelList

Prototype

Constructor

create

Prototype

Constructoreach 1. Copy

2. Construct

3. Execute

Augmentation

Y.augment(Y.HistoryBase, Y.EventTarget, null, null, { emitFacade : true, prefix : 'history', preventable: false, queueable : true});

Augmentation

Y.augment() PROs

• Defers constructor overhead

• Can augment with multiple classes

• Supports class or instance augmentation

• No YUI class requirement

Y.augment() CONs

• First augmented method call is costly

• instanceof is false for augmenting classes

• Consumes more memory

• Limited control of constructor invocation

To sum up

• Use it to simulate lazy multiple inheritance

• Y.Base-based classes should use class extensions

• Beware the diamond problem

• Weigh the importance of constructor deferral

To sum up

• Use it to simulate lazy multiple inheritance

• Y.Base-based classes should use class extensions

• Beware the diamond problem

• Weigh the importance of constructor deferral

Y.SubClass = Y.extend( function () { Y.SuperClass.apply(this, arguments); Y.EventTarget.apply(this, { /* config */ }); }, Y.SuperClass, // <-- one "official" extention class Y.mix({ /* prototype */ }, Y.EventTarget.prototype), { /* static */ });

Plugins

Aa a aa

Pluginsvar overlay = new Y.Overlay({ ... });

overlay.plug(Y.Plugin.Drag);

overlay.dd.set('lock', true);

overlay.unplug('dd');

var overlay = new Y.Overlay({ ... });

Overlay

Attributes

Constructor

Overlay

Constructoroverlay

Attributes

Constructor

Plugins

overlay

Attributes

Overlay

Constructor

Plugin.Drag

Attributes

Constructor

Plugin.Drag

Constructor

overlay.ddAttributes

lock Constructordd

Plugins

Overlay

Constructor

Plugin.Drag

Constructor

overlay

Attributes

Plugins

Overlay

Constructor

Plugin.Drag

Constructor

overlay

Attributes

Plugins

The requirements

• Y.Plugin.Host (free in Y.Base, or add with Y.augment)

Host class

Plugin class

• Static NS property

That’s it

Plugins (instance)

Y.Plugin.Host.prototype.plug = function (Plugin, config) { ... if (Plugin && Plugin.NS) { config.host = this; this[Plugin.NS] = new Plugin(config); }};

Plugins (instance)

Y.Plugin.Host.prototype.plug = function (Plugin, config) { ... if (Plugin && Plugin.NS) { config.host = this; this[Plugin.NS] = new Plugin(config); }};

The contract

SHOULD✓ Expect an object

constructor argument with ‘host’ property

✓ Provide namespaced API✓ Modify core behavior via

events or AOP

MAYSHOULD✓ Expect an object

The contract

events or AOP

MUST✓ Remove all traces when

unplugged

The contract

events or AOP

MUST✓ Remove all traces when

unplugged

MUST NOT✓ Modify host directly other

than add the namespace

The contract

Plugins (class)

Y.Plugin.Host.plug(Y.Overlay, Y.Plugin.Drag, { handles: ['.yui3-widget-hd']});

Plugin PROs

• Avoids method/property naming collisions

• Preserves host behavior when unplug()ed

• Plug classes or instances

• Generic plugins can work for multiple host types

• Works on Nodes

Plugin CONs

• Fragments API

• Plugin contract to restore host can add code weight

• Difficult to manage competing plugins

• plug() could use a little sugar

To sum up

• Flexible

• Better in smaller numbers

• Class Plugins vs Augmentation?

• Free with Y.Base-based classes and Y.Nodes

(have I mentioned that you should use Y.Base?)

Class Extensions

Y.Base

Class extensionsY.extend = function (SubClass, SuperClass, proto, static)

Y.SubClass = Y.extend(

{ someProperty: ‘booga!’, someMethod : function () { ... } }, {

function() { SubClass.superclass.constructor.apply(this, arguments); },

/* extends */ Y.Base

NAME: ‘subsub’,

[], // <-- class extensions!

/* NAME */ ‘subsub’,

Y.Base.create = function(NAME, SuperClass, ext, proto, static)

ATTRS: { ... } });

Class extensionsY.Base.create = function(NAME, SuperClass, ext, proto, static)

Y.LineSeries = Y.Base.create('lineSeries', Y.CartesianSeries, [ Y.Lines ],

{ /* Glue Y.Lines APIs to Y.CartesianSeries APIs */ });

Y.ComboSeries = Y.Base.create('comboSeries', Y.CartesianSeries, [ Y.Fills, Y.Lines, Y.Plots ],

{ /* Glue Y.Fills etc APIs to Y.CartesianSeries APIs */ }, { ATTRS: { ... } });

Class extensions

Y.ComboSeries = Y.Base.create('comboSeries', Y.CartesianSeries, [ Y.Fills, Y.Lines, Y.Plots ],

{ /* Glue Y.Fills etc APIs to Y.CartesianSeries APIs */ }, { ATTRS: { ... } });

Class extensions

LineSeries

Y.LineSeries = Y.Base.create('lineSeries', Y.CartesianSeries, [ Y.Lines ], { ... });

var series = new Y.LineSeries({ ... });

LinesConstructor

ConstructorConstructor

Prototype

CartesianConstructor

Prototype

Constructor Constructor

Class extensions

LineSeries

Prototype

ConstructorConstructor

Constructor

LinesConstructor

Prototype

direction

LinesConstructor

Prototype

Class extensions

LineSeries

Prototype

Constructor

Prototype

direction

LinesConstructor

Prototype

typedirection

+styles

Class extensions

LinesConstructor

Prototype

LinesConstructor

Prototype

drawLines

LineSeries

Prototype

Constructor

Prototype

direction

stylesATTRS

Prototype

Class extensions

LinesConstructor

Prototype

drawLines

LineSeries

Constructor

Prototype

drawPrototype

drawdrawLines

drawSeries

Class extensions

LinesConstructor

Prototype

drawLines

LineSeries

Constructor

Prototype

initializer

Prototype

initializerinitializer

initializer

Class extensions

1. Constructors are called

2. Attributes are set

3. initializers are called

Class extensions

Two types of extensions

• Class decoration

• Core functionality

Add feature APIs and Attributes

Satisfy abstract class implementation

Y.Overlay = Y.Base.create('overlay', Y.Widget, [ Y.WidgetStdMod, Y.WidgetPosition, Y.WidgetStack, Y.WidgetPosition, Y.WidgetPositionConstrain]);

Class extensions

Y.Base.mix = function(Class, ext)

Y.Slider = Y.Base.create('slider', Y.SliderBase,[Y.SliderValueRange]);

Y.Base.mix(Y.Slider, [Y.ClickableRail]);

Class extensions

Extensions PROs

• Promotes code reuse across environments

• Feature APIs are added to the prototype

• Can be used to mimic MVC breakdown

Extensions CONs

• Requires Y.Base

• Initialization overhead

• Class definition only (no instance feature additions)

• Does not work on Nodes

• Increased potential for accidental name collisions

Extension vs Plugin

• Extensions can be used to contribute core behavior

• Extensions modify the class prototype, plugins are always namespaced

• Feature extension constructors are always executed, plugin constructors on plug()

• Feature APIs/attributes on the prototype vs class plugins in namespace is a stylistic choice

• Why YUI?

• Modularity

• YUI is Open!

YUI is Open!!

• Open Source

• Open CDN

• Open Hours

• Open Communication

• Open Development

• Open Documentation

References

• http://yuilibrary.com/

• Images from Google, Flickr

• http://www.youtube.com/yuilibrary

• Inheritance Patterns by @ls_n

Questions?

• Slides at http://slideshare.net/jaisanth

• Twitter: @jaisanth

• IRC freenode: #yui

THANK YOU!

yui (advanced)

yui loadermodules

function y

yui loader async

attribute http

base http

eventtarget http

var node

public varaible y

Technology

yui basics

yui introduction @ nctu

yui lyrics

yui 2.7 cheat sheets concatenated

introducing yui 3 autocomplete

symfonycamp - yui 2008

catalogo yui

yui guhguyg

konfucii lun yui

2009 hackday taiwan yui

essential yui

yui tidbits

yui app-framework

que es yui

yui on rocket

josephj yui nctu 2

circuito yui group

yui hidden gems

yui 3: events evolved

spa yui - cpasrl