Uber List Plugin Documentation

Here we have a documentation view for Uber List and associated plugins and extensions.

Content Item Wrapper

Package:
Uber List
Plugin type:
Item Wrapper
Handle:
content
Description:
Use a content block template to wrap each list item. Wraps each templated list item with any regular content block template. Specify a template already provided for a content block and each list item will be wrapped by that template within Uber List.

Content With Alternate View Item Wrapper

Package:
Uber List
Plugin type:
Item Wrapper
Handle:
content_​with_​alt_​view
Description:
Use a content block template to wrap each list item, supplemented with an alternate layout. Wraps each templated list item with any regular content block template. Specify a template already provided for a content block and each list item will be wrapped by that template within Uber List. A second set of alternate layout parameters can be toggled using the Uber List Alt Toggle block and within the list item template assigning the classes list_​item_​element_​normal and list_​item_​element_​alt. A typical use is a list that can toggle between thumbnail and detail view, in the same way as a desktop file explorer.

Content With Class Item Wrapper

Package:
Uber List
Plugin type:
Item Wrapper
Handle:
content_​with_​class
Description:
Use a content block template to wrap each list item. Manage width and height using css classes. Wraps each templated list item with any regular content block template. Specify a template already provided for a content block and each list item will be wrapped by that template within Uber List. Unlike the regular content wrapper, this variation builds the css class uber_​list_​wrapper_​outer_​style and adds it to the header, then assigns that class to each list item wrapper (rather than using directly applied styles as the standard Content wrapper does). This can be easier to use where the theme also provides part of the list item styling and can be more efficient for some lists.

Direct HTML Item Template

Package:
Uber List
Plugin type:
Item Template
Handle:
direct_​html
Description:
Enter HTML as a template for each item. Directly enter HTML containing Magic Data tokens. Uber List will use that HTML as a template for each list item filling in any Magic Data tokens in the HTML for each list item in turn. The symbol UBER_​LIST_​ITEM tracks the value of the list item.

File Filter Index Data

Package:
Uber Filter
Plugin type:
Filter Index Data
Handle:
file
Description:
Index data for filtering files. Provides index data for files from the files search index table. File properties and attributes are only available if they are indexed for searching. Compatible with list context File.

Form Response Filter Index Data

Package:
Magic Data Forms
Plugin type:
Filter Index Data
Handle:
form_​response
Description:
Index data for filtering form responses. Provides Uber Filter indexing for form data accessed through Magic Data Forms. Compatible with list context Form Response.

No Wrapper Item Wrapper

Package:
Uber List
Plugin type:
Item Wrapper
Handle:
no_​wrapper
Description:
No wrapper, just what the list item template provides. No wrapping about the individual list items.

Page Filter Index Data

Package:
Uber Filter
Plugin type:
Filter Index Data
Handle:
page
Description:
Index data for filtering pages. Provides index data for pages from the page/collection search index table. Page properties and attributes are only available if they are indexed for searching. Compatible with list context Page.

qTip Item Wrapper

Package:
Magic Tipple
Plugin type:
Item Wrapper
Handle:
qtip
Description:
Wraps items to look like a qTip. Each item will be wrapped in a container to look like a qTip, but rendered inline in the page, not as a popup. Includes selection from all the qTip themes.

Stack Item Template

Package:
Uber List
Plugin type:
Item Template
Handle:
stack
Description:
Use a stack as a template for each list item. Select a stack by name and Uber List will use that stack as a template for each list item filling in all Magic Data tokens in the stack for each list item in turn. The symbol UBER_​LIST_​ITEM tracks the value of the list item.

Stack by Magic Data Item Template

Package:
Uber List
Plugin type:
Item Template
Handle:
stack_​by_​magic_​data
Description:
A Magic Data expression selects a stack for each item. Use a Magic Data expression to return a stack or provide an HTML fragment as a template. Where a stack requires javascript or css assets to be loaded, it should also be pre-selected and listed in the stack selection list. The symbol UBER_​LIST_​ITEM tracks the value of the list item.

