@ -11,7 +11,7 @@ import Component from './Component';
import Components from './Components' ;
import Components from './Components' ;
import { ToolbarButtonProps } from './ToolbarButton' ;
import { ToolbarButtonProps } from './ToolbarButton' ;
import { ParseNodeOptions } from '../../parser/config/config' ;
import { ParseNodeOptions } from '../../parser/config/config' ;
import { DataVariableType } from '../../data_sources/model/DataVariable ' ;
import { DynamicValueDefinition } from '../../data_sources/types ' ;
export type DragMode = 'translate' | 'absolute' | '' ;
export type DragMode = 'translate' | 'absolute' | '' ;
@ -102,7 +102,7 @@ export interface ComponentProperties {
* Name of the component . Will be used , for example , in Layers and badges
* Name of the component . Will be used , for example , in Layers and badges
* @default ''
* @default ''
* /
* /
name? : string ;
name? : string | DynamicValueDefinition ;
/ * *
/ * *
* When ` true ` the component is removable from the canvas , default : ` true `
* When ` true ` the component is removable from the canvas , default : ` true `
* @default true
* @default true
@ -115,13 +115,13 @@ export interface ComponentProperties {
containing ` some-class ` class and ` Hello ` title , and ` column ` components . In the case of a function , target and destination components are passed as arguments , return a Boolean to indicate if the drag is possible . Default : ` true `
containing ` some-class ` class and ` Hello ` title , and ` column ` components . In the case of a function , target and destination components are passed as arguments , return a Boolean to indicate if the drag is possible . Default : ` true `
* @default true
* @default true
* /
* /
draggable? : boolean | string | DraggableDroppableFn ;
draggable? : boolean | string | DraggableDroppableFn | DynamicValueDefinition ;
/ * *
/ * *
* Indicates if it ' s possible to drop other components inside . You can use
* Indicates if it ' s possible to drop other components inside . You can use
a query string as with ` draggable ` . In the case of a function , target and destination components are passed as arguments , return a Boolean to indicate if the drop is possible . Default : ` true `
a query string as with ` draggable ` . In the case of a function , target and destination components are passed as arguments , return a Boolean to indicate if the drop is possible . Default : ` true `
* @default true
* @default true
* /
* /
droppable? : boolean | string | DraggableDroppableFn ;
droppable? : boolean | string | DraggableDroppableFn | DynamicValueDefinition ;
/ * *
/ * *
* Set to false if you don ' t want to see the badge ( with the name ) over the component . Default : ` true `
* Set to false if you don ' t want to see the badge ( with the name ) over the component . Default : ` true `
* @default true
* @default true
@ -190,7 +190,7 @@ export interface ComponentProperties {
* Component default style , eg . ` { width: '100px', height: '100px', 'background-color': 'red' } `
* Component default style , eg . ` { width: '100px', height: '100px', 'background-color': 'red' } `
* @default { }
* @default { }
* /
* /
style? : string | Record < string , any | { type : typeof DataVariableType ; path : string ; value : string } > ;
style? : string | Record < string , any | DynamicValueDefinition > ;
/ * *
/ * *
* Component related styles , eg . ` .my-component-class { color: red } `
* Component related styles , eg . ` .my-component-class { color: red } `
* @default ''
* @default ''
@ -200,12 +200,12 @@ export interface ComponentProperties {
* Content of the component ( not escaped ) which will be appended before children rendering . Default : ` '' `
* Content of the component ( not escaped ) which will be appended before children rendering . Default : ` '' `
* @default ''
* @default ''
* /
* /
content? : string ;
content? : string | DynamicValueDefinition ;
/ * *
/ * *
* Component 's icon, this string will be inserted before the name (in Layers and badge), eg. it can be an HTML string ' < i class = "fa fa-square-o" > < / i > '. Default: `' ' `
* Component 's icon, this string will be inserted before the name (in Layers and badge), eg. it can be an HTML string ' < i class = "fa fa-square-o" > < / i > '. Default: `' ' `
* @default ''
* @default ''
* /
* /
icon? : string ;
icon? : string | DynamicValueDefinition ;
/ * *
/ * *
* Component 's javascript. More about it [here](/modules/Components-js.html). Default: `' ' `
* Component 's javascript. More about it [here](/modules/Components-js.html). Default: `' ' `
* @default ''
* @default ''