Gallery

Modules

Documentation

Context Navigation

YUI Library is not responsible for bugs or support with this module. It is available as a free service. For support please contact the module owner with the provided links.

Recordset Storage Lite Plugin (gallery-recordset-storage-lite) on cdn

Last Updated: 06/23/12

+ 0 -

Steven Olmsted

YUI Contributor

See 42 more by this user.

Created: 03/30/11
Last CDN Push: 04/6/11
Build Tag: gallery-2011.04.06-19-44
Project: YUI 3
License: YUI BSD
YUI Version: 3.3.0
Free for use.

This is a plugin for Recordset which uses Storage Lite to store records on the client.

Download
Docs
Homepage
Bugs
Source
Example
Forum
History

Y.Plugin.RecordsetStorageLite is a plugin for Y.Recordset.

Once the plug method has been called on a Y.Recordset instance, the storageLite property will be available for accessing the Y.Plugin.RecordsetStorageLite instance.

Each Y.Plugin.RecordsetStorageLite instance has two public events.
failure: fired when the store method catches an exception. This probably means local storage is out of storage space. The error object is passed as a parameter.
store: fired when the store method stores records. The key and records array are passed as parameters.

Each Y.Plugin.RecordsetStorageLite instance has one public method.
store: requires a string key where to store the records.

Once stored, a records array can be retrieved using Storage Lite:
var records = Y.StorageLite.getItem(key, true);

This can be passed back into a Y.Recordset:
var recordset = new Y.Recordset({records: records});

If a recordset was not previously stored at key, records will be null.

Code Sample

<script src="http://yui.yahooapis.com/3.3.0/build/yui/yui-min.js"></script>

YUI({
    //Last Gallery Build of this module
    gallery: 'gallery-2011.04.06-19-44'
}).use('gallery-recordset-storage-lite', 'recordset', function(Y) {
    Y.StorageLite.on('storage-lite:ready', function () {
        // Get Stored Records
        var records = Y.StorageLite.getItem('recordsetName', true),
            recordset;
 
        if (!records) {
            // Records Weren't Stored :(
            // Use Default Records
            records = [{
                a: 3, b: 2, c: 1
            }, {
                a: 9, b: 8, c: 7
            }, {
                a: 1, b: 2, c: 3
            }];
        }
 
        // Create Recordset
        recordset = new Y.Recordset({
            records: records
        });
 
        // Add Plugin
        recordset.plug(Y.Plugin.RecordsetStorageLite);
 
        // Store Records
        recordset.storageLite.store('recordsetName');
    });
});

Forum Posts

No forum posts for this module.