mirror of
https://bitbucket.org/wisemapping/wisemapping-frontend.git
synced 2025-04-03 19:53:20 +02:00
65 lines
2.0 KiB
TypeScript
65 lines
2.0 KiB
TypeScript
/*
|
|
* Copyright [2021] [wisemapping]
|
|
*
|
|
* Licensed under WiseMapping Public License, Version 1.0 (the "License").
|
|
* It is basically the Apache License, Version 2.0 (the "License") plus the
|
|
* "powered by wisemapping" text requirement on every single page;
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the license at
|
|
*
|
|
* http://www.wisemapping.org/license
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* Interface for menu configuration.
|
|
* One of these properties must be set: onClick, render or options.
|
|
* Property onClick is the event handler for a common button of this menu. Set options for a submenu or render for a custom element in place (from the second level onwards).
|
|
* On the first level option has priority over onClick. Second level onwards render is the first option.
|
|
*/
|
|
interface ActionConfig {
|
|
/**
|
|
* the React element for put in menu entry button
|
|
*/
|
|
icon?: React.ReactElement | (() => React.ReactElement);
|
|
/**
|
|
* text for menu entry tooltip
|
|
*/
|
|
tooltip?: string;
|
|
/**
|
|
* the event handler for a common button
|
|
*/
|
|
onClick?: (event: any) => void;
|
|
/**
|
|
* custom element for a menu entry
|
|
*/
|
|
render?: (closeMenu: () => void) => React.ReactElement;
|
|
/**
|
|
* submenu options. If null, a divider will be inserted.
|
|
*/
|
|
options?: (ActionConfig | null)[];
|
|
/**
|
|
* option is disabled
|
|
*/
|
|
disabled?: () => boolean;
|
|
/**
|
|
* option is selected
|
|
*/
|
|
selected?: () => boolean;
|
|
/**
|
|
* for submenu popover, if true, popover will not be closed when mouse leave it.
|
|
*/
|
|
useClickToClose?: boolean;
|
|
/**
|
|
* if false the nmenu entry or button is not visible. Also custom render will be ignored.
|
|
*/
|
|
visible?: boolean;
|
|
}
|
|
|
|
export default ActionConfig;
|