Uber Filter Boolean Columns Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​boolean_​columns
Description:
Treat a selection of columns as boolean values and filter them with a list of checkboxes. Select data fields/columns to be used for boolean matching. This widget will show a list of checkboxes, one for each selected field. When these checkboxes are checked or cleared, the associated Uber List will be filtered by treating the associated field/column loosely as boolean data. When multiple checkboxes are selected, the logical relationship may be 'and' or 'or', requiring all checkboxes to match or any checkbox to match. An overall label for the control may optionally be given. By default, any list item where the filter data is null will always be included. However, this behaviour can be changed to always exclude, to be handled as an empty string, or to be considered equivalent to the first, last or median option value. The list can be shown in the field/column order, sorted, or reversed. The filter control shown on the page may optionally be expandable. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_BOOLEAN_COLUMNS_DEBUG to true.

Uber Filter Checkbox List Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​checkbox_​list
Description:
Match one or more checked values for dynamic filtering of an associated Uber List. Choose a single field/column and this widget will show a list of checkboxes to match field values. For many fields, the checkbox values and labels can be automatically created. Otherwise, the edit dialog provides an expanding list to define values and associated labels to use in a list. An overall label for the control may optionally be given. When multiple checkboxes are selected, the logical relationship may be 'and' or 'or', requiring all checkboxes to match or any checkbox to match. The list shown can be reduced by specifying a prefix/postfix/contains filter. In the case of prefix or postfix filters, the associated label will be presented with the prefix of postfix removed. By default, any list item where the filter data is null will always be included. However, this behaviour can be changed to always exclude, to be handled as an empty string, or to be considered equivalent to the first, last or median option value. The list can be shown in the field/column order, sorted, or reversed. The filter control shown on the page may optionally be expandable. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_CHECKBOX_LIST_DEBUG to true.

Uber Filter Checkbox Range Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​checkbox_​range
Description:
Match one or more checked ranges for dynamic filtering of an associated Uber List block. Handles numeric, sql-date or text ranges. Choose a single field/column and define an ascending list of limits to match against with associated labels. These will be shown as a list of checkboxes that, when selected, filter the list for values between the previous checkbox and the checked value. Comparisons handle numeric, sql-date or text ranges. An overall label for the control may optionally be given. By default, any list item where the filter data is null will always be included. However, this behaviour can be changed to always exclude, to be handled as an empty string, or to be considered equivalent to the first, last or median option value. The filter control shown on the page may optionally be expandable. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_CHECKBOX_RANGE_DEBUG to true.

Uber Filter Clear All Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​clear_​all
Description:
Provide a link or button to clear all filters. Adding this block will show a link or button to clear all filters asscociated with an Uber List. The label for the link or button may optionally be specified. The default block template shows a link. An optional block template shows a button. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_CLEAR_ALL_DEBUG to true.

Uber Filter External Connect Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​external_​connect
Description:
Create a link or button that connects to an Uber List / Uber Filter page with pre-set filter controls. This block can be placed on any page. When edited it provides inputs for parameter names and values that should match up with Uber Filter widgets on an Uber List page. This block renders to provide a link to Uber List page and will feed the search parameters to the named Uber Filter blocks. Association is made by the label attached to the filter blocks.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_EXTERNAL_CONNECT_DEBUG to true.

Uber Filter Linking Overlay Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​linking_​overlay
Description:
Provides a modal overlay for pages linking into an Uber List / Uber Filter page, to be shown immediately until the Uber Filter page loads. Adding this block provides a modal overlay with a configurable message. This will be shown from pages linking into an Uber List / Uber Filter page before the actual linked page is loaded.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_LINKING_OVERLAY_DEBUG to true.

