___________          .__         .__  .__          __
 /   _____/  | __ ____ |  |   ____ |  | |__| _______/  |_
 \ _____  \|  |/ // __ \|  | _/ __ \|  | |  |/  ___/\   __\
 /        \    <\  ___/|  |_\  ___/|  |_|  |\___ \  |  |
/_______  /__|_ \\___  >____/\___  >____/__/____  > |__|
        \/     \/    \/          \/             \/

v3.7.13

0 INTRO

Skelelist package is part of the Skeletor project and is not meant be used alone.

Inside a Skeletor app this package is used to build list views; it supports pagination and actions on each record; it has many different options and it's extensible

1 SCHEMA OPTIONS

__listView: [object] (optional) skelelist options; (not needed if skelelist is not used for this chema);

• style: *[string] (mandatory)*type of list to create; default "table";
• options: [object] (optional) dictionary of options for the listView;
  • pagination: [pagination] (boolean) tells Skelelist to paginate documents in the current view; (default false, all documents loaded together);
  • itemsPerPage: [integer] (optional) number of documents to load per time; (default 10);
  • autoLoad: [boolean] (optional) tells Skelelist to load more documents in a paginated list when the "load more" placeholder comes into view automatically (default false);
• sort: [object] (optional) dictionary of sort options; each element is an object with the following properties:
  • direction: [1 / -1] (mandatory) the direction of the sort (1 = crescent, -1 = decreasing);
  • caseInsensitive: [boolean] (optional) if true sort case insensitive;
• classes: [string] (optional) CSS classes to assign to the listView;
• info: [object] (optional) dictionary of options for the main list toolbar;
  • showTotalNumber: [boolean] (optional) decides if total number of documents has to be displayed (default true);
• itemFields: [array of objects] (mandatory) dictionary of fields to use in the listView; each object can have the following properties:
  • name: [string] (mandatory) the name of the field; must match the name defined on the field's object in the fields array of the schema;
  • link: [boolean] (optional) defines if the field should be show as a link to the form view of the current record;
  • allowUndefined: [boolean] (optional) allow the document to be displayed in the list also if the current field has value undefined (normally documents with undefined values needed for the list view are stripped out); (default false);
• itemActions: [array of objects] (mandatory) dictionary of actions to use for each document in the list; (built in actions: "delete", "changePassword"); please see below for detail infos about every action object;
• detailLink: [object] (mandatory) definition of the link for detail view
  • basePath: [string] (mandatory) the path definition for the link (can contain ":" params); the special param :itemLang is also available and refers to the record's language (ex.: /panel/pages/:itemLang/:code);
  • params: [array of strings] (optional) list of the params used in the previous basePath; every param must be a field's name or the special param itemLang that refers to the record's current language;
• sourcedFields: [object] (optional) dictionary of fields used in itemFields that are external links to other documents; each element is an [object] with the field's name as key and these properties:
  • mapTo: [string] (mandatory) name of the attribute in the external document to use;
  • schemaName: [string] (mandatory) name of the schema that describes the external document;
• callbacks: [object] (optional) dictionary of callbacks to perform on every record while rendering Skelelist
  • beforeRendering(currentRecord): [function] (optional) a function called on every record rendered by Skelelist; can edit the record itself before returning it; in particular it can append to the record the "skelelistOptions" object that is evaluated by Skelelist to perform special tasks (see below);

2 SKELELIST OPTIONS

The "skelelistOptions" object can be appended by a skelelist callback to the current record before it is rendered; this are its available properties to set:

• skelelistOptions: [object] (optional) dictionary of options evaluated by Skelelist before rendering the current record;

  • class: [string] (optional) class to append to the current record's row;
  • actions: [object] (optional) dictionary of actions to disable; to disable an action defined on the itemActions array, set it to false on this object; ex. to disable the "delete" button on the current record:

  actions: { delete: false }

usecase: assign secondColor class to the "SUPERUSER" role in roles list

__listView {
    ...

    callbacks: {
        beforeRendering: function(listRecord) {
            'use strict';
            // forbid delete button for the SUPERUSER role
            if (listRecord.name === 'SUPERUSER') {
                listRecord.skelelistOptions = {
                    class: 'secondColor',
                    actions: {
                        delete: false
                    }
                };
            }

            return listRecord;
        }
    }
}

3 ITEM ACTIONS

"itemActions" field is a dictionary of actions to display on every row.

3.1 Generic options (available for all actions)

• name: [string] (required) the name of the action to render; Skelelist will try to render the component named: "skelelistAction" + name.capitalize();
• permission: [string/array of strings] (optional) needed permissions to see the action button (this have effect only on button's visibility, if the action itself requires any kind of validation, the user will need to have the necessary permissions);

3.2 Action specific options:

delete

• confirm: [boolean/object] (optional) defines if the delete action must ask a confirmation; can be set to true to use defaults or can be an object that can specify all the available options; (default to false);
  • template: [string] (optional) name of the component to use as confirmation UI; available values: "skelelistActionDeleteConfirm", "skelelistActionDeleteTimerConfirm"; (default to skelelistActionDeleteTimerConfirm);
  • timeout: *[number] (optional, available only if template = "skelelistActionDeleteTimerConfirm"); number of milliseconds to use as timeout to confirm deletion (default 3000); must be a multiple of 1000, max 100.000;

4 SCHEMA FIELDS OPTIONS

4.1 Generic options (available for all kind of fields)

• __listView: [object] (optional) options for the field in the list view:
  • stripHTML: [boolean] (optional) set to true to strip out HTML from the value (default false);
  • truncate: [object] (optional) dictionary of options for truncation:
    • max: [integer] (optional) number of characters to keep (default all);
    • suffix: [string] (optional) suffix to append to the string when truncation happens (default [...]);
  • transform(value, document): [function] (optional) a callback invoked on the field that receives the current field's value and the current document as parameters; it is supposed to perform necessary display transformation and must return the value to be displayed;
  • customEmptyString: [string] (optional) a custom i18n string to use when the field's value is empty/undefined (default none_lbl);

5 TROUBLESHOOTING

Experimenting errors in your list view? Try the followings:

• double check your schema structure and that you have included all required keys for every form and field objects.

• write an issue ;)