This is archived documentation for Magento v2.2 and is no longer supported. Go to the latest documentation.

Bookmarks component

The Bookmarks component stores active and changed state of a grid implemented using Listing. It includes the state of filters, columns position, applied sorting, pagination, and so on.

Configuration options

Option Description Type Default Value
newViewLabel Default label for a new bookmark. String New View
template Path to the component’s .html template. String ui/grid/controls/bookmarks/bookmarks
viewTmpl Path to the .html template used to render each bookmark in the list. String ui/grid/controls/bookmarks/view
defaultIndex The index of the default view. String default
activeIndex The index of the current view. String default
viewsArray The array of views. Array default

Source files

Extends uiCollection:

Examples

Integrate Bookmarks component with Listing component

This is an example of how the Bookmarks component integrates with the Listing component:

1
2
3
4
5
6
7
8
<listing>
    ...
    <listingToolbar>
        ...
        <bookmark name="bookmarks"/>
    </listingToolbar>
    ...
</listing>

Result

Bookmarks Component example