Rename HeaderMenuOption & HeaderButtonOption to HeaderMenu, HeaderButton

Author: Ghislain Beaulac

ng-package.json

@@ -3,6 +3,9 @@
   "dest": "dist",
   "workingDirectory": ".ng_build",
   "lib": {
-    "entryFile": "public_api.ts"
+    "entryFile": "public_api.ts",
+    "externals": {
+      "flatpickr": "flatpickr"
+    }
   }
 }

src/app/examples/grid-headerbutton.component.ts

@@ -47,7 +47,7 @@ export class GridHeaderButtonComponent implements OnInit {
       },
       enableFiltering: false,
       enableCellNavigation: true,
-      headerButtonOptions: {
+      headerButton: {
         onCommand: (e, args) => {
           const column = args.column;
           const button = args.button;

src/app/examples/grid-headermenu.component.ts

@@ -87,7 +87,7 @@ export class GridHeaderMenuComponent implements OnInit {
       },
       enableFiltering: false,
       enableCellNavigation: true,
-      headerMenuOptions: {
+      headerMenu: {
         onCommand: (e, args) => {
           if (args.command === 'hide') {
             this.controlService.hideColumn(args.column);

src/app/modules/angular-slickgrid/models/column.interface.ts

@@ -1,8 +1,8 @@
 import { Editor } from './editor.interface';
 import { FieldType } from './fieldType';
 import { Formatter } from './formatter.interface';
-import { HeaderButton } from './headerButton.interface';
-import { HeaderMenu } from './headerMenu.interface';
+import { HeaderButtonItem } from './headerButtonItem.interface';
+import { HeaderMenuItem } from './headerMenuItem.interface';
 import { OnEventArgs } from './onEventArgs.interface';
 import { Sorter } from './sorter.interface';
 
@@ -21,9 +21,9 @@ export interface Column {
   focusable?: boolean;
   formatter?: Formatter;
   header?: {
-    buttons?: HeaderButton[];
+    buttons?: HeaderButtonItem[];
     menu?: {
-      items: HeaderMenu[];
+      items: HeaderMenuItem[];
     };
   };
   headerCssClass?: string;

src/app/modules/angular-slickgrid/models/gridOption.interface.ts

@@ -1,6 +1,8 @@
 import { AutoResizeOption } from './autoResizeOption.interface';
 import { BackendEventChanged } from './backendEventChanged.interface';
 import { GridMenu } from './gridMenu.interface';
+import { HeaderButton } from './headerButton.interface';
+import { HeaderMenu } from './headerMenu.interface';
 import { Pagination } from './pagination.interface';
 import { PaginationChangedArgs } from './paginationChangedArgs.interface';
 import { SortChangedArgs } from './sortChangedArgs.interface';
@@ -38,15 +40,8 @@ export interface GridOption {
   gridMenu?: GridMenu;
   gridId?: string;
   headerRowHeight?: number;
-  headerButtonOptions?: {
-    buttonCssClass?: string;
-    onCommand?: (e: Event, args: any) => void;
-  };
-  headerMenuOptions?: {
-    buttonCssClass?: string;
-    buttonImage?: string;
-    onCommand?: (e: Event, args: any) => void;
-  };
+  headerButton?: HeaderButton;
+  headerMenu?: HeaderMenu;
   multiColumnSort?: boolean;
   onBackendEventApi?: BackendEventChanged;
   pagination?: Pagination;

src/app/modules/angular-slickgrid/models/headerButton.interface.ts

@@ -1,8 +1,6 @@
+import { HeaderButtonOnCommandArgs } from './headerButtonOnCommandArgs.interface';
+
 export interface HeaderButton {
-  cssClass?: string;            // CSS class to add to the button.
-  image?: string;               // Relative button image path.
-  tooltip?: string;             // Button tooltip.
-  showOnHover?: boolean;        // Only show the button on hover.
-  handler?: (e: Event) => void; // Button click handler.
-  command?: string;             // A command identifier to be passed to the onCommand event handlers.
+  buttonCssClass?: string;
+  onCommand?: (e: Event, args: HeaderButtonOnCommandArgs) => void;
 }

src/app/modules/angular-slickgrid/models/headerButtonItem.interface.ts

@@ -0,0 +1,8 @@
+export interface HeaderButtonItem {
+  command?: string;             // A command identifier to be passed to the onCommand event handlers.
+  cssClass?: string;            // CSS class to add to the button.
+  handler?: (e: Event) => void; // Button click handler.
+  image?: string;               // Relative button image path.
+  showOnHover?: boolean;        // Only show the button on hover.
+  tooltip?: string;             // Button tooltip.
+}

src/app/modules/angular-slickgrid/models/headerButtonOnCommandArgs.interface.ts

@@ -0,0 +1,9 @@
+import { Column } from './column.interface';
+import { HeaderButtonItem } from './headerButtonItem.interface';
+
+export interface HeaderButtonOnCommandArgs {
+  grid: any;
+  column: Column;
+  command: string;
+  button: HeaderButtonItem;
+}

src/app/modules/angular-slickgrid/models/headerMenu.interface.ts

@@ -1,8 +1,9 @@
+import { HeaderMenuOnBeforeMenuShowArgs } from './headerMenuOnBeforeMenuShowArgs.interface';
+import { HeaderButtonOnCommandArgs } from './headerButtonOnCommandArgs.interface';
+
 export interface HeaderMenu {
-  title?: string;         // Menu item text.
-  disabled?: boolean;     // Whether the item is disabled.
-  tooltip?: string;       // Item tooltip.
-  command?: string;          // A command identifier to be passed to the onCommand event handlers.
-  iconCssClass?: string;  // A CSS class to be added to the menu item icon.
-  iconImage?: string;     // A url to the icon image.
+  buttonCssClass?: string;
+  buttonImage?: string;
+  onBeforeMenuShow?: (e: Event, args: HeaderMenuOnBeforeMenuShowArgs) => void;
+  onCommand?: (e: Event, args: HeaderButtonOnCommandArgs) => void;
 }

src/app/modules/angular-slickgrid/models/headerMenuItem.interface.ts

@@ -0,0 +1,8 @@
+export interface HeaderMenuItem {
+  command?: string;       // A command identifier to be passed to the onCommand event handlers.
+  disabled?: boolean;     // Whether the item is disabled.
+  iconCssClass?: string;  // A CSS class to be added to the menu item icon.
+  iconImage?: string;     // A url to the icon image.
+  title?: string;         // Menu item text.
+  tooltip?: string;       // Item tooltip.
+}