Header Menu & Header Buttons

Demo

Header Button Plugin

Demo Page / Demo Component

Header Menu Plugin

Demo Page / Demo Component

Header Menu

The Header Menu is now part of Angular-Slickgrid and is enabled by default via the grid option "enableHeaderMenu" flag.

How to use it?

It's Enabled by default

Technically, it's enable by default and so you don't have anything to do to enjoy it. However if you want to customize the content of the Header Menu, then continue reading.

Customization

Custom Commands

The Header Menu also comes, by default, with a list of custom commands

• Sort Ascending (you can hide it with showSortCommands: false)
• Sort Descending (you can hide it with showSortCommands: false)
• Hide Column (you can hide it with showColumnHideCommand: false)

This section is called Custom Commands because you can also customize this section with your own commands. To do that, you need to fill in 2 properties (an array of headerMenuItems that will go under each column definition and define onCommand callbacks) in your Grid Options. For example, Angular-Slickgrid is configured by default with these settings (you can overwrite any one of them):

this.gridOptions = {
   enableAutoResize: true,
   enableHeaderMenu: true,   // <<-- this will automatically add extra custom commands
   enableFiltering: true,
   headerMenu: {
     onCommand: (e, args) => {
       if (args.command === 'hide') {
         this.controlService.hideColumn(args.column);
         this.controlService.autoResizeColumns();
       } else if (args.command === 'sort-asc' || args.command === 'sort-desc') {
         // get previously sorted columns
         const cols: ColumnSort[] = this.sortService.getPreviousColumnSorts(args.column.id + '');

         // add to the column array, the column sorted by the header menu
         cols.push({ sortCol: args.column, sortAsc: (args.command === 'sort-asc') });
         this.sortService.onLocalSortChanged(this.gridObj, this.gridOptions, this.dataviewObj, cols);

         // update the this.gridObj sortColumns array which will at the same add the visual sort icon(s) on the UI
         const newSortColumns: ColumnSort[] = cols.map((col) => {
           return { columnId: col.sortCol.id, sortAsc: col.sortAsc };
         });
         this.gridObj.setSortColumns(newSortColumns); // add sort icon in UI
       } else {
         alert('Command: ' + args.command);
       }
     }
  }
};

Callback Hooks

There are 3 callback hooks which are accessible in the Grid Options

• onBeforeMenuShow
• onCommand

For more info on all the available properties of the custom commands, you can read refer to the doc written in the Header Menu implementation itself.

How to change an icon of all default commands?

You can change any of the default command icon(s) by changing the icon[X-command], for example, see below for the defaults.

this.gridOptions = {
   enableGridMenu: true,
   gridMenu: {
     iconColumnHideCommand: 'fa fa-times'
     iconSortAscCommand: 'fa fa-sort-asc'
     iconSortDescCommand: 'fa fa-sort-desc',
   },
};

How to Disable the Header Menu?

You can disable the Header Menu, by calling enableHeaderMenu: false from the Grid Options.

this.gridOptions = {
   enableHeaderMenu: false
};