@xplortech/apollo-core 0.4.0 → 0.5.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 +7 -0
- package/build/style.css +3178 -474
- package/dist/apollo-core/apollo-core.css +5509 -5
- package/dist/apollo-core/apollo-core.esm.js +125 -1
- package/dist/apollo-core/app-globals-0f993ce5.js +3 -0
- package/dist/apollo-core/css-shim-bbdf0cc6.js +4 -0
- package/dist/apollo-core/dom-1f98a75f.js +73 -0
- package/dist/apollo-core/index-3c9f25ef.js +2938 -0
- package/dist/apollo-core/index-3eb5568f.js +2938 -0
- package/dist/apollo-core/index-912d1a21.js +584 -0
- package/dist/apollo-core/index.esm.js +1 -0
- package/dist/{esm/xpl-avatar_14.entry.js → apollo-core/regular-133c23b5.js} +12 -328
- package/dist/apollo-core/shadow-css-67b66845.js +389 -0
- package/dist/apollo-core/xpl-application-shell.entry.js +52 -0
- package/dist/apollo-core/xpl-avatar.entry.js +19 -0
- package/dist/apollo-core/xpl-backdrop.entry.js +21 -0
- package/dist/apollo-core/xpl-badge.entry.js +17 -0
- package/dist/{collection/components/xpl-breadcrumbs/xpl-breadcrumb-item/xpl-breadcrumb-item.js → apollo-core/xpl-breadcrumb-item.entry.js} +9 -12
- package/dist/apollo-core/xpl-breadcrumbs.entry.js +14 -0
- package/dist/apollo-core/xpl-button-row.entry.js +20 -0
- package/dist/apollo-core/xpl-button.entry.js +34 -0
- package/dist/apollo-core/xpl-checkbox.entry.js +25 -0
- package/dist/apollo-core/xpl-choicelist.entry.js +32 -0
- package/dist/apollo-core/xpl-content-area.entry.js +16 -0
- package/dist/apollo-core/xpl-divider.entry.js +14 -0
- package/dist/apollo-core/xpl-grid-item.entry.js +21 -0
- package/dist/apollo-core/xpl-grid.entry.js +31 -0
- package/dist/apollo-core/xpl-input.entry.js +2540 -0
- package/dist/apollo-core/xpl-list.entry.js +59 -0
- package/dist/apollo-core/xpl-main-nav.entry.js +26 -0
- package/dist/apollo-core/xpl-nav-item.entry.js +12 -0
- package/dist/{esm → apollo-core}/xpl-pagination.entry.js +1 -1
- package/dist/apollo-core/xpl-radio.entry.js +25 -0
- package/dist/apollo-core/xpl-secondary-nav.entry.js +12 -0
- package/dist/apollo-core/xpl-select.entry.js +660 -0
- package/dist/apollo-core/xpl-table.entry.js +85 -0
- package/dist/apollo-core/xpl-tag.entry.js +17 -0
- package/dist/apollo-core/xpl-toggle.entry.js +30 -0
- package/dist/apollo-core/xpl-utility-bar.entry.js +25 -0
- package/dist/custom-elements/index.d.ts +60 -0
- package/dist/types/Users/fernandogelin/Projects/apollo/.stencil/stories/application-shell.stories.d.ts +62 -0
- package/dist/types/Users/fernandogelin/Projects/apollo/.stencil/stories/button-row.stories.d.ts +49 -0
- package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/checkbox.stories.d.ts +10 -2
- package/dist/types/Users/fernandogelin/Projects/apollo/.stencil/stories/choicelist.stories.d.ts +41 -0
- package/dist/types/Users/fernandogelin/Projects/apollo/.stencil/stories/divider.stories.d.ts +40 -0
- package/dist/types/Users/fernandogelin/Projects/apollo/.stencil/stories/grid.stories.d.ts +150 -0
- package/dist/types/Users/fernandogelin/Projects/apollo/.stencil/stories/input.stories.d.ts +190 -0
- package/dist/types/Users/fernandogelin/Projects/apollo/.stencil/stories/list.stories.d.ts +71 -0
- package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/radio.stories.d.ts +10 -2
- package/dist/types/Users/fernandogelin/Projects/apollo/.stencil/stories/select.stories.d.ts +74 -0
- package/dist/types/Users/fernandogelin/Projects/apollo/.stencil/stories/toggle.stories.d.ts +74 -0
- package/dist/types/components/xpl-application-shell/test/xpl-application-shell.e2e.d.ts +1 -0
- package/dist/types/components/xpl-application-shell/xpl-application-shell.d.ts +24 -0
- package/dist/types/components/xpl-avatar/test/xpl-avatar.e2e.d.ts +1 -0
- package/dist/types/components/xpl-avatar/test/xpl-avatar.spec.d.ts +1 -0
- package/dist/types/components/xpl-backdrop/test/xpl-backdrop.e2e.d.ts +1 -0
- package/dist/types/components/xpl-backdrop/xpl-backdrop.d.ts +5 -0
- package/dist/types/components/xpl-badge/test/xpl-badge.e2e.d.ts +1 -0
- package/dist/types/components/xpl-badge/test/xpl-badge.spec.d.ts +1 -0
- package/dist/types/components/xpl-breadcrumbs/xpl-breadcrumb-item/test/xpl-breadcrumb-item.e2e.d.ts +1 -0
- package/dist/types/components/xpl-breadcrumbs/xpl-breadcrumbs/test/xpl-breadcrumbs.e2e.d.ts +1 -0
- package/dist/types/components/xpl-button/test/xpl-button.e2e.d.ts +1 -0
- package/dist/types/components/xpl-button/test/xpl-button.spec.d.ts +1 -0
- package/dist/types/components/xpl-button-row/test/xpl-button-row.e2e.d.ts +1 -0
- package/dist/types/components/xpl-button-row/test/xpl-button-row.spec.d.ts +1 -0
- package/dist/types/components/xpl-button-row/xpl-button-row.d.ts +35 -0
- package/dist/types/components/xpl-checkbox/test/xpl-checkbox.e2e.d.ts +1 -0
- package/dist/types/components/xpl-checkbox/test/xpl-checkbox.spec.d.ts +1 -0
- package/dist/types/components/xpl-checkbox/xpl-checkbox.d.ts +5 -0
- package/dist/types/components/xpl-choicelist/choice.d.ts +6 -0
- package/dist/types/components/xpl-choicelist/test/xpl-choicelist.e2e.d.ts +1 -0
- package/dist/types/components/xpl-choicelist/test/xpl-choicelist.spec.d.ts +1 -0
- package/dist/types/components/xpl-choicelist/xpl-choicelist.d.ts +31 -0
- package/dist/types/components/xpl-content-area/test/xpl-content-area.e2e.d.ts +1 -0
- package/dist/types/components/xpl-divider/test/xpl-divider.e2e.d.ts +1 -0
- package/dist/types/components/xpl-divider/test/xpl-divider.spec.d.ts +1 -0
- package/dist/types/components/xpl-divider/xpl-divider.d.ts +9 -0
- package/dist/types/components/xpl-dropdown/dropdownchoice.d.ts +6 -0
- package/dist/types/components/xpl-dropdown/xpl-dropdown.d.ts +10 -0
- package/dist/types/components/xpl-grid/test/xpl-grid.e2e.d.ts +1 -0
- package/dist/types/components/xpl-grid/test/xpl-grid.spec.d.ts +1 -0
- package/dist/types/components/xpl-grid/xpl-grid.d.ts +5 -0
- package/dist/types/components/xpl-grid-item/test/xpl-grid-item.e2e.d.ts +1 -0
- package/dist/types/components/xpl-grid-item/test/xpl-grid-item.spec.d.ts +1 -0
- package/dist/types/components/xpl-grid-item/xpl-grid-item.d.ts +7 -0
- package/dist/types/components/xpl-input/test/xpl-input.e2e.d.ts +1 -0
- package/dist/types/components/xpl-input/test/xpl-input.spec.d.ts +1 -0
- package/dist/types/components/xpl-input/xpl-input.d.ts +87 -0
- package/dist/types/components/xpl-list/listitem.d.ts +16 -0
- package/dist/types/components/xpl-list/test/xpl-list.e2e.d.ts +1 -0
- package/dist/types/components/xpl-list/test/xpl-list.spec.d.ts +1 -0
- package/dist/types/components/xpl-list/xpl-list.d.ts +28 -0
- package/dist/types/components/xpl-main-nav/test/xpl-main-nav.e2e.d.ts +1 -0
- package/dist/types/components/xpl-main-nav/xpl-main-nav.d.ts +9 -0
- package/dist/types/components/xpl-nav-item/test/xpl-nav-item.e2e.d.ts +1 -0
- package/dist/types/components/xpl-pagination/test/xpl-pagination.e2e.d.ts +1 -0
- package/dist/types/components/xpl-pagination/test/xpl-pagination.spec.d.ts +1 -0
- package/dist/types/components/xpl-radio/test/xpl-radio.e2e.d.ts +1 -0
- package/dist/types/components/xpl-radio/test/xpl-radio.spec.d.ts +1 -0
- package/dist/types/components/xpl-radio/xpl-radio.d.ts +4 -0
- package/dist/types/components/xpl-secondary-nav/test/secondary-nav.e2e.d.ts +1 -0
- package/dist/types/components/xpl-select/test/xpl-select.e2e.d.ts +1 -0
- package/dist/types/components/xpl-select/test/xpl-select.spec.d.ts +1 -0
- package/dist/types/components/xpl-select/xpl-select.d.ts +52 -0
- package/dist/types/components/xpl-table/test/xpl-table.e2e.d.ts +1 -0
- package/dist/types/components/xpl-table/test/xpl-table.spec.d.ts +1 -0
- package/dist/types/components/xpl-table/xpl-table.d.ts +6 -6
- package/dist/types/components/xpl-tag/test/xpl-tag.e2e.d.ts +1 -0
- package/dist/types/components/xpl-tag/test/xpl-tag.spec.d.ts +1 -0
- package/dist/types/components/xpl-tag/xpl-tag.d.ts +5 -0
- package/dist/types/components/xpl-toggle/test/xpl-toggle.e2e.d.ts +1 -0
- package/dist/types/components/xpl-toggle/test/xpl-toggle.spec.d.ts +1 -0
- package/dist/types/components/xpl-toggle/xpl-toggle.d.ts +23 -0
- package/dist/types/components/xpl-utility-bar/test/xpl-utility-bar.e2e.d.ts +1 -0
- package/dist/types/components/xpl-utility-bar/xpl-utility-bar.d.ts +12 -0
- package/dist/types/components.d.ts +508 -5
- package/package.json +1 -1
- package/dist/apollo-core/p-00996870.js +0 -1
- package/dist/apollo-core/p-21872e0f.entry.js +0 -1
- package/dist/apollo-core/p-43013b35.entry.js +0 -11
- package/dist/apollo-core/p-d8ea7d80.entry.js +0 -1
- package/dist/cjs/apollo-core.cjs.js +0 -19
- package/dist/cjs/index-716d8f57.js +0 -1442
- package/dist/cjs/index.cjs.js +0 -2
- package/dist/cjs/loader.cjs.js +0 -21
- package/dist/cjs/xpl-avatar_14.cjs.entry.js +0 -16385
- package/dist/cjs/xpl-choicelist.cjs.entry.js +0 -16
- package/dist/cjs/xpl-pagination.cjs.entry.js +0 -76
- package/dist/collection/collection-manifest.json +0 -27
- package/dist/collection/components/xpl-avatar/xpl-avatar.js +0 -158
- package/dist/collection/components/xpl-backdrop/xpl-backdrop.js +0 -7
- package/dist/collection/components/xpl-badge/xpl-badge.js +0 -50
- package/dist/collection/components/xpl-breadcrumbs/xpl-breadcrumbs/xpl-breadcrumbs.js +0 -15
- package/dist/collection/components/xpl-button/xpl-button.js +0 -214
- package/dist/collection/components/xpl-checkbox/xpl-checkbox.js +0 -139
- package/dist/collection/components/xpl-choicelist/xpl-choicelist.js +0 -9
- package/dist/collection/components/xpl-content-area/xpl-content-area.js +0 -39
- package/dist/collection/components/xpl-main-nav/xpl-main-nav.js +0 -43
- package/dist/collection/components/xpl-nav-item/xpl-nav-item.js +0 -10
- package/dist/collection/components/xpl-pagination/xpl-pagination.js +0 -189
- package/dist/collection/components/xpl-radio/xpl-radio.js +0 -122
- package/dist/collection/components/xpl-secondary-nav/xpl-secondary-nav.js +0 -9
- package/dist/collection/components/xpl-table/xpl-table.js +0 -194
- package/dist/collection/components/xpl-utility-bar/xpl-utility-bar.js +0 -10
- package/dist/custom-elements/index.js +0 -16507
- package/dist/esm/apollo-core.js +0 -17
- package/dist/esm/index-4c8962a5.js +0 -1415
- package/dist/esm/index.js +0 -1
- package/dist/esm/loader.js +0 -17
- package/dist/esm/polyfills/core-js.js +0 -11
- package/dist/esm/polyfills/css-shim.js +0 -1
- package/dist/esm/polyfills/dom.js +0 -79
- package/dist/esm/polyfills/es5-html-element.js +0 -1
- package/dist/esm/polyfills/index.js +0 -34
- package/dist/esm/polyfills/system.js +0 -6
- package/dist/esm/xpl-choicelist.entry.js +0 -12
- package/dist/index.cjs.js +0 -1
- package/dist/index.js +0 -1
- package/dist/stories/avatar.stories.js +0 -173
- package/dist/stories/backdrop.stories.js +0 -18
- package/dist/stories/badge.stories.js +0 -48
- package/dist/stories/breadcrumbs.stories.js +0 -115
- package/dist/stories/button.stories.js +0 -98
- package/dist/stories/checkbox.stories.js +0 -66
- package/dist/stories/content-area.stories.js +0 -53
- package/dist/stories/main-nav.stories.js +0 -308
- package/dist/stories/pagination.stories.js +0 -84
- package/dist/stories/radio.stories.js +0 -56
- package/dist/stories/secondary-nav.stories.js +0 -76
- package/dist/stories/table.stories.js +0 -107
- package/dist/stories/tabs.stories.js +0 -24
- package/dist/stories/utility-bar.stories.js +0 -94
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/avatar.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/backdrop.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/badge.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/breadcrumbs.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/button.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/content-area.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/main-nav.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/pagination.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/secondary-nav.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/table.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/tabs.stories.d.ts +0 -0
- /package/dist/types/Users/{awentt/Sites → fernandogelin/Projects}/apollo/.stencil/stories/utility-bar.stories.d.ts +0 -0
|
@@ -6,6 +6,20 @@
|
|
|
6
6
|
*/
|
|
7
7
|
import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
|
|
8
8
|
export namespace Components {
|
|
9
|
+
interface XplApplicationShell {
|
|
10
|
+
/**
|
|
11
|
+
* @property {string} - The width of the main navigation bar, can be passed or updated when nav-width event is emitted.
|
|
12
|
+
*/
|
|
13
|
+
"navWidth": string;
|
|
14
|
+
/**
|
|
15
|
+
* @property {boolean} - Whether or not the Grid should have space for a secondary (sub) navigation bar
|
|
16
|
+
*/
|
|
17
|
+
"withSubnav": boolean;
|
|
18
|
+
/**
|
|
19
|
+
* @property {boolean} - Whether or not the Grid should have space for a utility bar
|
|
20
|
+
*/
|
|
21
|
+
"withUtility": boolean;
|
|
22
|
+
}
|
|
9
23
|
interface XplAvatar {
|
|
10
24
|
"color"?: "green" | "yellow" | "pink" | "primary" | "secondary";
|
|
11
25
|
"disabled"?: boolean;
|
|
@@ -17,6 +31,10 @@ export namespace Components {
|
|
|
17
31
|
"target"?: string;
|
|
18
32
|
}
|
|
19
33
|
interface XplBackdrop {
|
|
34
|
+
/**
|
|
35
|
+
* @property {boolean} - When true, backdrop will have relative position. This is useful when the backdrop doesn't cover the whole view area. If false, the position will be fixed and cover the whole view area.
|
|
36
|
+
*/
|
|
37
|
+
"relative": boolean;
|
|
20
38
|
}
|
|
21
39
|
interface XplBadge {
|
|
22
40
|
"dot"?: boolean;
|
|
@@ -38,6 +56,20 @@ export namespace Components {
|
|
|
38
56
|
"value"?: string;
|
|
39
57
|
"variant": "primary" | "secondary" | "subtle" | "warning";
|
|
40
58
|
}
|
|
59
|
+
interface XplButtonRow {
|
|
60
|
+
/**
|
|
61
|
+
* The text for the primary button.
|
|
62
|
+
*/
|
|
63
|
+
"primary": "string";
|
|
64
|
+
/**
|
|
65
|
+
* The text for the secondary button. If left empty, will not render a secondary button.
|
|
66
|
+
*/
|
|
67
|
+
"secondary": "string";
|
|
68
|
+
/**
|
|
69
|
+
* The text for the tertiary button. If left empty, will not render a secondary button.
|
|
70
|
+
*/
|
|
71
|
+
"tertiary": "string";
|
|
72
|
+
}
|
|
41
73
|
interface XplCheckbox {
|
|
42
74
|
"checked"?: boolean;
|
|
43
75
|
"description"?: string;
|
|
@@ -45,9 +77,34 @@ export namespace Components {
|
|
|
45
77
|
"indeterminate"?: boolean;
|
|
46
78
|
"name"?: string;
|
|
47
79
|
"required"?: boolean;
|
|
80
|
+
"styled"?: boolean;
|
|
48
81
|
"value"?: string;
|
|
49
82
|
}
|
|
50
83
|
interface XplChoicelist {
|
|
84
|
+
/**
|
|
85
|
+
* An array of choices to be displayed in the list. Each choice should be an object with keys: - `checked` [boolean] - whether to precheck or not - `children` [Choice[]] - an array of child choices (recursive) - `description` [string] - `label` [string]
|
|
86
|
+
*/
|
|
87
|
+
"choices": Choice[];
|
|
88
|
+
/**
|
|
89
|
+
* Descriptive text to be displayed above the choicelist.
|
|
90
|
+
*/
|
|
91
|
+
"description"?: string;
|
|
92
|
+
/**
|
|
93
|
+
* The title text to be displayed above the choicelist.
|
|
94
|
+
*/
|
|
95
|
+
"heading"?: string;
|
|
96
|
+
/**
|
|
97
|
+
* Whether the user can select more than one choice (true) or only a single choice (false). Corresponds to checkboxes vs. radio buttons.
|
|
98
|
+
*/
|
|
99
|
+
"multi"?: boolean;
|
|
100
|
+
/**
|
|
101
|
+
* The `name` to be associated with form data.
|
|
102
|
+
*/
|
|
103
|
+
"name"?: string;
|
|
104
|
+
/**
|
|
105
|
+
* If `true`, will include borders around the list and between individual choices.
|
|
106
|
+
*/
|
|
107
|
+
"styled"?: boolean;
|
|
51
108
|
}
|
|
52
109
|
interface XplContentArea {
|
|
53
110
|
/**
|
|
@@ -55,6 +112,88 @@ export namespace Components {
|
|
|
55
112
|
*/
|
|
56
113
|
"size": "wide" | "narrow" | "full";
|
|
57
114
|
}
|
|
115
|
+
interface XplDivider {
|
|
116
|
+
/**
|
|
117
|
+
* The tier should be an integer between 0 and 3. Tier 0 dividers do not display text, and 1-3 increase in size with each increasing tier.
|
|
118
|
+
*/
|
|
119
|
+
"tier"?: number;
|
|
120
|
+
}
|
|
121
|
+
interface XplGrid {
|
|
122
|
+
}
|
|
123
|
+
interface XplGridItem {
|
|
124
|
+
"lg": number;
|
|
125
|
+
"md": number;
|
|
126
|
+
"sm": number;
|
|
127
|
+
"xs": number;
|
|
128
|
+
}
|
|
129
|
+
interface XplInput {
|
|
130
|
+
/**
|
|
131
|
+
* Because `id` is a reserved HTMLElement attribute, we prefix it with an underscore here so that it doesn't get automatically applied to the outer container.
|
|
132
|
+
*/
|
|
133
|
+
"_id"?: string;
|
|
134
|
+
"autocomplete"?: string;
|
|
135
|
+
/**
|
|
136
|
+
* See https://flatpickr.js.org/formatting/
|
|
137
|
+
*/
|
|
138
|
+
"dateFormat"?: string;
|
|
139
|
+
/**
|
|
140
|
+
* Optional text that appears below the input label.
|
|
141
|
+
*/
|
|
142
|
+
"description"?: string;
|
|
143
|
+
"disabled"?: boolean;
|
|
144
|
+
/**
|
|
145
|
+
* If an empty string (attribute present with no value), will display visually as an error. If a string is included, will display visually as an error and include the value as an error message.
|
|
146
|
+
*/
|
|
147
|
+
"error"?: string;
|
|
148
|
+
"label": string;
|
|
149
|
+
/**
|
|
150
|
+
* Only used when `type` = 'number' or 'date'
|
|
151
|
+
*/
|
|
152
|
+
"max"?: number | string;
|
|
153
|
+
/**
|
|
154
|
+
* For multiline inputs, a max. character count will display along with the current character count, and will automatically render as an error if the character count exceeds the max.
|
|
155
|
+
*/
|
|
156
|
+
"maxCharacterCount"?: number;
|
|
157
|
+
/**
|
|
158
|
+
* Only used when `type` = 'number' or 'date'
|
|
159
|
+
*/
|
|
160
|
+
"min"?: number | string;
|
|
161
|
+
/**
|
|
162
|
+
* For datepicker inputs, whether to allow only a single date or a range of dates. (Multiple non-consecutive dates planned to be supported in the future.)
|
|
163
|
+
*/
|
|
164
|
+
"mode"?: "single" | /* "multiple" | */ "range";
|
|
165
|
+
/**
|
|
166
|
+
* Whether to render as a singleline text input or as a multiline textarea. (If `true`, `pre` and `post` values will be ignored, if present.)
|
|
167
|
+
*/
|
|
168
|
+
"multiline"?: boolean;
|
|
169
|
+
/**
|
|
170
|
+
* Most inputs are used in forms, and should have a `name` associated with the input for handling form data.
|
|
171
|
+
*/
|
|
172
|
+
"name"?: string;
|
|
173
|
+
"placeholder"?: string;
|
|
174
|
+
/**
|
|
175
|
+
* A string (recommended max 3 characters) that gets shown visually to the left of (before) the input.
|
|
176
|
+
*/
|
|
177
|
+
"post"?: string;
|
|
178
|
+
/**
|
|
179
|
+
* A string (recommended max 8 characters) that gets shown visually to the right of (after) the input.
|
|
180
|
+
*/
|
|
181
|
+
"pre"?: string;
|
|
182
|
+
"readonly"?: boolean;
|
|
183
|
+
"required"?: boolean;
|
|
184
|
+
"step"?: number;
|
|
185
|
+
"type"?: "date" | "text" | "number" | "password";
|
|
186
|
+
/**
|
|
187
|
+
* Including a `value` will prepopulate the input with the given string.
|
|
188
|
+
*/
|
|
189
|
+
"value"?: string;
|
|
190
|
+
}
|
|
191
|
+
interface XplList {
|
|
192
|
+
/**
|
|
193
|
+
* `items` should be an array of objects with the following signature: { avatar?: string; // The URL of the avatar, or the placeholder initials (ex. "SPD"). avatars?: string[]; // The URLs of multiple avatars to be displayed in a group on the right. badges?: string[] | { // An array of strings or badge-like objects to be displayed as badges dot?: boolean; // in a group on the right. See <xpl-badge> for more details. text: string; variant?: string; }[]; href?: string; // A URL, if this list item is meant to link somewhere. title: string; // The text to be displayed for the list item. metadata?: string[] | { // An array of strings or strings with icons (reference the allowed icon: string; // Font Awesome icons) to be displayed as metadata below the title. text: string; }[]; subtext?: string; // Subtext to be displayed on the right. } - Note that you should *only use one of* `avatars`, `badges`, or `subtext`, to avoid cluttering the right-hand side of the list item.
|
|
194
|
+
*/
|
|
195
|
+
"items"?: ListItem[];
|
|
196
|
+
}
|
|
58
197
|
interface XplMainNav {
|
|
59
198
|
/**
|
|
60
199
|
* @property {string} width - The width of the Main Nav.
|
|
@@ -79,21 +218,80 @@ export namespace Components {
|
|
|
79
218
|
"disabled"?: boolean;
|
|
80
219
|
"name"?: string;
|
|
81
220
|
"required"?: boolean;
|
|
221
|
+
"styled"?: boolean;
|
|
82
222
|
"value"?: string;
|
|
83
223
|
}
|
|
84
224
|
interface XplSecondaryNav {
|
|
85
225
|
}
|
|
226
|
+
interface XplSelect {
|
|
227
|
+
/**
|
|
228
|
+
* An array of choices for the user to choose from. Each choice should be of the form: { label: string; href?: string; value?: string; isGroupHeading?: boolean; }
|
|
229
|
+
*/
|
|
230
|
+
"choices"?: DropdownChoice[];
|
|
231
|
+
/**
|
|
232
|
+
* Optional text that appears below the input label.
|
|
233
|
+
*/
|
|
234
|
+
"description"?: string;
|
|
235
|
+
"disabled"?: boolean;
|
|
236
|
+
/**
|
|
237
|
+
* If an empty string (attribute present with no value), will display visually as an error. If a string is included, will display visually as an error and include the value as an error message.
|
|
238
|
+
*/
|
|
239
|
+
"error"?: string;
|
|
240
|
+
"label"?: string;
|
|
241
|
+
/**
|
|
242
|
+
* Whether to allow a single choice or multiple choices.
|
|
243
|
+
*/
|
|
244
|
+
"mode"?: "single" | "multi";
|
|
245
|
+
"placeholder": string;
|
|
246
|
+
/**
|
|
247
|
+
* Only used in multi-choice selects. If `true`, badges representing selections that would overflow the container are replaced with "+x more" (where x is the number not shown). If `false`, the container's height will adjust to show all badges representing selections.
|
|
248
|
+
*/
|
|
249
|
+
"truncate"?: boolean;
|
|
250
|
+
}
|
|
86
251
|
interface XplTable {
|
|
87
|
-
"columns"
|
|
88
|
-
"data"
|
|
89
|
-
"freeze"
|
|
90
|
-
"multiselect"
|
|
91
|
-
"striped"
|
|
252
|
+
"columns"?: string[];
|
|
253
|
+
"data"?: string[][];
|
|
254
|
+
"freeze"?: boolean;
|
|
255
|
+
"multiselect"?: boolean;
|
|
256
|
+
"striped"?: boolean;
|
|
257
|
+
}
|
|
258
|
+
interface XplTag {
|
|
259
|
+
}
|
|
260
|
+
interface XplToggle {
|
|
261
|
+
"checked"?: boolean;
|
|
262
|
+
/**
|
|
263
|
+
* The toggle's description appears *above* the toggle.
|
|
264
|
+
*/
|
|
265
|
+
"description"?: string;
|
|
266
|
+
"disabled"?: boolean;
|
|
267
|
+
/**
|
|
268
|
+
* The toggle's heading appears *above* the toggle.
|
|
269
|
+
*/
|
|
270
|
+
"heading"?: string;
|
|
271
|
+
/**
|
|
272
|
+
* The toggle's label appears *to the right of* the toggle.
|
|
273
|
+
*/
|
|
274
|
+
"label"?: string;
|
|
275
|
+
"name"?: string;
|
|
276
|
+
/**
|
|
277
|
+
* The size of the toggle -- `default` or `small`
|
|
278
|
+
*/
|
|
279
|
+
"variant"?: "default" | "small";
|
|
92
280
|
}
|
|
93
281
|
interface XplUtilityBar {
|
|
282
|
+
/**
|
|
283
|
+
* @property {boolean} - whether or not to show the bars to control the state of the navigation bar (open/close)
|
|
284
|
+
*/
|
|
285
|
+
"navControl"?: boolean;
|
|
94
286
|
}
|
|
95
287
|
}
|
|
96
288
|
declare global {
|
|
289
|
+
interface HTMLXplApplicationShellElement extends Components.XplApplicationShell, HTMLStencilElement {
|
|
290
|
+
}
|
|
291
|
+
var HTMLXplApplicationShellElement: {
|
|
292
|
+
prototype: HTMLXplApplicationShellElement;
|
|
293
|
+
new (): HTMLXplApplicationShellElement;
|
|
294
|
+
};
|
|
97
295
|
interface HTMLXplAvatarElement extends Components.XplAvatar, HTMLStencilElement {
|
|
98
296
|
}
|
|
99
297
|
var HTMLXplAvatarElement: {
|
|
@@ -130,6 +328,12 @@ declare global {
|
|
|
130
328
|
prototype: HTMLXplButtonElement;
|
|
131
329
|
new (): HTMLXplButtonElement;
|
|
132
330
|
};
|
|
331
|
+
interface HTMLXplButtonRowElement extends Components.XplButtonRow, HTMLStencilElement {
|
|
332
|
+
}
|
|
333
|
+
var HTMLXplButtonRowElement: {
|
|
334
|
+
prototype: HTMLXplButtonRowElement;
|
|
335
|
+
new (): HTMLXplButtonRowElement;
|
|
336
|
+
};
|
|
133
337
|
interface HTMLXplCheckboxElement extends Components.XplCheckbox, HTMLStencilElement {
|
|
134
338
|
}
|
|
135
339
|
var HTMLXplCheckboxElement: {
|
|
@@ -148,6 +352,36 @@ declare global {
|
|
|
148
352
|
prototype: HTMLXplContentAreaElement;
|
|
149
353
|
new (): HTMLXplContentAreaElement;
|
|
150
354
|
};
|
|
355
|
+
interface HTMLXplDividerElement extends Components.XplDivider, HTMLStencilElement {
|
|
356
|
+
}
|
|
357
|
+
var HTMLXplDividerElement: {
|
|
358
|
+
prototype: HTMLXplDividerElement;
|
|
359
|
+
new (): HTMLXplDividerElement;
|
|
360
|
+
};
|
|
361
|
+
interface HTMLXplGridElement extends Components.XplGrid, HTMLStencilElement {
|
|
362
|
+
}
|
|
363
|
+
var HTMLXplGridElement: {
|
|
364
|
+
prototype: HTMLXplGridElement;
|
|
365
|
+
new (): HTMLXplGridElement;
|
|
366
|
+
};
|
|
367
|
+
interface HTMLXplGridItemElement extends Components.XplGridItem, HTMLStencilElement {
|
|
368
|
+
}
|
|
369
|
+
var HTMLXplGridItemElement: {
|
|
370
|
+
prototype: HTMLXplGridItemElement;
|
|
371
|
+
new (): HTMLXplGridItemElement;
|
|
372
|
+
};
|
|
373
|
+
interface HTMLXplInputElement extends Components.XplInput, HTMLStencilElement {
|
|
374
|
+
}
|
|
375
|
+
var HTMLXplInputElement: {
|
|
376
|
+
prototype: HTMLXplInputElement;
|
|
377
|
+
new (): HTMLXplInputElement;
|
|
378
|
+
};
|
|
379
|
+
interface HTMLXplListElement extends Components.XplList, HTMLStencilElement {
|
|
380
|
+
}
|
|
381
|
+
var HTMLXplListElement: {
|
|
382
|
+
prototype: HTMLXplListElement;
|
|
383
|
+
new (): HTMLXplListElement;
|
|
384
|
+
};
|
|
151
385
|
interface HTMLXplMainNavElement extends Components.XplMainNav, HTMLStencilElement {
|
|
152
386
|
}
|
|
153
387
|
var HTMLXplMainNavElement: {
|
|
@@ -178,12 +412,30 @@ declare global {
|
|
|
178
412
|
prototype: HTMLXplSecondaryNavElement;
|
|
179
413
|
new (): HTMLXplSecondaryNavElement;
|
|
180
414
|
};
|
|
415
|
+
interface HTMLXplSelectElement extends Components.XplSelect, HTMLStencilElement {
|
|
416
|
+
}
|
|
417
|
+
var HTMLXplSelectElement: {
|
|
418
|
+
prototype: HTMLXplSelectElement;
|
|
419
|
+
new (): HTMLXplSelectElement;
|
|
420
|
+
};
|
|
181
421
|
interface HTMLXplTableElement extends Components.XplTable, HTMLStencilElement {
|
|
182
422
|
}
|
|
183
423
|
var HTMLXplTableElement: {
|
|
184
424
|
prototype: HTMLXplTableElement;
|
|
185
425
|
new (): HTMLXplTableElement;
|
|
186
426
|
};
|
|
427
|
+
interface HTMLXplTagElement extends Components.XplTag, HTMLStencilElement {
|
|
428
|
+
}
|
|
429
|
+
var HTMLXplTagElement: {
|
|
430
|
+
prototype: HTMLXplTagElement;
|
|
431
|
+
new (): HTMLXplTagElement;
|
|
432
|
+
};
|
|
433
|
+
interface HTMLXplToggleElement extends Components.XplToggle, HTMLStencilElement {
|
|
434
|
+
}
|
|
435
|
+
var HTMLXplToggleElement: {
|
|
436
|
+
prototype: HTMLXplToggleElement;
|
|
437
|
+
new (): HTMLXplToggleElement;
|
|
438
|
+
};
|
|
187
439
|
interface HTMLXplUtilityBarElement extends Components.XplUtilityBar, HTMLStencilElement {
|
|
188
440
|
}
|
|
189
441
|
var HTMLXplUtilityBarElement: {
|
|
@@ -191,25 +443,49 @@ declare global {
|
|
|
191
443
|
new (): HTMLXplUtilityBarElement;
|
|
192
444
|
};
|
|
193
445
|
interface HTMLElementTagNameMap {
|
|
446
|
+
"xpl-application-shell": HTMLXplApplicationShellElement;
|
|
194
447
|
"xpl-avatar": HTMLXplAvatarElement;
|
|
195
448
|
"xpl-backdrop": HTMLXplBackdropElement;
|
|
196
449
|
"xpl-badge": HTMLXplBadgeElement;
|
|
197
450
|
"xpl-breadcrumb-item": HTMLXplBreadcrumbItemElement;
|
|
198
451
|
"xpl-breadcrumbs": HTMLXplBreadcrumbsElement;
|
|
199
452
|
"xpl-button": HTMLXplButtonElement;
|
|
453
|
+
"xpl-button-row": HTMLXplButtonRowElement;
|
|
200
454
|
"xpl-checkbox": HTMLXplCheckboxElement;
|
|
201
455
|
"xpl-choicelist": HTMLXplChoicelistElement;
|
|
202
456
|
"xpl-content-area": HTMLXplContentAreaElement;
|
|
457
|
+
"xpl-divider": HTMLXplDividerElement;
|
|
458
|
+
"xpl-grid": HTMLXplGridElement;
|
|
459
|
+
"xpl-grid-item": HTMLXplGridItemElement;
|
|
460
|
+
"xpl-input": HTMLXplInputElement;
|
|
461
|
+
"xpl-list": HTMLXplListElement;
|
|
203
462
|
"xpl-main-nav": HTMLXplMainNavElement;
|
|
204
463
|
"xpl-nav-item": HTMLXplNavItemElement;
|
|
205
464
|
"xpl-pagination": HTMLXplPaginationElement;
|
|
206
465
|
"xpl-radio": HTMLXplRadioElement;
|
|
207
466
|
"xpl-secondary-nav": HTMLXplSecondaryNavElement;
|
|
467
|
+
"xpl-select": HTMLXplSelectElement;
|
|
208
468
|
"xpl-table": HTMLXplTableElement;
|
|
469
|
+
"xpl-tag": HTMLXplTagElement;
|
|
470
|
+
"xpl-toggle": HTMLXplToggleElement;
|
|
209
471
|
"xpl-utility-bar": HTMLXplUtilityBarElement;
|
|
210
472
|
}
|
|
211
473
|
}
|
|
212
474
|
declare namespace LocalJSX {
|
|
475
|
+
interface XplApplicationShell {
|
|
476
|
+
/**
|
|
477
|
+
* @property {string} - The width of the main navigation bar, can be passed or updated when nav-width event is emitted.
|
|
478
|
+
*/
|
|
479
|
+
"navWidth"?: string;
|
|
480
|
+
/**
|
|
481
|
+
* @property {boolean} - Whether or not the Grid should have space for a secondary (sub) navigation bar
|
|
482
|
+
*/
|
|
483
|
+
"withSubnav"?: boolean;
|
|
484
|
+
/**
|
|
485
|
+
* @property {boolean} - Whether or not the Grid should have space for a utility bar
|
|
486
|
+
*/
|
|
487
|
+
"withUtility"?: boolean;
|
|
488
|
+
}
|
|
213
489
|
interface XplAvatar {
|
|
214
490
|
"color"?: "green" | "yellow" | "pink" | "primary" | "secondary";
|
|
215
491
|
"disabled"?: boolean;
|
|
@@ -221,6 +497,10 @@ declare namespace LocalJSX {
|
|
|
221
497
|
"target"?: string;
|
|
222
498
|
}
|
|
223
499
|
interface XplBackdrop {
|
|
500
|
+
/**
|
|
501
|
+
* @property {boolean} - When true, backdrop will have relative position. This is useful when the backdrop doesn't cover the whole view area. If false, the position will be fixed and cover the whole view area.
|
|
502
|
+
*/
|
|
503
|
+
"relative"?: boolean;
|
|
224
504
|
}
|
|
225
505
|
interface XplBadge {
|
|
226
506
|
"dot"?: boolean;
|
|
@@ -242,16 +522,71 @@ declare namespace LocalJSX {
|
|
|
242
522
|
"value"?: string;
|
|
243
523
|
"variant"?: "primary" | "secondary" | "subtle" | "warning";
|
|
244
524
|
}
|
|
525
|
+
interface XplButtonRow {
|
|
526
|
+
/**
|
|
527
|
+
* Fires on the primary button. If not set, the button can act as a standard submit button for a form.
|
|
528
|
+
*/
|
|
529
|
+
"onClickPrimary"?: (event: CustomEvent<any>) => void;
|
|
530
|
+
/**
|
|
531
|
+
* Adds an event listener to the secondary button.
|
|
532
|
+
*/
|
|
533
|
+
"onClickSecondary"?: (event: CustomEvent<any>) => void;
|
|
534
|
+
/**
|
|
535
|
+
* Adds an event listener to the tertiary button.
|
|
536
|
+
*/
|
|
537
|
+
"onClickTertiary"?: (event: CustomEvent<any>) => void;
|
|
538
|
+
/**
|
|
539
|
+
* The text for the primary button.
|
|
540
|
+
*/
|
|
541
|
+
"primary"?: "string";
|
|
542
|
+
/**
|
|
543
|
+
* The text for the secondary button. If left empty, will not render a secondary button.
|
|
544
|
+
*/
|
|
545
|
+
"secondary"?: "string";
|
|
546
|
+
/**
|
|
547
|
+
* The text for the tertiary button. If left empty, will not render a secondary button.
|
|
548
|
+
*/
|
|
549
|
+
"tertiary"?: "string";
|
|
550
|
+
}
|
|
245
551
|
interface XplCheckbox {
|
|
246
552
|
"checked"?: boolean;
|
|
247
553
|
"description"?: string;
|
|
248
554
|
"disabled"?: boolean;
|
|
249
555
|
"indeterminate"?: boolean;
|
|
250
556
|
"name"?: string;
|
|
557
|
+
/**
|
|
558
|
+
* @private
|
|
559
|
+
*/
|
|
560
|
+
"onCheckboxChange"?: (event: CustomEvent<any>) => void;
|
|
251
561
|
"required"?: boolean;
|
|
562
|
+
"styled"?: boolean;
|
|
252
563
|
"value"?: string;
|
|
253
564
|
}
|
|
254
565
|
interface XplChoicelist {
|
|
566
|
+
/**
|
|
567
|
+
* An array of choices to be displayed in the list. Each choice should be an object with keys: - `checked` [boolean] - whether to precheck or not - `children` [Choice[]] - an array of child choices (recursive) - `description` [string] - `label` [string]
|
|
568
|
+
*/
|
|
569
|
+
"choices"?: Choice[];
|
|
570
|
+
/**
|
|
571
|
+
* Descriptive text to be displayed above the choicelist.
|
|
572
|
+
*/
|
|
573
|
+
"description"?: string;
|
|
574
|
+
/**
|
|
575
|
+
* The title text to be displayed above the choicelist.
|
|
576
|
+
*/
|
|
577
|
+
"heading"?: string;
|
|
578
|
+
/**
|
|
579
|
+
* Whether the user can select more than one choice (true) or only a single choice (false). Corresponds to checkboxes vs. radio buttons.
|
|
580
|
+
*/
|
|
581
|
+
"multi"?: boolean;
|
|
582
|
+
/**
|
|
583
|
+
* The `name` to be associated with form data.
|
|
584
|
+
*/
|
|
585
|
+
"name"?: string;
|
|
586
|
+
/**
|
|
587
|
+
* If `true`, will include borders around the list and between individual choices.
|
|
588
|
+
*/
|
|
589
|
+
"styled"?: boolean;
|
|
255
590
|
}
|
|
256
591
|
interface XplContentArea {
|
|
257
592
|
/**
|
|
@@ -259,7 +594,93 @@ declare namespace LocalJSX {
|
|
|
259
594
|
*/
|
|
260
595
|
"size"?: "wide" | "narrow" | "full";
|
|
261
596
|
}
|
|
597
|
+
interface XplDivider {
|
|
598
|
+
/**
|
|
599
|
+
* The tier should be an integer between 0 and 3. Tier 0 dividers do not display text, and 1-3 increase in size with each increasing tier.
|
|
600
|
+
*/
|
|
601
|
+
"tier"?: number;
|
|
602
|
+
}
|
|
603
|
+
interface XplGrid {
|
|
604
|
+
}
|
|
605
|
+
interface XplGridItem {
|
|
606
|
+
"lg"?: number;
|
|
607
|
+
"md"?: number;
|
|
608
|
+
"sm"?: number;
|
|
609
|
+
"xs"?: number;
|
|
610
|
+
}
|
|
611
|
+
interface XplInput {
|
|
612
|
+
/**
|
|
613
|
+
* Because `id` is a reserved HTMLElement attribute, we prefix it with an underscore here so that it doesn't get automatically applied to the outer container.
|
|
614
|
+
*/
|
|
615
|
+
"_id"?: string;
|
|
616
|
+
"autocomplete"?: string;
|
|
617
|
+
/**
|
|
618
|
+
* See https://flatpickr.js.org/formatting/
|
|
619
|
+
*/
|
|
620
|
+
"dateFormat"?: string;
|
|
621
|
+
/**
|
|
622
|
+
* Optional text that appears below the input label.
|
|
623
|
+
*/
|
|
624
|
+
"description"?: string;
|
|
625
|
+
"disabled"?: boolean;
|
|
626
|
+
/**
|
|
627
|
+
* If an empty string (attribute present with no value), will display visually as an error. If a string is included, will display visually as an error and include the value as an error message.
|
|
628
|
+
*/
|
|
629
|
+
"error"?: string;
|
|
630
|
+
"label"?: string;
|
|
631
|
+
/**
|
|
632
|
+
* Only used when `type` = 'number' or 'date'
|
|
633
|
+
*/
|
|
634
|
+
"max"?: number | string;
|
|
635
|
+
/**
|
|
636
|
+
* For multiline inputs, a max. character count will display along with the current character count, and will automatically render as an error if the character count exceeds the max.
|
|
637
|
+
*/
|
|
638
|
+
"maxCharacterCount"?: number;
|
|
639
|
+
/**
|
|
640
|
+
* Only used when `type` = 'number' or 'date'
|
|
641
|
+
*/
|
|
642
|
+
"min"?: number | string;
|
|
643
|
+
/**
|
|
644
|
+
* For datepicker inputs, whether to allow only a single date or a range of dates. (Multiple non-consecutive dates planned to be supported in the future.)
|
|
645
|
+
*/
|
|
646
|
+
"mode"?: "single" | /* "multiple" | */ "range";
|
|
647
|
+
/**
|
|
648
|
+
* Whether to render as a singleline text input or as a multiline textarea. (If `true`, `pre` and `post` values will be ignored, if present.)
|
|
649
|
+
*/
|
|
650
|
+
"multiline"?: boolean;
|
|
651
|
+
/**
|
|
652
|
+
* Most inputs are used in forms, and should have a `name` associated with the input for handling form data.
|
|
653
|
+
*/
|
|
654
|
+
"name"?: string;
|
|
655
|
+
"placeholder"?: string;
|
|
656
|
+
/**
|
|
657
|
+
* A string (recommended max 3 characters) that gets shown visually to the left of (before) the input.
|
|
658
|
+
*/
|
|
659
|
+
"post"?: string;
|
|
660
|
+
/**
|
|
661
|
+
* A string (recommended max 8 characters) that gets shown visually to the right of (after) the input.
|
|
662
|
+
*/
|
|
663
|
+
"pre"?: string;
|
|
664
|
+
"readonly"?: boolean;
|
|
665
|
+
"required"?: boolean;
|
|
666
|
+
"step"?: number;
|
|
667
|
+
"type"?: "date" | "text" | "number" | "password";
|
|
668
|
+
/**
|
|
669
|
+
* Including a `value` will prepopulate the input with the given string.
|
|
670
|
+
*/
|
|
671
|
+
"value"?: string;
|
|
672
|
+
}
|
|
673
|
+
interface XplList {
|
|
674
|
+
/**
|
|
675
|
+
* `items` should be an array of objects with the following signature: { avatar?: string; // The URL of the avatar, or the placeholder initials (ex. "SPD"). avatars?: string[]; // The URLs of multiple avatars to be displayed in a group on the right. badges?: string[] | { // An array of strings or badge-like objects to be displayed as badges dot?: boolean; // in a group on the right. See <xpl-badge> for more details. text: string; variant?: string; }[]; href?: string; // A URL, if this list item is meant to link somewhere. title: string; // The text to be displayed for the list item. metadata?: string[] | { // An array of strings or strings with icons (reference the allowed icon: string; // Font Awesome icons) to be displayed as metadata below the title. text: string; }[]; subtext?: string; // Subtext to be displayed on the right. } - Note that you should *only use one of* `avatars`, `badges`, or `subtext`, to avoid cluttering the right-hand side of the list item.
|
|
676
|
+
*/
|
|
677
|
+
"items"?: ListItem[];
|
|
678
|
+
}
|
|
262
679
|
interface XplMainNav {
|
|
680
|
+
/**
|
|
681
|
+
* @event {string} navWidth - Emits the `nav-width` prop set by the user when the component is attached to the DOM and when the component is updated.
|
|
682
|
+
*/
|
|
683
|
+
"onNavWidth"?: (event: CustomEvent<string>) => void;
|
|
263
684
|
/**
|
|
264
685
|
* @property {string} width - The width of the Main Nav.
|
|
265
686
|
*/
|
|
@@ -278,11 +699,41 @@ declare namespace LocalJSX {
|
|
|
278
699
|
"description"?: string;
|
|
279
700
|
"disabled"?: boolean;
|
|
280
701
|
"name"?: string;
|
|
702
|
+
/**
|
|
703
|
+
* @private
|
|
704
|
+
*/
|
|
705
|
+
"onRadioChange"?: (event: CustomEvent<any>) => void;
|
|
281
706
|
"required"?: boolean;
|
|
707
|
+
"styled"?: boolean;
|
|
282
708
|
"value"?: string;
|
|
283
709
|
}
|
|
284
710
|
interface XplSecondaryNav {
|
|
285
711
|
}
|
|
712
|
+
interface XplSelect {
|
|
713
|
+
/**
|
|
714
|
+
* An array of choices for the user to choose from. Each choice should be of the form: { label: string; href?: string; value?: string; isGroupHeading?: boolean; }
|
|
715
|
+
*/
|
|
716
|
+
"choices"?: DropdownChoice[];
|
|
717
|
+
/**
|
|
718
|
+
* Optional text that appears below the input label.
|
|
719
|
+
*/
|
|
720
|
+
"description"?: string;
|
|
721
|
+
"disabled"?: boolean;
|
|
722
|
+
/**
|
|
723
|
+
* If an empty string (attribute present with no value), will display visually as an error. If a string is included, will display visually as an error and include the value as an error message.
|
|
724
|
+
*/
|
|
725
|
+
"error"?: string;
|
|
726
|
+
"label"?: string;
|
|
727
|
+
/**
|
|
728
|
+
* Whether to allow a single choice or multiple choices.
|
|
729
|
+
*/
|
|
730
|
+
"mode"?: "single" | "multi";
|
|
731
|
+
"placeholder"?: string;
|
|
732
|
+
/**
|
|
733
|
+
* Only used in multi-choice selects. If `true`, badges representing selections that would overflow the container are replaced with "+x more" (where x is the number not shown). If `false`, the container's height will adjust to show all badges representing selections.
|
|
734
|
+
*/
|
|
735
|
+
"truncate"?: boolean;
|
|
736
|
+
}
|
|
286
737
|
interface XplTable {
|
|
287
738
|
"columns"?: string[];
|
|
288
739
|
"data"?: string[][];
|
|
@@ -291,24 +742,66 @@ declare namespace LocalJSX {
|
|
|
291
742
|
"onTableSelect"?: (event: CustomEvent<any>) => void;
|
|
292
743
|
"striped"?: boolean;
|
|
293
744
|
}
|
|
745
|
+
interface XplTag {
|
|
746
|
+
"onClose"?: (event: CustomEvent<any>) => void;
|
|
747
|
+
}
|
|
748
|
+
interface XplToggle {
|
|
749
|
+
"checked"?: boolean;
|
|
750
|
+
/**
|
|
751
|
+
* The toggle's description appears *above* the toggle.
|
|
752
|
+
*/
|
|
753
|
+
"description"?: string;
|
|
754
|
+
"disabled"?: boolean;
|
|
755
|
+
/**
|
|
756
|
+
* The toggle's heading appears *above* the toggle.
|
|
757
|
+
*/
|
|
758
|
+
"heading"?: string;
|
|
759
|
+
/**
|
|
760
|
+
* The toggle's label appears *to the right of* the toggle.
|
|
761
|
+
*/
|
|
762
|
+
"label"?: string;
|
|
763
|
+
"name"?: string;
|
|
764
|
+
/**
|
|
765
|
+
* The size of the toggle -- `default` or `small`
|
|
766
|
+
*/
|
|
767
|
+
"variant"?: "default" | "small";
|
|
768
|
+
}
|
|
294
769
|
interface XplUtilityBar {
|
|
770
|
+
/**
|
|
771
|
+
* @property {boolean} - whether or not to show the bars to control the state of the navigation bar (open/close)
|
|
772
|
+
*/
|
|
773
|
+
"navControl"?: boolean;
|
|
774
|
+
/**
|
|
775
|
+
* @event {boolean} - Emits the desired state of the navigation bar (open: true/false)
|
|
776
|
+
*/
|
|
777
|
+
"onNavOpen"?: (event: CustomEvent<boolean>) => void;
|
|
295
778
|
}
|
|
296
779
|
interface IntrinsicElements {
|
|
780
|
+
"xpl-application-shell": XplApplicationShell;
|
|
297
781
|
"xpl-avatar": XplAvatar;
|
|
298
782
|
"xpl-backdrop": XplBackdrop;
|
|
299
783
|
"xpl-badge": XplBadge;
|
|
300
784
|
"xpl-breadcrumb-item": XplBreadcrumbItem;
|
|
301
785
|
"xpl-breadcrumbs": XplBreadcrumbs;
|
|
302
786
|
"xpl-button": XplButton;
|
|
787
|
+
"xpl-button-row": XplButtonRow;
|
|
303
788
|
"xpl-checkbox": XplCheckbox;
|
|
304
789
|
"xpl-choicelist": XplChoicelist;
|
|
305
790
|
"xpl-content-area": XplContentArea;
|
|
791
|
+
"xpl-divider": XplDivider;
|
|
792
|
+
"xpl-grid": XplGrid;
|
|
793
|
+
"xpl-grid-item": XplGridItem;
|
|
794
|
+
"xpl-input": XplInput;
|
|
795
|
+
"xpl-list": XplList;
|
|
306
796
|
"xpl-main-nav": XplMainNav;
|
|
307
797
|
"xpl-nav-item": XplNavItem;
|
|
308
798
|
"xpl-pagination": XplPagination;
|
|
309
799
|
"xpl-radio": XplRadio;
|
|
310
800
|
"xpl-secondary-nav": XplSecondaryNav;
|
|
801
|
+
"xpl-select": XplSelect;
|
|
311
802
|
"xpl-table": XplTable;
|
|
803
|
+
"xpl-tag": XplTag;
|
|
804
|
+
"xpl-toggle": XplToggle;
|
|
312
805
|
"xpl-utility-bar": XplUtilityBar;
|
|
313
806
|
}
|
|
314
807
|
}
|
|
@@ -316,21 +809,31 @@ export { LocalJSX as JSX };
|
|
|
316
809
|
declare module "@stencil/core" {
|
|
317
810
|
export namespace JSX {
|
|
318
811
|
interface IntrinsicElements {
|
|
812
|
+
"xpl-application-shell": LocalJSX.XplApplicationShell & JSXBase.HTMLAttributes<HTMLXplApplicationShellElement>;
|
|
319
813
|
"xpl-avatar": LocalJSX.XplAvatar & JSXBase.HTMLAttributes<HTMLXplAvatarElement>;
|
|
320
814
|
"xpl-backdrop": LocalJSX.XplBackdrop & JSXBase.HTMLAttributes<HTMLXplBackdropElement>;
|
|
321
815
|
"xpl-badge": LocalJSX.XplBadge & JSXBase.HTMLAttributes<HTMLXplBadgeElement>;
|
|
322
816
|
"xpl-breadcrumb-item": LocalJSX.XplBreadcrumbItem & JSXBase.HTMLAttributes<HTMLXplBreadcrumbItemElement>;
|
|
323
817
|
"xpl-breadcrumbs": LocalJSX.XplBreadcrumbs & JSXBase.HTMLAttributes<HTMLXplBreadcrumbsElement>;
|
|
324
818
|
"xpl-button": LocalJSX.XplButton & JSXBase.HTMLAttributes<HTMLXplButtonElement>;
|
|
819
|
+
"xpl-button-row": LocalJSX.XplButtonRow & JSXBase.HTMLAttributes<HTMLXplButtonRowElement>;
|
|
325
820
|
"xpl-checkbox": LocalJSX.XplCheckbox & JSXBase.HTMLAttributes<HTMLXplCheckboxElement>;
|
|
326
821
|
"xpl-choicelist": LocalJSX.XplChoicelist & JSXBase.HTMLAttributes<HTMLXplChoicelistElement>;
|
|
327
822
|
"xpl-content-area": LocalJSX.XplContentArea & JSXBase.HTMLAttributes<HTMLXplContentAreaElement>;
|
|
823
|
+
"xpl-divider": LocalJSX.XplDivider & JSXBase.HTMLAttributes<HTMLXplDividerElement>;
|
|
824
|
+
"xpl-grid": LocalJSX.XplGrid & JSXBase.HTMLAttributes<HTMLXplGridElement>;
|
|
825
|
+
"xpl-grid-item": LocalJSX.XplGridItem & JSXBase.HTMLAttributes<HTMLXplGridItemElement>;
|
|
826
|
+
"xpl-input": LocalJSX.XplInput & JSXBase.HTMLAttributes<HTMLXplInputElement>;
|
|
827
|
+
"xpl-list": LocalJSX.XplList & JSXBase.HTMLAttributes<HTMLXplListElement>;
|
|
328
828
|
"xpl-main-nav": LocalJSX.XplMainNav & JSXBase.HTMLAttributes<HTMLXplMainNavElement>;
|
|
329
829
|
"xpl-nav-item": LocalJSX.XplNavItem & JSXBase.HTMLAttributes<HTMLXplNavItemElement>;
|
|
330
830
|
"xpl-pagination": LocalJSX.XplPagination & JSXBase.HTMLAttributes<HTMLXplPaginationElement>;
|
|
331
831
|
"xpl-radio": LocalJSX.XplRadio & JSXBase.HTMLAttributes<HTMLXplRadioElement>;
|
|
332
832
|
"xpl-secondary-nav": LocalJSX.XplSecondaryNav & JSXBase.HTMLAttributes<HTMLXplSecondaryNavElement>;
|
|
833
|
+
"xpl-select": LocalJSX.XplSelect & JSXBase.HTMLAttributes<HTMLXplSelectElement>;
|
|
333
834
|
"xpl-table": LocalJSX.XplTable & JSXBase.HTMLAttributes<HTMLXplTableElement>;
|
|
835
|
+
"xpl-tag": LocalJSX.XplTag & JSXBase.HTMLAttributes<HTMLXplTagElement>;
|
|
836
|
+
"xpl-toggle": LocalJSX.XplToggle & JSXBase.HTMLAttributes<HTMLXplToggleElement>;
|
|
334
837
|
"xpl-utility-bar": LocalJSX.XplUtilityBar & JSXBase.HTMLAttributes<HTMLXplUtilityBarElement>;
|
|
335
838
|
}
|
|
336
839
|
}
|