Uber Filter Loading Overlay Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​loading_​overlay
Description:
Provides a modal overlay for the page while Uber Filter data is loading. Adding this block to an Uber List / Uber Filter page will show a modal overlay with a configurable message while filter data is loading. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_LOADING_OVERLAY_DEBUG to true.

Uber Filter Query Parameters Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​query_​params
Description:
Provide query parameters that can be used for linking to a specific Uber Filter As filters are applied, this block shows a URL that can be used to link into the page with those same filters already set. This takes precedence over the Uber Filter Sticky block. The filter control shown on the page may optionally be expandable. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_QUERY_PARAMS_DEBUG to true.

Uber Filter Require Fields/Columns Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​require_​columns
Description:
Select columns to be included in filter data. Filter fields/columns will normally be automatically detected from filter blocks on a page. Use this block on a page if filter blocks are declared in a stack and consequently their associated fields/columns are not automatically detected. You can also use this block in a stack to name an Uber List that other filter blocks in the stack need to conenct with.This block will have no visible presence, but will ensure the selected fields/columns are included in the filter data and that blocks in a stack can connect with an Uber List. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_REQUIRE_COLUMNS_DEBUG to true.

Uber Filter Search to Text Connect Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​text_​connect
Description:
Place on any page to enter a text search and transfer the search to an Uber List / Uber Filter page. This block can be placed on any page. It provides a text search input block that, when submitted, links to a page containing an Uber List with Uber Filters and will feed the text search parameters to the named Uber Filter text search block. Association is made by the label attached to the text search block.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_TEXT_CONNECT_DEBUG to true.

Uber Filter Select Limit Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​select_​limit
Description:
Match a selected limit for dynamic filtering of an associated Uber List block. Handles maximum and minimum numeric, sql-date or text limits. Choose a single field/column and define an ascending list of limits to match against with associated labels. These will be shown as a select control. The associated Uber List will be filtered using the selected value as a minimum or maximum. Comparisons handle numeric, sql-date or text ranges. An overall label for the control may optionally be given. By default, any list item where the filter data is null will always be included. However, this behaviour can be changed to always exclude, to be handled as an empty string, or to be considered equivalent to the first, last or median option value. The filter control shown on the page may optionally be expandable. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_SELECT_LIMIT_DEBUG to true.

Uber Filter Select Match Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​select_​match
Description:
Match a selected value for dynamic filtering of an associated Uber List. Choose a single field/column and this widget will show a select control. For many fields, the selectable values will be automatically created. Otherwise, the edit dialog provides an expanding list to define values and associated labels to use in a list. An 'All' option can be automatically prepended to the select. An overall label for the control may optionally be given. The list shown can be reduced by specifying a prefix/postfix/contains filter. In the case of prefix or postfix filters, the associated label will be presented with the prefix of postfix removed. By default, any list item where the filter data is null will always be included. However, this behaviour can be changed to always exclude, to be handled as an empty string, or to be considered equivalent to the first, last or median option value. The list can be shown in the field/column order, sorted, or reversed. The filter control shown on the page may optionally be expandable. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_SELECT_MATCH_DEBUG to true.

Uber Filter Select Multi Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​select_​multi
Description:
Match one or more selected values for dynamic filtering of an associated Uber List. Choose a single field/column and this widget will show a multiple select control. For many fields, the selectable values will be automatically created. Otherwise, the edit dialog provides an expanding list to define values and associated labels to use in a list. An overall label for the control may optionally be given. When multiple choices are selected, the logical relationship may be 'and' or 'or', requiring all options to match or any option to match. The list shown can be reduced by specifying a prefix/postfix/contains filter. In the case of prefix or postfix filters, the associated label will be presented with the prefix of postfix removed. By default, any list item where the filter data is null will always be included. However, this behaviour can be changed to always exclude, to be handled as an empty string, or to be considered equivalent to the first, last or median option value. The list can be shown in the field/column order, sorted, or reversed. The filter control shown on the page may optionally be expandable. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_SELECT_MULTI_DEBUG to true.

