@@ -3,6 +3,19 @@ title: ToolBar
33weight : 3 
44--- 
55
6+ The Toolbar provides several key features:
7+ 
8+ |  Item |  Purpose | 
9+ |  --- |  --- | 
10+ |  'bulk-actions' |  The Bulk Actions dropdown - if Bulk Actions are defined, then this displays a list of the Bulk Actions | 
11+ |  'column-select' |  Column Select dropdown - allowing for toggling visibility of a Column | 
12+ |  'filters' |  The Filters Button - toggling the display of the Filters popover/slidedown | 
13+ |  'pagination-dropdown' |  The Pagination dropdown, allowing for adjustment of per-page | 
14+ |  'reorder' |  The Reorder Button - if reordering is enabled | 
15+ |  'search' |  The Search Input -if one or more Columns are configured as searchable | 
16+ 
17+ 
18+ 
619## Component Available Methods  
720
821### setToolBarEnabled  
@@ -37,9 +50,12 @@ You can add/remove items or change the order within the Toolbar Sections:
3750|  'reorder' |  The Reorder Button | 
3851|  'search' |  The Search Input | 
3952
40- Note that these sections are prepended/appended with the relevant configurableArea
53+ Note that these sections are prepended/appended with the relevant configurableArea, and Actions in the Toolbar are placed appropriately.
54+ 
55+ Should you wish to modify the order, then keep in mind the following defaults:
4156
42- #### Customising The Left Elements  
57+ #### Defaults  
58+ ##### The Left Toolbar Elements  
4359By default, the following is returned.
4460``` php 
4561    public function toolbarItemsLeft()
@@ -48,11 +64,41 @@ By default, the following is returned.
4864    }
4965``` 
5066
51- ####  Customising  The Right Elements 
67+ #####  The Right Toolbar  Elements  
5268By default, the following is returned:
5369``` php 
5470    public function toolbarItemsRight()
5571    {
5672        return ['bulk-actions','column-select','pagination-dropdown'];
5773    }
74+ ``` 
75+ 
76+ #### Example  
77+ This example moves the "bulk actions" dropdown to the left of the toolbar, and the "search" to the right of the toolbar.
78+ 
79+ ``` php 
80+     public function toolbarItemsLeft()
81+     {
82+         // Instead Of
83+         // return ['reorder','search','filters'];
84+         return ['reorder','bulk-actions','filters'];
85+     }
86+ 
87+     public function toolbarItemsRight()
88+     {
89+         // Instead Of
90+         // ['bulk-actions','column-select','pagination-dropdown'];
91+         return ['search','column-select','pagination-dropdown'];
92+     }
93+ ``` 
94+ 
95+ #### Example 2  
96+ This example adds an extra instance of the "search" input on the right side of the Toolbar
97+ 
98+ ``` php 
99+ 
100+     public function toolbarItemsRight()
101+     {
102+         return ['search','bulk-actions','column-select','pagination-dropdown'];
103+     }
58104``` 
0 commit comments