@adaptabletools/adaptable 18.0.0-canary.34 → 18.0.0-canary.36

package/src/AdaptableOptions/MenuOptions.d.ts

@@ -1,194 +0,0 @@
-import { AdaptableColumnMenuItemName, AdaptableContextMenuItemName, AdaptableMenuItem, ColumnMenuContext, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
-import { AdaptableColumn, AdaptableIcon, BaseContext } from '../types';
-/**
- * Options for managing menus in AdapTable – provided using 2 collections
- */
-export interface MenuOptions<TData = any> {
-    /**
-     * Customises Column Menu (default column menu items are available in the provided context)
-     */
-    customColumnMenu?: (menuContext: CustomColumnMenuContext<TData>) => CustomColumnMenuItem[];
-    /**
-     * Customises Context Menu (default context menu items are available in provided context)
-     */
-    customContextMenu?: (menuContext: CustomContextMenuContext<TData>) => CustomContextMenuItem[];
-}
-/**
- * Context info provided when building Custom Context Menus
- */
-export interface CustomContextMenuContext<TData = any> extends ContextMenuContext<TData> {
-    /**
-     * Flat list of all available AdapTable Menu Items
-     */
-    defaultAdaptableMenuItems: AdaptableSystemMenuItem<AdaptableContextMenuItemName>[];
-    /**
-     * Flat list of all available AG Grid Menu Items
-     */
-    defaultAgGridMenuItems: AgGridMenuItem<AgGridContextMenuItemType>[];
-    /**
-     * Default structure of Adaptable Menu Items
-     */
-    defaultAdaptableMenuStructure: (AdaptableSystemMenuItem<AdaptableContextMenuItemName> | '-')[];
-    /**
-     * Default structure of AG Grid Menu Items
-     */
-    defaultAgGridMenuStructure: (AgGridMenuItem<AgGridContextMenuItemType> | {
-        menuType: 'Group';
-        label: string;
-        subMenuItems: AgGridMenuItem<AgGridContextMenuItemType>[];
-        disabled?: boolean;
-        icon?: AdaptableIcon;
-    })[];
-}
-/**
- * Context info provided when building Custom Column Menus
- */
-export interface CustomColumnMenuContext<TData = any> extends ColumnMenuContext<TData> {
-    /**
-     * Flat list of all available AdapTable Menu Items
-     */
-    defaultAdaptableMenuItems: AdaptableSystemMenuItem<AdaptableColumnMenuItemName>[];
-    /**
-     * Flat list of all available AG Grid Menu Items
-     */
-    defaultAgGridMenuItems: AgGridMenuItem<AgGridColumnMenuItemType>[];
-    /**
-     * Default structure of Adaptable Menu Items
-     */
-    defaultAdaptableMenuStructure: (AdaptableSystemMenuItem<AdaptableColumnMenuItemName> | '-')[];
-    /**
-     * Default structure of AG Grid Menu Items
-     */
-    defaultAgGridMenuStructure: (AgGridMenuItem<AgGridColumnMenuItemType> | {
-        menuType: 'Group';
-        label: string;
-        subMenuItems: AgGridMenuItem<AgGridColumnMenuItemType>[];
-        disabled?: boolean;
-        icon?: AdaptableIcon;
-    })[];
-}
-/**
- * Custom Context Menu Item
- */
-export type CustomContextMenuItem = AgGridMenuItem<AgGridContextMenuItemType> | AdaptableSystemMenuItem<AdaptableContextMenuItemName> | UserContextMenuItem | '-' | {
-    menuType: 'Group';
-    label: string;
-    subMenuItems: CustomContextMenuItem[];
-    disabled?: boolean;
-    icon?: AdaptableIcon;
-};
-/**
- * Custom Column Menu Item
- */
-export type CustomColumnMenuItem = AgGridMenuItem<AgGridColumnMenuItemType> | AdaptableSystemMenuItem<AdaptableColumnMenuItemName> | UserColumnMenuItem | '-' | {
-    menuType: 'Group';
-    label: string;
-    subMenuItems: CustomColumnMenuItem[];
-    disabled?: boolean;
-    icon?: AdaptableIcon;
-};
-/**
- * Menu Item that is provided by AG Grid
- */
-export interface AgGridMenuItem<MENU_TYPE> {
-    /**
-     * Type of Menu - always 'AgGrid'
-     */
-    menuType: 'AgGrid';
-    /**
-     * Name of the Menu Type
-     */
-    name: MENU_TYPE;
-}
-/**
- * System Menu Item that is provided by AdapTable
- */
-export interface AdaptableSystemMenuItem<MENU_TYPE_NAME> extends AdaptableMenuItem<MENU_TYPE_NAME> {
-    /**
-     * Type of Menu - always 'Adaptable'
-     */
-    menuType: 'Adaptable';
-}
-/**
- * Context Menu Item that is provided by User
- */
-export interface UserContextMenuItem {
-    /**
-     * Type of Menu - always 'Adaptable'
-     */
-    menuType: 'User';
-    /**
-     * Text to appear in the Menu Item
-     */
-    label: string;
-    /**
-     * Function invoked when the Menu Item is clicked
-     */
-    onClick?: (menuContext: ContextMenuContext) => void;
-    /**
-     * Whether menu item is disabled
-     */
-    disabled?: boolean;
-    /**
-     * Whether menu item is hidden
-     */
-    hidden?: boolean;
-    /**
-     * Optional icon to display
-     */
-    icon?: AdaptableIcon;
-    /**
-     * Array of Menu Items, enabling limitless levels of menus
-     */
-    subMenuItems?: CustomContextMenuItem[];
-}
-/**
- * Column Menu Item that is provided by User
- */
-export interface UserColumnMenuItem {
-    /**
-     * Type of Menu - always 'User'
-     */
-    menuType: 'User';
-    /**
-     * Text to appear in the Menu Item
-     */
-    label: string;
-    /**
-     * Function invoked when the Menu Item is clicked
-     */
-    onClick?: (menuContext: ColumnMenuContext) => void;
-    /**
-     * Whether menu item is disabled
-     */
-    disabled?: boolean;
-    /**
-     * Whether menu item is hidden
-     */
-    hidden?: boolean;
-    /**
-     * Optional icon to display
-     */
-    icon?: AdaptableIcon;
-    /**
-     * Array of Menu Items, enabling limitless levels of menus
-     */
-    subMenuItems?: CustomColumnMenuItem[];
-}
-/**
- * Context used when ordering Menu Sections
- */
-export interface MenuOrderContext extends BaseContext {
-    /**
-     * Column in which Menu will appear
-     */
-    column: AdaptableColumn;
-}
-/**
- * Defines AG Grid Context Menu Items
- */
-export type AgGridContextMenuItemType = 'autoSizeAll' | 'expandAll' | 'contractAll' | 'copy' | 'copyWithHeaders' | 'copyWithGroupHeaders' | 'cut' | 'paste' | 'resetColumns' | 'export' | 'csvExport' | 'excelExport' | 'chartRange' | 'pivotChart' | 'separator';
-/**
- * Defines AG Grid Column Menu Items
- */
-export type AgGridColumnMenuItemType = 'pinSubMenu' | 'valueAggSubMenu' | 'autoSizeThis' | 'autoSizeAll' | 'rowGroup' | 'rowUnGroup' | 'resetColumns' | 'expandAll' | 'contractAll' | 'separator';

package/src/AdaptableOptions/MenuOptions.js

@@ -1,6 +0,0 @@
-export {};
-// 1. adding custom menu items
-// 2. changing the order of items
-// 3. removing all AdapTable menu items
-// 4. removing some AdapTable menu items
-// 5. removing some Ag Grid menu items