diff --git a/_data/toc/ui-components-guide.yml b/_data/toc/ui-components-guide.yml index 0ce11369c44..f09dfa5cc9d 100644 --- a/_data/toc/ui-components-guide.yml +++ b/_data/toc/ui-components-guide.yml @@ -161,7 +161,7 @@ pages: - label: ThumbnailColumn component url: /ui_comp_guide/components/ui-thumbnailcolumn.html - - label: Toolbar component + - label: ListingToolbar component url: /ui_comp_guide/components/ui-toolbar.html - label: TreeMassActions component diff --git a/common/images/ui_comps/listing-toolbar-component-result.png b/common/images/ui_comps/listing-toolbar-component-result.png new file mode 100644 index 00000000000..05d34a6fc93 Binary files /dev/null and b/common/images/ui_comps/listing-toolbar-component-result.png differ diff --git a/guides/v2.2/ui_comp_guide/components/ui-toolbar.md b/guides/v2.2/ui_comp_guide/components/ui-toolbar.md index 790118a14ba..aa75680c82f 100644 --- a/guides/v2.2/ui_comp_guide/components/ui-toolbar.md +++ b/guides/v2.2/ui_comp_guide/components/ui-toolbar.md @@ -1,44 +1,53 @@ --- group: ui-components-guide -title: Toolbar component +title: ListingToolbar component --- -The Toolbar component implements a container for the listing-related elements like paging, mass actions, filters, bookmarks. That is, it aggregates all elements that serve as tools and renders them at the top of the main table. +The ListingToolbar component implements a container for the listing-related elements such as paging, mass actions, filters, and bookmarks. It aggregates all elements that serve as tools and renders them at the top of the main table. ## Configuration options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionDescriptionTypeDefault
stickyWhether the toolbar has a fixed position. When set to true, elements like paging, filters, and table headers stay in the viewport's area, no matter where the scroll position is.Booleanfalse
stickyClassA list of additional CSS classes added to the root node of the .html template specified in StickyTmpl.{
[name:string]: boolean
}
{
'sticky-header': true
}
stickyTmplPath to the toolbar's template for the fixed position.Stringui/grid/sticky/sticky
templatePath to the component’s .html template.Stringui/grid/toolbar
+| Option | Description | Type | Default | +| ------- | ------- | ------- | ------------ | +| `sticky` | Whether the toolbar has a fixed position. When set to `true`, elements like paging, filters, and table headers stay in the viewport's area, no matter where the scroll position is. | `Boolean` | `false` | +| `stickyClass` | A list of additional CSS classes added to the root node of the `.html` template specified in `StickyTmpl`. | {
[name:string]: boolean
} | {
`'sticky-header': true`
} | +| `stickyTmpl` | Path to the toolbar's template for the fixed position. | `String` | `ui/grid/sticky/sticky` | +| `template` | Path to the component’s `.html` template. | `String` | `ui/grid/toolbar` | + +## Examples + +### Integrate the ListingToolbar component with the Listing component + +In the following example, we group the following components: + +- Bookmark +- ColumnsControls +- FilterSearch +- Filters +- Mass Actions +- Paging + +```xml + + + true + + + + + + ... + + + ... + + + +``` + +#### Result + +![ListingToolbar UiComponent]({{ site.baseurl }}/common/images/ui_comps/listing-toolbar-component-result.png) ## Source files