Interface buttonDescription

Optional description of the button

Button definition in the object overrides default functionality used when button is defined only by string.

Values from the button description overrides definition from the operation

Example:

 "buttons":{
    "newTaskToArea":{ "enabled":false },  // disable button defined by ancestor
    "frog":{ 
         "operation":"newFrog", 
         "icon":"frog",                   // define icon the same regardless 
         "label":"smallFrog"              // define label independent on the operation name
    }
  }
interface buttonDescription {
    enabled?: string;
    icon?: string;
    label?: string;
    menuItems?: string[];
    operation?: string;
    order?: string;
    primary?: boolean;
    right?: string;
    shortcut?: string;
}

Properties

enabled? icon? label? menuItems? operation? order? primary? right? shortcut?

Properties

Optional enabled

enabled?: string

Optional condition to show the button; if both right and enabled are defined, both should be true to allow the button

Optional icon

icon?: string

Optional icon overrides icon from operation definition; can contain evaluation string

Optional label

label?: string

Optional alternative label name for button. If not defined name of operation is used (operation defined by name of the button or by operation field) Label is translated in the same way, as name. It shoul define name from the translation list.

Optional menuItems

menuItems?: string[]

Optional list of "buutons" under the button - name of the buttons operations Only single-level is suported and options right is not suported

Optional operation

operation?: string

Optional alternative operation name. If defined, button calls another operation that what would be called according to its name String is evaluated - can contain codition and then decision what operation should be called is made during the page load - Does not reflects any changes in the object by user during its update

Optional order

order?: string

Optional button order; evaluation not supported, always evaluated as a simple string

Optional primary

primary?: boolean

Buttons marked as primary buttons are visible directly on the line of buttons in the list of mobile buttons. Other (nonprimary) operations are placed into the menu opened by the command buttons. Could be used for 1 - 2 buttons that are expected to the the most used. Usage example: start task fro non-started task Buttons marked as primary automatically gets style class priorityButton

Optional right

right?: string

Optional condition to show the button; if both right and enabled are defined, both should be true to allow the button

Optional shortcut

shortcut?: string

Optional button shortcut

Settings

Member Visibility

Theme

On This Page

enablediconlabelmenuItemsoperationorderprimaryrightshortcut