Admin

Initialize the state of the component

An event listener that listens to actions selected.

An event listener that listens to state changes in the display type i.e. from list to add/change. It is fired after state changes are made.

An event listener that listens to state changes in the display type i.e. from list to add/change . It is fired before state changes are made.

Gets an actions object whose properties are action names and values are action methods. This can be overridden by the action member variable. The default "delete" method is not implemented.

Each actions object property (e.g. "delete") is passed an array of selected objects. One can then handle those objects. Actions will appear on the list display page within a dropdown. Selecting an action should have the action method applied to all currently selected objects.

Example:

actions = { "delete" : (selected_objects)=>{ } }

Returns an object whose properties are extra field names not corresponding to properties of any object in the queryset and whose values are display functions. This will create extra fields that are not tied to objects. Extra fields have to be manually included in the list_display in order to appear in the list display page. The display functions take the current object being rendered in the table row and the field name

Example:

get_extra_fields()
{
return { 'now' : function(object,label)
                  {
                     return moment(new Date()).format('LLL');
                  }
        }
}

Returns an object whose properties are field names corresponding to properties of any object in the queryset and whose values are transform functions. The example below will transform each "name" property of objects in the queryset to upper case in the list display view.

Example:

get_field_transforms()
{
return { 'name' : function(name,object)
                  {
                      return name.toUpperCase()
                  }
        }

}

This functions returns a JSON Schema Form for editing the objects in the array returned by get_queryset(). This method needs to be overridden to so as to return a Form Component for the object. Learn more on JSON schema forms from https://github.com/mozilla-services/react-jsonschema-form and JSON Schema from https://spacetelescope.github.io/understanding-json-schema/

Returns an object whose properties are field names corresponding to properties of any object in the queryset and whose values are transform functions. The example below will transform the header "name" to upper case in the list display view.

Example:

get_header_transforms()
{
return { 'name' : function(name)
                  {
                      return name.toUpperCase()
                  }
        }
}

Gets the list/array of properties/field names of the objects in the queryset to be displayed on the list display page. It can be overridden by the member variable listdisplay. A property is any string that should exist in the objects within a queryset and works with lodash's .at function. See more at https://lodash.com/docs/#at

Example:

  let object={ name : "any name",{ address : { street : "any"}},emails: ["any@any.com"]}

  The properties "name","address.street" and "emails[0]" are all acceptable

Gets the list/array of properties of the objects in the queryset that are clickable when displayed on the list display page. It can be overridden by the member variable list_display_links. A property is any string that should exist as a property in the objects within a queryset and works with lodash's _.at function.

The properties "name","address.street" and "emails[0]" are all acceptable by _.at in the example below

Example:

  let object={ name : "any name",{ address : { street : "any"}},emails: ["any@any.com"]}

Returns the number of items to be listed in a page. Can be overridden by list_per_page.

Returns a true/false value. Controls wether search is implement on live input or not. Can be overriden by the live_search member variable. Default is false.

This function returns an array of objects that will serve as the queryset for the admin interface. Typically involves an HTTP request to a backend.

Grants permission to add an object. This method controls rendering of the Add button

Grants permission to change an object. It disables all links to the add/change page when enabled

Grants permission to delete object. This method is not implemented and can be handled via implementing actions.

Grants permission to the this admin interface.

Changes the state property "loading" to false. This method can be used to hide a progress indicator by inspecting the "loading" property of the state object.

An event listener that listens when the next page is selected.

An event listener that listens when the previous page is selected.

Renders the actions select component

Renders the add object button. Checks to see if permission is given by has_add_permission

Renders the admin interface component

Renders the pagination UI

The default progress indicator. Can be overriden.

Renders the search component

Renders the table in the display page. This calls _get_table_header and _get_table_body

This method should be overriden and called after saving an object in the add/change view. This method is not called at all here but provides hints on what to do after saving an object. Change the state display_type to "list", object to "null" and refresh the quer yset.

This method should be overriden and called after saving an object in the add/change view. This method is not called at all here but provides hints on what to do after saving an object. Change the state display_type to "list", object to "null" and refresh the quer yset.

Implements search. This method should be overridden to implement a custom search

An event listener that listens when a page is selected.

Changes the state property "loading" to true. The state property can be used to show a progress indicator.

A private method to wrap a table entry in an tag in the display page. The method checks if permission is given to display links using the has_change_permission method

Returns an ordered queryset. The method checks to see if sorting is active and sorts the current queryset based on the sort order.

Generate the table body for the list display page

An event listener that listens to the search event. This method calls search method which implements a custom search. The method uses the "live_search" property to implement live search or not.

This method adds up/down arrows to field headers on the list display page table

This method is an event handler that listens to when all objects of the queryset displayed within a single display page are selected

This method is an event handler that listens when a single objects of the queryset displayed is selected