src/modules/action-bar/components/action.intf.ts
Stark Action Base interface
Properties |
|
buttonColor |
buttonColor:
|
Type : StarkActionBarButtonColor | string
|
Optional |
Color of the button |
className |
className:
|
Type : string
|
Optional |
Custom CSS class to be set to the action button |
icon |
icon:
|
Type : string
|
Optional |
Path to SVG icon from iconSets to display inside the action button. Ex: "pencil" |
iconActivated |
iconActivated:
|
Type : string
|
Optional |
The second icon if this action has two possible states: activated and deactivated |
iconSwitchFunction |
iconSwitchFunction:
|
Type : function
|
Optional |
In case of two icon states, this function will hide one of them or show another |
isEnabled |
isEnabled:
|
Type : boolean
|
Optional |
Whether the action button should be enabled for user interaction or not |
label |
label:
|
Type : string
|
Optional |
Text to be displayed as label of the action button |
labelActivated |
labelActivated:
|
Type : string
|
Optional |
The second label if this action has two possible states: activated and deactivated |
labelSwitchFunction |
labelSwitchFunction:
|
Type : function
|
Optional |
In case of two label states, this function will hide one of them or show another |
export type StarkActionBarButtonColor = "primary" | "accent" | "warn" | "success" | "alert" | "alt" | "neutral" | "white";
/**
* Stark Action Base interface
*/
export interface StarkActionBase {
/**
* Color of the button
*/
buttonColor?: StarkActionBarButtonColor | string;
/**
* Path to SVG icon from iconSets to display inside the action button. Ex: "pencil"
*/
icon?: string;
/**
* Text to be displayed as label of the action button
*/
label?: string;
/**
* The second label if this action has two possible states: activated and deactivated
*/
labelActivated?: string;
/**
* In case of two label states, this function will hide one of them or show another
*/
labelSwitchFunction?: () => boolean;
/**
* Whether the action button should be enabled for user interaction or not
*/
isEnabled?: boolean;
/**
* The second icon if this action has two possible states: activated and deactivated
*/
iconActivated?: string;
/**
* In case of two icon states, this function will hide one of them or show another
*/
iconSwitchFunction?: () => boolean;
/**
* Custom CSS class to be set to the action button
*/
className?: string;
}
/**
* Definition of an action to be used in an Stark Action Bar
*/
export interface StarkAction extends StarkActionBase {
/**
* The HTML id to be set to the action button
*/
id: string;
/**
* Text to be displayed as label of the action button
*/
label: string;
/**
* Path to SVG icon from iconSets to display inside the action button. Ex: "pencil"
*/
icon: string;
/**
* Function to be fired when action button is clicked
*/
actionCall: Function;
/**
* Whether the action button should be enabled for user interaction or not
*/
isEnabled: boolean;
/**
* Whether the action button will be visible or not
*/
isVisible?: boolean;
}
/**
* Definition of a action bar's default action to be used in an Stark generic form
*/
export interface StarkDefaultPredefinedAction extends StarkActionBase {}
/**
* Definition of a action bar's normal action to be used in an Stark generic form
*/
export interface StarkCustomizablePredefinedAction extends StarkActionBase {
/**
* Whether the action button will be visible or not
*/
isVisible?: boolean;
}