Uber Filter Sort Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​sort
Description:
Sort control for sorting an associated Uber List. Provides a select dropdown control to sort an associated Uber List. Set a list of fields to sort by, the direction of sorting and a label to use on the select dropdown. An overall label for the control may optionally be given. The filter control shown on the page may optionally be expandable. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_SORT_DEBUG to true.

Uber Filter Sticky Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​sticky
Description:
Makes the filter values associated with an Uber List sticky. Adding this block will save filter settings for an associated Uber List in a browser cookie. When a user returns to a page any previous filter settings will then be reapplied. This block doesn't actually show anything on the page. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_STICKY_DEBUG to true.

Uber Filter Text Filter Widget Block

Package:
Uber Filter
Plugin type:
Filter Widget Block
Handle:
jl_​uber_​filter_​text
Description:
Text input filter control for dynamic filtering with an associated Uber List. Select data fields/columns to be used for text searching. Text for an overall label, the search/clear buttons and a placeholder can be set. When there are multiple words in the text, the logical relationship may be 'and' or 'or', requiring all words to match or any word to match. The filter control shown on the page may optionally be expandable. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_FILTER_TEXT_DEBUG to true.

Uber List Alt Toggle Uber List Extension Block

Package:
Uber List
Plugin type:
Uber List Extension Block
Handle:
jl_​uber_​list_​alt_​toggle
Description:
Toggle list item elements for the Content With Alternate View wrapper. The Uber List Alternate View wrapper places the classes uber_​list_​wrapper_​normal_​view and uber_​list_​wrapper_​alt_​view on an Uber List. This block provides a control that simply toggles between these two classes when it is clicked. List item templates can then use the corresponding classes list_​item_​element_​normal and list_​item_​element_​alt to identify what parts of each list item are shown or hidden. Where there is more than one Uber List on a page, specifying an identifier that matches that given in the General Options tab of the Uber List will ensure that the correct list is associated. This is optional and when left blank a best guess will be made.
Diagnostics:
To enable diagnostics, set the site constant UBER_LIST_ALT_TOGGLE_DEBUG to true.

User Filter Index Data

Package:
Uber Filter
Plugin type:
Filter Index Data
Handle:
user
Description:
Index data for filtering users. Provides index data for users from the user search index table. User properties and attributes are only available if they are indexed for searching. Compatible with list context User.

Get this addon

You can get Uber List from the concrete5 marketplace

Documentation & Support

Addon pages - an Alternate List

Uber List generates the list below using the Magic Data expression: Each list item is templated using a stack containing 2 blocks. First a content ...... more.

Addon pages - Core Page List with Uber List template

This example shows a more radical use of Uber List. The Remote Settings template is used to transfer Uber List settings into a Page List with Uber ...... more.

Addon pages - Full Width List limited items

In this example the Uber List is truncated to the first 16 items to give a comparison against longer lists. Everything else is similar to the ...... more.

Addon pages - Full Width List with AJAX loading

In this example Uber List has been given an equal height items template that also uses Blocks By AJAX to asynchronously load the list. The styling ...... more.

Addon pages - Full Width List with direct loading

In this example Uber List has been given a template that is loaded directly and equalizes the height of the individual items. The styling and ...... more.

Addon pages - Plain Uber List

The Uber List shown on this page is set up to mimic the conventional page list on Addon pages - Core Page List with Default template, thus ...... more.

Combining lists

Here are a few snippets of Magic Data that can be used to combine lists in Uber List or anywhere else that evaluates Magic Data expressions. There ...... more.

Uber List

In addition to the User Guide, many of the pages beneath this page are examples of Uber List in action. The page list in the Sidebar on the right ...... more.

User Guide

Uber List comprises 4 main components: A dashboard page showing what Uber List compatible plugins are available. You don't need to know anything ...... more.