Class xataface.RecordBrowser

Basic Example
//require <RecordBrowser/RecordBrowser.js>
var RecordBrowser = XataJax.load('xataface.RecordBrowser');

// Now let's create a dialog to select records from the people table:
var dlg = new RecordBrowser({
    table: 'people',
	
    // A callback function to be called when the clicks "Select"
    callback: function(selected){
        var selectedString = [];
        $(selected).each(function(id,title){
            selectedString.push(id+' = '+title);
        });
        selectedString = selectedString.join('\n');
        alert("The following key/value pairs were selected: '+selectedString);
    }
});
dlg.display(); // Display the dialog

Example with Filters
The following example only includes a list of people in Canada over the age of 18

var dlg = new RecordBrowser({
    table: 'people',
    filters: {
       country: '=Canada',
       age: '>18'
    },
    callback: function(selected){
        // ... do stuff with selected values
    }
});
dlg.display();

Parameters:

{Object} o

Initialization parameters.

{String} o.table

The name of the table from which to browse records.

{String} o.value

The name of the column to use as the value in the option list. If this is left null, then the primary key will be used as the value.

{String} o.text

The name of the column to use as the title in the option list. If this is left null, then the record's title (i.e. the result of $record->getTitle()) will be used.

{Object} o.filters

Optional key-value pairs to be used to filter the results. This is handy if you only want the dialog to show certain records from the table.

{xataface.RecordBrowser.Callback} o.callback

A callback function that will be called after the user clicks "select" to close the dialog. An object with the key/value pairs of selected records will be passed to this callback function.