Master/Detail

The master detail concept is that you have a master list in one panel, and the details of items in the list in another panel. This prevents the back and forth of stepping in and out of multiple records to find thing you want. Many users are familiar with this model from applications like Outlook or other email programs.

Documentation

This is a quick stab at some rough documentation. Ask about what you don't know so we can know how to expand it. Below is a list of accepted options and a few of the methods you are likely to care about.

Options/Methods

Name	Type	Default	Options	Description
detailLink	string	a		selector for where the link to the detail is
focusKeyboard	boolean	true		should we trap the keyboard right off the bat for navigating the master list
filter	string			selector of where the optional filter field is
loaderID	string	md-loading		id of the element used to show the loading indicator (created by script)
loaderText	string	Loading		text used to display in the loading indicator
hashLabel	string	detail		ID of the element where the detail should be loaded into. also used to create the hash in the URL for history tracking.
casheResults	boolean	true		should the script cache the results of ajax requests for details
hashLabel2	string			optional hashLabel for a sub-master so we can set it to 0 on it's initial load
masterParent	string			optional hashLabel/ID for a parent detail
masterChild	string			optional hashLabel/ID for a child detail
loadFirst	boolean	true		should the script load the first row of the master list if none are marked as selected or defined in the URL
selectedClass	string	selected		class to use on selected rows
onloaddetail	function			callback that fires when the detail is loaded
getSelectedRow	method			returns the row (object) that is currently selected
getSelectdRowID	method			returns the ID of the row that is currently selected
clearCache	method			clears the cache. if an ID is provided it clears only the cache for that ID
rowCreate	method			expects rowID, data, dontFollow(optional). rowID = the ID the row should be given. data = a JSON object as shown here http://datatables.net/api for fnAddData, dontFollow = only add the row don't click it
rowDestroy	method			expects rowID, gotoID(optional) rowID = id of row we are destroying, gotoID = id on the page we should then fire a click event on (to load another page, etc)

Options Column = The script only recognizes these values