widgetConfig
Only used for a widget mode display, the type is as follows :
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
position | No | 'right' | 'left' | 'right' | Widget frame's position in parent container, left or right |
button | No | WidgetButton | - | Widget opening button's position / style ata |
large | No | WidgetFrame | - | Widget frame's position / style data |
thumbnail | No | WidgetFrame | - | (since v1.0.14) second mode to render the main component in a container with a different size (you can hot-switch from one to another) |
widgetbutton
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
display | No | boolean | true | false : hides the basic button to use a custom widget opening method |
text | No | Text | - | Widget opening button's text customization |
image | No | Image | - | Widget opening button's image customization |
border | No | Border | - | Widget opening button's border customization |
background | No | Background | - | Widget opening button's background customization |
position | No | Position | - | Widget opening button's position in parent container customization |
widgetframe
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
height | No | string | '600px' | Widget frame's height |
width | No | string | '400px' (or '100%' if device's width is lower than 600px) | Widget frame's width |
border | No | Border | - | Widget frame's border customization |
position | No | Position | - | Widget frame's position in parent container customization |
text
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
color | No | string | 'rgb(112, 112, 112)' | Button text's color |
colorHover | No | string | 'rgb(112, 112, 112)' | (since v4.0.3) Button text's color when hovering |
content | No | string | 'Besoin d'aide ?' translated from navigator's language if possible | Button's text |
bold | No | boolean | true | Bold text ? |
image
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
hide | No | boolean | false | (since v4.0.3) Should the image be hidden ? |
url | No | string | URL of the image displayed inside the button | |
position | No | 'left' | 'right' | 'left' | Position of the image displayed inside the button (if an URL is given) |
height | No | string | '2rem' | Size of the image displayed inside the button |
marginY | No | boolean | true | Should a vertical margin of 0.25 rem be added ? |
border
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
color | No | string | 'rgb(112, 112, 112)' | Border color |
colorHover | No | string | 'rgb(112, 112, 112)' | (since v4.0.3) Border color when hovering |
thickness | No | number | 1 | Border thickness (in pixels) |
rounded | No | boolean | true | Rounded corners ? |
background
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
color | No | string | 'transparent' | Button background's color |
colorHover | No | string | 'rgb(112, 112, 112)' | (since v4.0.3) Color when hovering |
position
The elements are in absolute position, this data are used to give the distance relative to the edges of the parent container.
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
top | No | string | - | Distance from the top of parent container |
bottom | No | string | '1rem' | Distance from the bottom of parent container |
left | No | string | - | Distance from the left side of parent container |
right | No | string | '1rem' | Distance from the right side of parent container |