@refinitiv-ui/elements 5.6.0 → 5.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/lib/accordion/custom-elements.md +18 -0
- package/lib/appstate-bar/custom-elements.md +22 -0
- package/lib/autosuggest/custom-elements.json +12 -2
- package/lib/autosuggest/custom-elements.md +47 -0
- package/lib/button/custom-elements.json +2 -2
- package/lib/button/custom-elements.md +23 -0
- package/lib/button-bar/custom-elements.md +9 -0
- package/lib/calendar/custom-elements.json +4 -4
- package/lib/calendar/custom-elements.md +35 -0
- package/lib/canvas/custom-elements.md +27 -0
- package/lib/card/custom-elements.md +24 -0
- package/lib/chart/custom-elements.md +16 -0
- package/lib/checkbox/custom-elements.json +4 -4
- package/lib/checkbox/custom-elements.md +18 -0
- package/lib/clock/custom-elements.md +28 -0
- package/lib/collapse/custom-elements.md +27 -0
- package/lib/color-dialog/custom-elements.json +8 -8
- package/lib/color-dialog/custom-elements.md +39 -0
- package/lib/combo-box/custom-elements.json +9 -6
- package/lib/combo-box/custom-elements.md +35 -0
- package/lib/counter/custom-elements.md +11 -0
- package/lib/datetime-picker/custom-elements.json +4 -4
- package/lib/datetime-picker/custom-elements.md +49 -0
- package/lib/dialog/custom-elements.json +4 -4
- package/lib/dialog/custom-elements.md +47 -0
- package/lib/email-field/custom-elements.json +6 -6
- package/lib/email-field/custom-elements.md +35 -0
- package/lib/flag/custom-elements.md +10 -0
- package/lib/header/custom-elements.md +18 -0
- package/lib/heatmap/custom-elements.md +26 -0
- package/lib/icon/custom-elements.md +8 -0
- package/lib/interactive-chart/custom-elements.md +32 -0
- package/lib/item/custom-elements.json +6 -8
- package/lib/item/custom-elements.md +29 -0
- package/lib/item/index.d.ts +9 -1
- package/lib/item/index.js +23 -3
- package/lib/label/custom-elements.md +11 -0
- package/lib/layout/custom-elements.md +26 -0
- package/lib/led-gauge/custom-elements.md +17 -0
- package/lib/list/custom-elements.md +30 -0
- package/lib/loader/custom-elements.md +5 -0
- package/lib/multi-input/custom-elements.json +4 -4
- package/lib/multi-input/custom-elements.md +43 -0
- package/lib/notification/custom-elements.md +26 -0
- package/lib/number-field/custom-elements.json +6 -6
- package/lib/number-field/custom-elements.md +37 -0
- package/lib/overlay/custom-elements.json +3 -0
- package/lib/overlay/custom-elements.md +54 -0
- package/lib/overlay-menu/custom-elements.json +10 -12
- package/lib/overlay-menu/custom-elements.md +44 -0
- package/lib/pagination/custom-elements.md +27 -0
- package/lib/panel/custom-elements.md +11 -0
- package/lib/password-field/custom-elements.json +6 -6
- package/lib/password-field/custom-elements.md +31 -0
- package/lib/pill/custom-elements.json +4 -4
- package/lib/pill/custom-elements.md +22 -0
- package/lib/progress-bar/custom-elements.md +18 -0
- package/lib/radio-button/custom-elements.json +8 -8
- package/lib/radio-button/custom-elements.md +19 -0
- package/lib/rating/custom-elements.md +17 -0
- package/lib/search-field/custom-elements.json +6 -6
- package/lib/search-field/custom-elements.md +33 -0
- package/lib/select/custom-elements.json +2 -2
- package/lib/select/custom-elements.md +24 -0
- package/lib/sidebar-layout/custom-elements.md +22 -0
- package/lib/slider/custom-elements.json +6 -6
- package/lib/slider/custom-elements.md +28 -0
- package/lib/sparkline/custom-elements.md +16 -0
- package/lib/swing-gauge/custom-elements.md +17 -0
- package/lib/tab/custom-elements.json +2 -2
- package/lib/tab/custom-elements.md +22 -0
- package/lib/tab-bar/custom-elements.md +11 -0
- package/lib/text-field/custom-elements.json +6 -6
- package/lib/text-field/custom-elements.md +37 -0
- package/lib/time-picker/custom-elements.json +4 -4
- package/lib/time-picker/custom-elements.md +28 -0
- package/lib/toggle/custom-elements.json +4 -4
- package/lib/toggle/custom-elements.md +19 -0
- package/lib/tooltip/custom-elements.md +14 -0
- package/lib/tornado-chart/custom-elements.md +18 -0
- package/lib/tree/custom-elements.json +2 -2
- package/lib/tree/custom-elements.md +32 -0
- package/lib/tree/managers/tree-manager.d.ts +20 -2
- package/lib/tree/managers/tree-manager.js +55 -28
- package/lib/tree-select/custom-elements.json +2 -2
- package/lib/tree-select/custom-elements.md +26 -0
- package/lib/version.js +1 -1
- package/package.json +7 -7
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,22 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [5.7.0](https://github.com/Refinitiv/refinitiv-ui/compare/@refinitiv-ui/elements@5.6.0...@refinitiv-ui/elements@5.7.0) (2021-11-22)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **tree:** correctly update dependant checked states ([#82](https://github.com/Refinitiv/refinitiv-ui/issues/82)) ([fdb7018](https://github.com/Refinitiv/refinitiv-ui/commit/fdb7018f9446f933f428448ada60f4a8cacc1acf))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Features
|
|
15
|
+
|
|
16
|
+
* **item:** improve screen reader support ([#74](https://github.com/Refinitiv/refinitiv-ui/issues/74)) ([b14b950](https://github.com/Refinitiv/refinitiv-ui/commit/b14b950897cb96cdc957e12d93b510cc4361c4f3))
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
6
22
|
# [5.6.0](https://github.com/Refinitiv/refinitiv-ui/compare/@refinitiv-ui/elements@5.5.0...@refinitiv-ui/elements@5.6.0) (2021-11-08)
|
|
7
23
|
|
|
8
24
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ef-accordion
|
|
2
|
+
|
|
3
|
+
Used to display a group of `Collapse` control.
|
|
4
|
+
Only one item will be able to expand by default but you can customize its behavior.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
| Property | Attribute | Type | Default | Description |
|
|
9
|
+
|------------------------|--------------------------|-----------|---------|--------------------------------------------------|
|
|
10
|
+
| `autoCollapseDisabled` | `auto-collapse-disabled` | `boolean` | false | Allow multiple sections expand at the same time |
|
|
11
|
+
| `spacing` | `spacing` | `boolean` | false | Add spacing to content section in all collapse items |
|
|
12
|
+
|
|
13
|
+
## Slots
|
|
14
|
+
|
|
15
|
+
| Name | Description |
|
|
16
|
+
|----------------|--------------------------------------------------|
|
|
17
|
+
| `header-left` | Slot to add custom contents to the left side of header e.g. ef-icon, ef-checkbox |
|
|
18
|
+
| `header-right` | Slot to add custom contents to the right side of header e.g. ef-icon, ef-checkbox |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ef-appstate-bar
|
|
2
|
+
|
|
3
|
+
Used to display at the top of application to provide a status or information.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
| Property | Attribute | Type | Default | Description |
|
|
8
|
+
|-----------|-----------|---------------------------------|---------|--------------------------------------------------|
|
|
9
|
+
| `heading` | `heading` | `string` | "" | Text to display in heading section. |
|
|
10
|
+
| `state` | `state` | `"info" \| "highlight" \| null` | null | (optional) Type of state bar. Supported value are `info`, `highlight`. |
|
|
11
|
+
|
|
12
|
+
## Events
|
|
13
|
+
|
|
14
|
+
| Event | Description |
|
|
15
|
+
|---------|------------------------------------|
|
|
16
|
+
| `clear` | fired when clear button is clicked |
|
|
17
|
+
|
|
18
|
+
## Slots
|
|
19
|
+
|
|
20
|
+
| Name | Description |
|
|
21
|
+
|---------|-------------------------------------------|
|
|
22
|
+
| `right` | place custom content on the right of bar. |
|
|
@@ -50,10 +50,20 @@
|
|
|
50
50
|
"name": "opened",
|
|
51
51
|
"description": "Auto suggest popup's open state",
|
|
52
52
|
"type": "boolean",
|
|
53
|
-
"default": "
|
|
53
|
+
"default": "false"
|
|
54
54
|
}
|
|
55
55
|
],
|
|
56
56
|
"properties": [
|
|
57
|
+
{
|
|
58
|
+
"name": "defaultDebounceRate",
|
|
59
|
+
"type": "100",
|
|
60
|
+
"default": "100"
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"name": "defaultMoreSearchText",
|
|
64
|
+
"type": "\"More results for {0}\"",
|
|
65
|
+
"default": "\"More results for {0}\""
|
|
66
|
+
},
|
|
57
67
|
{
|
|
58
68
|
"name": "attach",
|
|
59
69
|
"attribute": "attach",
|
|
@@ -130,7 +140,7 @@
|
|
|
130
140
|
"attribute": "opened",
|
|
131
141
|
"description": "Auto suggest popup's open state",
|
|
132
142
|
"type": "boolean",
|
|
133
|
-
"default": "
|
|
143
|
+
"default": "false"
|
|
134
144
|
}
|
|
135
145
|
],
|
|
136
146
|
"events": [
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# ef-autosuggest
|
|
2
|
+
|
|
3
|
+
Shows suggestions based on users' query.
|
|
4
|
+
It can be used by attaching to text form control
|
|
5
|
+
such as TextField, Multi Input, etc.
|
|
6
|
+
Autosuggest supports various use cases such as
|
|
7
|
+
custom rendering, pagination, asynchronous data request, etc.
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
| Property | Attribute | Type | Default | Description |
|
|
12
|
+
|------------------|--------------------|----------------------------------------------|-------------------------|--------------------------------------------------|
|
|
13
|
+
| `attach` | `attach` | `AutosuggestTargetElement \| string \| null` | null | An HTML Element or CSS selector |
|
|
14
|
+
| `debounceRate` | `debounce-rate` | `number` | "100" | Debounce rate in ms of the filter as a number.<br />Used to throttle the filter rate so as not to trigger unneeded filtering |
|
|
15
|
+
| `highlightable` | | `AutosuggestHighlightable` | "itemHighlightable" | A function that is applied to every suggestion during the render process<br />to say whether the item can be highlighted and selected. Only items that return true are considered.<br />By default the function checks for `item` `highlightable` property. |
|
|
16
|
+
| `htmlRenderer` | `html-renderer` | `boolean` | false | If set to true, the render function is not called. Instead the wrapper element<br />should populate and destroy suggestion elements. Rendering items manually<br />may have performance benefits in frameworks that use virtual DOM (such as `Vue`, `React`, `hyperHTML` and others) |
|
|
17
|
+
| `loading` | `loading` | `boolean` | false | If set to true show loading mask |
|
|
18
|
+
| `moreResults` | `more-results` | `boolean` | false | If set to true display 'Has more results' item |
|
|
19
|
+
| `moreSearchText` | `more-search-text` | `string` | "defaultMoreSearchText" | Custom text for More Search |
|
|
20
|
+
| `opened` | `opened` | `boolean` | false | Auto suggest popup's open state |
|
|
21
|
+
| `query` | | `AutosuggestQuery \| null` | null | An object that represents a query from attach target |
|
|
22
|
+
| `renderer` | | `AutosuggestRenderer` | "itemRenderer" | A renderer applied to suggestion.<br />By default a render maps data to item attributes |
|
|
23
|
+
| `requestOnFocus` | `request-on-focus` | `boolean` | false | Request suggestions when attach target is focused |
|
|
24
|
+
| `suggestions` | | `AutosuggestItem[]` | [] | A list of suggestion items |
|
|
25
|
+
|
|
26
|
+
## Methods
|
|
27
|
+
|
|
28
|
+
| Method | Type | Description |
|
|
29
|
+
|----------------------|----------------------|--------------------------------------------------|
|
|
30
|
+
| `onInputBlur` | `(event: any): void` | Run when input has lost focus<br /><br />**event**: by default `blur` event is listened |
|
|
31
|
+
| `onInputFocus` | `(event: any): void` | Run when input received focus<br /><br />**event**: by default `focus` event is listened |
|
|
32
|
+
| `onInputKeyDown` | `(event: any): void` | Run when input key down event has happened<br /><br />**event**: by default `keydown` event is listened |
|
|
33
|
+
| `onInputValueChange` | `(event: any): void` | Run when attach target value changes.<br /><br />**event**: by default `value-changed` event is listened |
|
|
34
|
+
| `refit` | `(): void` | Set the width |
|
|
35
|
+
|
|
36
|
+
## Events
|
|
37
|
+
|
|
38
|
+
| Event | Description |
|
|
39
|
+
|-------------------------------|--------------------------------------------------|
|
|
40
|
+
| `add-attach-target-events` | Fired when attach has been set |
|
|
41
|
+
| `item-highlight` | Fired when an item gets highlighted or highlight is removed |
|
|
42
|
+
| `item-select` | Fired when an item gets selected |
|
|
43
|
+
| `remove-attach-target-events` | Fired when attach has been removed |
|
|
44
|
+
| `suggestions-changed` | Fired when suggestions changed |
|
|
45
|
+
| `suggestions-clear-requested` | Fired when auto suggest requests to clear the data. If used in reactive application, prevent default and set suggestions to [] |
|
|
46
|
+
| `suggestions-fetch-requested` | Fired when auto suggest requests the data |
|
|
47
|
+
| `suggestions-query` | Fired when input value has changed and the query must be set |
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"name": "disabled",
|
|
50
50
|
"description": "Set state to disabled",
|
|
51
51
|
"type": "boolean",
|
|
52
|
-
"default": "
|
|
52
|
+
"default": "false"
|
|
53
53
|
}
|
|
54
54
|
],
|
|
55
55
|
"properties": [
|
|
@@ -105,7 +105,7 @@
|
|
|
105
105
|
"attribute": "disabled",
|
|
106
106
|
"description": "Set state to disabled",
|
|
107
107
|
"type": "boolean",
|
|
108
|
-
"default": "
|
|
108
|
+
"default": "false"
|
|
109
109
|
}
|
|
110
110
|
],
|
|
111
111
|
"events": [
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ef-button
|
|
2
|
+
|
|
3
|
+
Use button for actions in forms, dialogs,
|
|
4
|
+
and more with support for different states and styles.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
| Property | Attribute | Type | Default | Description |
|
|
9
|
+
|---------------|---------------|-----------------------|---------|--------------------------------------------------|
|
|
10
|
+
| `active` | `active` | `boolean` | false | An active or inactive state, can only be used with toggles property/attribute |
|
|
11
|
+
| `cta` | `cta` | `boolean` | false | Set state to call-to-action |
|
|
12
|
+
| `disabled` | `disabled` | `boolean` | false | Set state to disabled |
|
|
13
|
+
| `hoverIcon` | `hover-icon` | `string \| null` | null | Specify icon to display when hovering. Value can be icon name |
|
|
14
|
+
| `icon` | `icon` | `string \| null` | null | Specify icon to display in button. Value can be icon name |
|
|
15
|
+
| `textpos` | `textpos` | `"before" \| "after"` | "after" | Customises text alignment when specified alongside `icon` property<br />Value can be `before` or `after` |
|
|
16
|
+
| `toggles` | `toggles` | `boolean` | false | Enable or disable ability to be toggled |
|
|
17
|
+
| `transparent` | `transparent` | `boolean` | false | Removes background when specified alongside `icon` property |
|
|
18
|
+
|
|
19
|
+
## Events
|
|
20
|
+
|
|
21
|
+
| Event | Description |
|
|
22
|
+
|------------------|--------------------------------------------------|
|
|
23
|
+
| `active-changed` | Dispatched on changing `active` property state by taping on button when property `toggles` is true. |
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# ef-button-bar
|
|
2
|
+
|
|
3
|
+
Used to display multiple buttons to create a list of commands bar.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
| Property | Attribute | Type | Default | Description |
|
|
8
|
+
|-----------|-----------|-----------|---------|--------------------------------------------------|
|
|
9
|
+
| `managed` | `managed` | `boolean` | false | Manages user interaction, only allowing one toggle button to be active at any one time. |
|
|
@@ -73,13 +73,13 @@
|
|
|
73
73
|
"name": "readonly",
|
|
74
74
|
"description": "Set readonly state",
|
|
75
75
|
"type": "boolean",
|
|
76
|
-
"default": "
|
|
76
|
+
"default": "false"
|
|
77
77
|
},
|
|
78
78
|
{
|
|
79
79
|
"name": "disabled",
|
|
80
80
|
"description": "Set disabled state",
|
|
81
81
|
"type": "boolean",
|
|
82
|
-
"default": "
|
|
82
|
+
"default": "false"
|
|
83
83
|
}
|
|
84
84
|
],
|
|
85
85
|
"properties": [
|
|
@@ -168,14 +168,14 @@
|
|
|
168
168
|
"attribute": "readonly",
|
|
169
169
|
"description": "Set readonly state",
|
|
170
170
|
"type": "boolean",
|
|
171
|
-
"default": "
|
|
171
|
+
"default": "false"
|
|
172
172
|
},
|
|
173
173
|
{
|
|
174
174
|
"name": "disabled",
|
|
175
175
|
"attribute": "disabled",
|
|
176
176
|
"description": "Set disabled state",
|
|
177
177
|
"type": "boolean",
|
|
178
|
-
"default": "
|
|
178
|
+
"default": "false"
|
|
179
179
|
}
|
|
180
180
|
],
|
|
181
181
|
"events": [
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# ef-calendar
|
|
2
|
+
|
|
3
|
+
Standard calendar element
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
| Property | Attribute | Type | Default | Description |
|
|
8
|
+
|------------------|---------------------|--------------------------|---------|--------------------------------------------------|
|
|
9
|
+
| `disabled` | `disabled` | `boolean` | false | Set disabled state |
|
|
10
|
+
| `fillCells` | `fill-cells` | `boolean` | false | Fill head and tail cell dates |
|
|
11
|
+
| `filter` | | `CalendarFilter \| null` | null | Custom filter, used for enabling/disabling certain dates |
|
|
12
|
+
| `firstDayOfWeek` | `first-day-of-week` | `number \| null` | | Set the first day of the week.<br />0 - for Sunday, 6 - for Saturday |
|
|
13
|
+
| `max` | `max` | `string` | "" | Set maximum date |
|
|
14
|
+
| `min` | `min` | `string` | "" | Set minimum date |
|
|
15
|
+
| `multiple` | `multiple` | `boolean` | false | Set to switch to multiple select mode |
|
|
16
|
+
| `range` | `range` | `boolean` | false | Set to switch to range select mode |
|
|
17
|
+
| `readonly` | `readonly` | `boolean` | false | Set readonly state |
|
|
18
|
+
| `value` | `value` | `string` | "" | Current date time value |
|
|
19
|
+
| `values` | `values` | `string[]` | | Set multiple selected values |
|
|
20
|
+
| `view` | `view` | `string` | "" | Current calendar view date |
|
|
21
|
+
| `weekdaysOnly` | `weekdays-only` | `boolean` | false | Only enable weekdays |
|
|
22
|
+
| `weekendsOnly` | `weekends-only` | `boolean` | false | Only enable weekends |
|
|
23
|
+
|
|
24
|
+
## Events
|
|
25
|
+
|
|
26
|
+
| Event | Description |
|
|
27
|
+
|-----------------|---------------------------------|
|
|
28
|
+
| `value-changed` | Fired when the `value` changes. |
|
|
29
|
+
| `view-changed` | Fired when the `view` changes. |
|
|
30
|
+
|
|
31
|
+
## Slots
|
|
32
|
+
|
|
33
|
+
| Name | Description |
|
|
34
|
+
|----------|--------------------------------------------------|
|
|
35
|
+
| `footer` | Adds slotted content into the footer of the calendar control |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# ef-canvas
|
|
2
|
+
|
|
3
|
+
A Component uses to draw graphics on a web page,
|
|
4
|
+
it works similarly to the normal HTML5 Canvas element.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
| Property | Attribute | Modifiers | Type | Default | Description |
|
|
9
|
+
|------------|------------|-----------|------------------------------------|---------|--------------------------------------------------|
|
|
10
|
+
| `autoloop` | `autoloop` | | `boolean` | | Starts an automatic animation loop.<br />Enabling the frame event. |
|
|
11
|
+
| `canvas` | | readonly | `HTMLCanvasElement` | | Html canvas element |
|
|
12
|
+
| `context` | | readonly | `CanvasRenderingContext2D \| null` | | The 2 dimensional context of the canvas, used for drawing |
|
|
13
|
+
| `ctx` | | readonly | `CanvasRenderingContext2D \| null` | | Alias of context |
|
|
14
|
+
| `height` | | | `number` | 0 | Height of canvas |
|
|
15
|
+
| `width` | | | `number` | 0 | Width of canvas |
|
|
16
|
+
|
|
17
|
+
## Methods
|
|
18
|
+
|
|
19
|
+
| Method | Type | Description |
|
|
20
|
+
|--------------|--------------------------|--------------------------------------------------|
|
|
21
|
+
| `getContext` | `(mode: string): string` | Return context of canvas,<br />support only 2D mode<br /><br />**mode**: mode of canvas's context |
|
|
22
|
+
|
|
23
|
+
## Events
|
|
24
|
+
|
|
25
|
+
| Event | Description |
|
|
26
|
+
|---------|--------------------------------------------------|
|
|
27
|
+
| `frame` | dispatched when next Frame event occurs when autoloop is set to true |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ef-card
|
|
2
|
+
|
|
3
|
+
A card frame component.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
| Property | Attribute | Type | Default | Description |
|
|
8
|
+
|----------|-----------|----------|---------|-------------------------|
|
|
9
|
+
| `config` | | | | Set card configurations |
|
|
10
|
+
| `footer` | `footer` | `string` | "" | Set text on the footer |
|
|
11
|
+
| `header` | `header` | `string` | "" | Set text on the header |
|
|
12
|
+
|
|
13
|
+
## Events
|
|
14
|
+
|
|
15
|
+
| Event | Description |
|
|
16
|
+
|----------------|-----------------------------------|
|
|
17
|
+
| `item-trigger` | Fired when card menu is selected. |
|
|
18
|
+
|
|
19
|
+
## Slots
|
|
20
|
+
|
|
21
|
+
| Name | Description |
|
|
22
|
+
|----------|--------------------------------------------------|
|
|
23
|
+
| `footer` | Adds slotted content into the footer of the card. |
|
|
24
|
+
| `header` | Adds slotted content into the header of the card. |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# ef-chart
|
|
2
|
+
|
|
3
|
+
Charting component that use ChartJS library
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
| Property | Attribute | Modifiers | Type | Default | Description |
|
|
8
|
+
|----------|-----------|-----------|---------------|---------|--------------------------------------------------|
|
|
9
|
+
| `colors` | | readonly | `string[]` | | List of available chart colors |
|
|
10
|
+
| `config` | `config` | | `ChartConfig` | null | Chart configurations. Same configuration as ChartJS |
|
|
11
|
+
|
|
12
|
+
## Methods
|
|
13
|
+
|
|
14
|
+
| Method | Type | Description |
|
|
15
|
+
|---------------|--------------------------------------|--------------------------------------------------|
|
|
16
|
+
| `updateChart` | `(config?: ChartUpdateProps=): void` | Update all data, title, scales, legends and re-render the chart based on its config<br /><br />**config**: Additional configuration for control an animation in the update process. |
|
|
@@ -19,13 +19,13 @@
|
|
|
19
19
|
"name": "readonly",
|
|
20
20
|
"description": "Set readonly state",
|
|
21
21
|
"type": "boolean",
|
|
22
|
-
"default": "
|
|
22
|
+
"default": "false"
|
|
23
23
|
},
|
|
24
24
|
{
|
|
25
25
|
"name": "disabled",
|
|
26
26
|
"description": "Set disabled state",
|
|
27
27
|
"type": "boolean",
|
|
28
|
-
"default": "
|
|
28
|
+
"default": "false"
|
|
29
29
|
}
|
|
30
30
|
],
|
|
31
31
|
"properties": [
|
|
@@ -46,14 +46,14 @@
|
|
|
46
46
|
"attribute": "readonly",
|
|
47
47
|
"description": "Set readonly state",
|
|
48
48
|
"type": "boolean",
|
|
49
|
-
"default": "
|
|
49
|
+
"default": "false"
|
|
50
50
|
},
|
|
51
51
|
{
|
|
52
52
|
"name": "disabled",
|
|
53
53
|
"attribute": "disabled",
|
|
54
54
|
"description": "Set disabled state",
|
|
55
55
|
"type": "boolean",
|
|
56
|
-
"default": "
|
|
56
|
+
"default": "false"
|
|
57
57
|
}
|
|
58
58
|
],
|
|
59
59
|
"events": [
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ef-checkbox
|
|
2
|
+
|
|
3
|
+
Form control for selecting one or several options
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
| Property | Attribute | Type | Default | Description |
|
|
8
|
+
|-----------------|-----------------|-----------|---------|----------------------------|
|
|
9
|
+
| `checked` | `checked` | `boolean` | | Value of checkbox |
|
|
10
|
+
| `disabled` | `disabled` | `boolean` | false | Set disabled state |
|
|
11
|
+
| `indeterminate` | `indeterminate` | `boolean` | | Set state to indeterminate |
|
|
12
|
+
| `readonly` | `readonly` | `boolean` | false | Set readonly state |
|
|
13
|
+
|
|
14
|
+
## Events
|
|
15
|
+
|
|
16
|
+
| Event | Description |
|
|
17
|
+
|-------------------|--------------------------------------------|
|
|
18
|
+
| `checked-changed` | Fired when the `checked` property changes. |
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# ef-clock
|
|
2
|
+
|
|
3
|
+
Display hours, minutes and seconds as clock interface
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
| Property | Attribute | Type | Default | Description |
|
|
8
|
+
|---------------|----------------|-----------|---------|--------------------------------------------------|
|
|
9
|
+
| `amPm` | `am-pm` | `boolean` | false | Display the digital clock in 12hr format. |
|
|
10
|
+
| `analogue` | `analogue` | `boolean` | false | Display clock in analogue style. |
|
|
11
|
+
| `interactive` | `interactive` | `boolean` | false | Enabled interactive mode. Allowing the user to offset the value. |
|
|
12
|
+
| `offset` | `offset` | `number` | | Get offset value |
|
|
13
|
+
| `showSeconds` | `show-seconds` | `boolean` | false | Display the seconds segment. |
|
|
14
|
+
| `tick` | `tick` | `boolean` | | Toggles clock ticking function. |
|
|
15
|
+
| `value` | `value` | `string` | | Get time value in format `hh:mm:ss` |
|
|
16
|
+
|
|
17
|
+
## Methods
|
|
18
|
+
|
|
19
|
+
| Method | Type | Description |
|
|
20
|
+
|-------------------|---------------------|--------------------------------------------------|
|
|
21
|
+
| `resizedCallback` | `(size: any): void` | Called when the element's dimension have changed<br /><br />**size**: Element size |
|
|
22
|
+
|
|
23
|
+
## Events
|
|
24
|
+
|
|
25
|
+
| Event | Description |
|
|
26
|
+
|------------------|--------------------------------------------------|
|
|
27
|
+
| `offset-changed` | Fired when the the user offsets the clock in `interactive` mode. |
|
|
28
|
+
| `value-changed` | Fired when the value property changes while ticking. |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# ef-collapse
|
|
2
|
+
|
|
3
|
+
Allows users to hide non-critical information
|
|
4
|
+
or areas of the screen, maximizing the amount of real estate
|
|
5
|
+
for their primary displays.
|
|
6
|
+
|
|
7
|
+
## Properties
|
|
8
|
+
|
|
9
|
+
| Property | Attribute | Type | Default | Description |
|
|
10
|
+
|------------|------------|---------------------|---------|--------------------------------------------------|
|
|
11
|
+
| `expanded` | `expanded` | `boolean` | false | Set to expand the item |
|
|
12
|
+
| `header` | `header` | `string \| null` | null | Set text on the header |
|
|
13
|
+
| `level` | `level` | `"1" \| "2" \| "3"` | "3" | Use level styling from theme |
|
|
14
|
+
| `spacing` | `spacing` | `boolean` | false | Set to apply padding from theme to content section |
|
|
15
|
+
|
|
16
|
+
## Events
|
|
17
|
+
|
|
18
|
+
| Event | Description |
|
|
19
|
+
|--------------------|---------------------------------------------|
|
|
20
|
+
| `expanded-changed` | Fired when the `expanded` property changes. |
|
|
21
|
+
|
|
22
|
+
## Slots
|
|
23
|
+
|
|
24
|
+
| Name | Description |
|
|
25
|
+
|----------------|--------------------------------------------------|
|
|
26
|
+
| `header-left` | Slot to add custom contents to the left side of header e.g. ef-icon, ef-checkbox |
|
|
27
|
+
| `header-right` | Slot to add custom contents to the right side of header e.g. ef-icon, ef-checkbox |
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
"name": "opened",
|
|
51
51
|
"description": "Set dialog to open",
|
|
52
52
|
"type": "boolean",
|
|
53
|
-
"default": "
|
|
53
|
+
"default": "false"
|
|
54
54
|
},
|
|
55
55
|
{
|
|
56
56
|
"name": "x",
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"name": "no-cancel-on-esc-key",
|
|
67
67
|
"description": "Prevents dialog to close when user presses ESC key",
|
|
68
68
|
"type": "boolean",
|
|
69
|
-
"default": "
|
|
69
|
+
"default": "false"
|
|
70
70
|
},
|
|
71
71
|
{
|
|
72
72
|
"name": "position-target",
|
|
@@ -128,13 +128,13 @@
|
|
|
128
128
|
"attribute": "opened",
|
|
129
129
|
"description": "Set dialog to open",
|
|
130
130
|
"type": "boolean",
|
|
131
|
-
"default": "
|
|
131
|
+
"default": "false"
|
|
132
132
|
},
|
|
133
133
|
{
|
|
134
134
|
"name": "noCancelOnEscKey",
|
|
135
135
|
"description": "Prevents dialog to close when user presses ESC key",
|
|
136
136
|
"type": "boolean",
|
|
137
|
-
"default": "
|
|
137
|
+
"default": "false"
|
|
138
138
|
},
|
|
139
139
|
{
|
|
140
140
|
"name": "x",
|
|
@@ -157,25 +157,25 @@
|
|
|
157
157
|
"name": "noCancelOnOutsideClick",
|
|
158
158
|
"description": "Prevents dialog to close when user clicks outside the dialog.",
|
|
159
159
|
"type": "boolean",
|
|
160
|
-
"default": "
|
|
160
|
+
"default": "true"
|
|
161
161
|
},
|
|
162
162
|
{
|
|
163
163
|
"name": "withBackdrop",
|
|
164
164
|
"description": "False to hide backdrop.",
|
|
165
165
|
"type": "boolean",
|
|
166
|
-
"default": "
|
|
166
|
+
"default": "true"
|
|
167
167
|
},
|
|
168
168
|
{
|
|
169
169
|
"name": "draggable",
|
|
170
170
|
"description": "False to make the dialog not draggable.",
|
|
171
171
|
"type": "boolean",
|
|
172
|
-
"default": "
|
|
172
|
+
"default": "true"
|
|
173
173
|
},
|
|
174
174
|
{
|
|
175
175
|
"name": "withShadow",
|
|
176
176
|
"description": "False to remove shadow for dialog component.",
|
|
177
177
|
"type": "boolean",
|
|
178
|
-
"default": "
|
|
178
|
+
"default": "true"
|
|
179
179
|
}
|
|
180
180
|
],
|
|
181
181
|
"events": [
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# ef-color-dialog
|
|
2
|
+
|
|
3
|
+
Displays a colour picker dialog,
|
|
4
|
+
for selecting a predefined range of colours.
|
|
5
|
+
|
|
6
|
+
## Attributes
|
|
7
|
+
|
|
8
|
+
| Attribute | Type | Default | Description |
|
|
9
|
+
|------------------------|-----------|---------|--------------------------------------------------|
|
|
10
|
+
| `no-cancel-on-esc-key` | `boolean` | false | Prevents dialog to close when user presses ESC key |
|
|
11
|
+
| `position-target` | `string` | | Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`. |
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
| Property | Attribute | Type | Default | Description |
|
|
16
|
+
|--------------------------|-----------------|----------------|---------|--------------------------------------------------|
|
|
17
|
+
| `allowNocolor` | `allow-nocolor` | `boolean` | false | Set the palettes to activate no-color option |
|
|
18
|
+
| `blue` | `blue` | `string` | "" | Blue value from 0 to 255 |
|
|
19
|
+
| `draggable` | | `boolean` | true | False to make the dialog not draggable. |
|
|
20
|
+
| `green` | `green` | `string` | "" | Green value from 0 to 255 |
|
|
21
|
+
| `header` | `header` | `string\|null` | | Set Header/Title of the color dialog |
|
|
22
|
+
| `hex` | `hex` | `string` | "" | Value of hex without # sign, supports both 3-digits shorthand hex and regular 6-digits hex |
|
|
23
|
+
| `noCancelOnEscKey` | | `boolean` | false | Prevents dialog to close when user presses ESC key |
|
|
24
|
+
| `noCancelOnOutsideClick` | | `boolean` | true | Prevents dialog to close when user clicks outside the dialog. |
|
|
25
|
+
| `opened` | `opened` | `boolean` | false | Set dialog to open |
|
|
26
|
+
| `positionTarget` | | `string` | | Set position of dialog i.e. `top`, `right`, `left`, `bottom`, `center` or combination of theme e.g. `top right`. |
|
|
27
|
+
| `red` | `red` | `string` | "" | Red value from 0 to 255 |
|
|
28
|
+
| `value` | `value` | `string` | "" | Value of selected color from color dialog will be written here as hex value<br />e.g. "#00f" or "#0000ff" |
|
|
29
|
+
| `withBackdrop` | | `boolean` | true | False to hide backdrop. |
|
|
30
|
+
| `withShadow` | | `boolean` | true | False to remove shadow for dialog component. |
|
|
31
|
+
| `x` | `x` | `string` | | Set a specific x coordinate of dialog |
|
|
32
|
+
| `y` | `y` | `string` | | Set a specific y coordinate of dialog |
|
|
33
|
+
|
|
34
|
+
## Events
|
|
35
|
+
|
|
36
|
+
| Event | Description |
|
|
37
|
+
|------------------|-------------------------------------------|
|
|
38
|
+
| `opened-changed` | Fired when the `opened` property changes. |
|
|
39
|
+
| `value-changed` | Fired when the `value` property changes. |
|
|
@@ -59,19 +59,19 @@
|
|
|
59
59
|
"name": "readonly",
|
|
60
60
|
"description": "Set readonly state",
|
|
61
61
|
"type": "boolean",
|
|
62
|
-
"default": "
|
|
62
|
+
"default": "false"
|
|
63
63
|
},
|
|
64
64
|
{
|
|
65
65
|
"name": "disabled",
|
|
66
66
|
"description": "Set disabled state",
|
|
67
67
|
"type": "boolean",
|
|
68
|
-
"default": "
|
|
68
|
+
"default": "false"
|
|
69
69
|
},
|
|
70
70
|
{
|
|
71
71
|
"name": "name",
|
|
72
72
|
"description": "Set name of the element",
|
|
73
73
|
"type": "string",
|
|
74
|
-
"default": "\"
|
|
74
|
+
"default": "\"\""
|
|
75
75
|
}
|
|
76
76
|
],
|
|
77
77
|
"properties": [
|
|
@@ -171,21 +171,21 @@
|
|
|
171
171
|
"attribute": "readonly",
|
|
172
172
|
"description": "Set readonly state",
|
|
173
173
|
"type": "boolean",
|
|
174
|
-
"default": "
|
|
174
|
+
"default": "false"
|
|
175
175
|
},
|
|
176
176
|
{
|
|
177
177
|
"name": "disabled",
|
|
178
178
|
"attribute": "disabled",
|
|
179
179
|
"description": "Set disabled state",
|
|
180
180
|
"type": "boolean",
|
|
181
|
-
"default": "
|
|
181
|
+
"default": "false"
|
|
182
182
|
},
|
|
183
183
|
{
|
|
184
184
|
"name": "name",
|
|
185
185
|
"attribute": "name",
|
|
186
186
|
"description": "Set name of the element",
|
|
187
187
|
"type": "string",
|
|
188
|
-
"default": "\"
|
|
188
|
+
"default": "\"\""
|
|
189
189
|
}
|
|
190
190
|
],
|
|
191
191
|
"events": [
|
|
@@ -200,6 +200,9 @@
|
|
|
200
200
|
{
|
|
201
201
|
"name": "opened-changed",
|
|
202
202
|
"description": "Dispatched when opened state changes"
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"name": "animationiteration"
|
|
203
206
|
}
|
|
204
207
|
]
|
|
205
208
|
}
|