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.
Options
Option
Description
Type
Default Value
newViewLabelDefault label for a new bookmark.
String
New View
templatePath to the component’s
.html template.String
ui/grid/controls/bookmarks/bookmarksviewTmplPath to the
.html template used to render each bookmark in the list.String
ui/grid/controls/bookmarks/viewdefaultIndexThe index of the default view.
String
defaultactiveIndexThe index of the current view.
String
defaultviewsArrayThe array of views.
Array
defaultSource files
Extends uiCollection:
app/code/Magento/Ui/view/base/web/js/grid/controls/bookmarks/bookmarks.jsapp/code/Magento/Ui/view/base/web/templates/grid/controls/bookmarks/view.html
Examples
Integration
This is an example of how to integrate the Bookmarks component with the Listing component:
<listing>
...
<listingToolbar>
...
<bookmark name="bookmarks"/>
</listingToolbar>
...
</listing>
Result