@xplortech/apollo-core 2.4.3 → 2.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.
Files changed (155) hide show
  1. package/.typings/apollo-components.html-data.json +1011 -3481
  2. package/build/style.css +7 -7
  3. package/dist/apollo-core/apollo-core.css +1 -1
  4. package/dist/apollo-core/apollo-core.esm.js +1 -1
  5. package/dist/apollo-core/{p-8c1f73ea.entry.js → p-0e1877a2.entry.js} +1 -1
  6. package/dist/apollo-core/{p-94209785.entry.js → p-1c2e4034.entry.js} +1 -1
  7. package/dist/apollo-core/p-77f0fd4a.entry.js +1 -0
  8. package/dist/apollo-core/p-7c22b842.entry.js +1 -0
  9. package/dist/apollo-core/p-7d245bf0.entry.js +1 -0
  10. package/dist/apollo-core/{p-b1f4604d.entry.js → p-f4c2626d.entry.js} +1 -1
  11. package/dist/cjs/xpl-avatar_41.cjs.entry.js +11724 -1158
  12. package/dist/cjs/xpl-dynamic-table-cell.cjs.entry.js +2 -2
  13. package/dist/cjs/xpl-dynamic-table-row.cjs.entry.js +2 -2
  14. package/dist/cjs/xpl-dynamic-table.cjs.entry.js +1 -1
  15. package/dist/cjs/xpl-grid-item.cjs.entry.js +1 -1
  16. package/dist/cjs/xpl-grid.cjs.entry.js +1 -1
  17. package/dist/collection/collection-manifest.json +1 -1
  18. package/dist/collection/components/xpl-data-card/xpl-data-card.js +11 -25
  19. package/dist/collection/components/xpl-divider/xpl-divider.js +1 -1
  20. package/dist/collection/components/xpl-dropdown/dropdown.stories.js +4 -0
  21. package/dist/collection/components/xpl-dropdown/xpl-dropdown-group/xpl-dropdown-group.js +1 -1
  22. package/dist/collection/components/xpl-dropdown/xpl-dropdown-heading/xpl-dropdown-heading.js +1 -1
  23. package/dist/collection/components/xpl-dropdown/xpl-dropdown-option/xpl-dropdown-option.js +2 -2
  24. package/dist/collection/components/xpl-dropdown/xpl-dropdown.js +2 -2
  25. package/dist/collection/components/xpl-dynamic-table/dynamic-table.stories.js +4 -0
  26. package/dist/collection/components/xpl-dynamic-table/xpl-dynamic-table.js +1 -1
  27. package/dist/collection/components/xpl-dynamic-table-cell/xpl-dynamic-table-cell.js +2 -2
  28. package/dist/collection/components/xpl-dynamic-table-row/xpl-dynamic-table-row.js +2 -2
  29. package/dist/collection/components/xpl-grid/xpl-grid.js +1 -1
  30. package/dist/collection/components/xpl-grid-item/xpl-grid-item.js +1 -1
  31. package/dist/collection/components/xpl-header-accordion/header-accordion.stories.js +4 -0
  32. package/dist/collection/components/xpl-header-accordion/xpl-header-accordion.js +1 -1
  33. package/dist/collection/components/xpl-icon/icon-types.js +1 -0
  34. package/dist/collection/components/xpl-icon/icons.stories.js +47 -12
  35. package/dist/collection/components/xpl-icon/xpl-icon.js +13 -15
  36. package/dist/collection/components/xpl-input/input.stories.js +4 -0
  37. package/dist/collection/components/xpl-input/xpl-input-color/xpl-input-color.js +3 -3
  38. package/dist/collection/components/xpl-list/list.stories.js +4 -0
  39. package/dist/collection/components/xpl-progress/progress.stories.js +4 -0
  40. package/dist/collection/components/xpl-radio/radio.stories.js +4 -0
  41. package/dist/collection/components/xpl-select/select.stories.js +4 -0
  42. package/dist/collection/components/xpl-select/xpl-select.js +10 -16
  43. package/dist/collection/components/xpl-skeleton/skeleton.stories.js +4 -0
  44. package/dist/collection/components/xpl-slideout/slideout.stories.js +6 -0
  45. package/dist/collection/components/xpl-table/table.stories.js +4 -0
  46. package/dist/collection/components/xpl-table-header/table-header.stories.js +4 -0
  47. package/dist/collection/components/xpl-table-header-cell/table-header-cell.stories.js +4 -0
  48. package/dist/collection/components/xpl-table-header-cell/xpl-table-header-cell.js +5 -15
  49. package/dist/collection/components/xpl-tabs/tabs.stories.js +4 -0
  50. package/dist/collection/components/xpl-toast/toast.stories.js +4 -0
  51. package/dist/collection/components/xpl-toggle/toggle.stories.js +4 -0
  52. package/dist/collection/components/xpl-tooltip/tooltip.stories.js +4 -0
  53. package/dist/components/xpl-data-card.js +1 -1
  54. package/dist/components/xpl-divider2.js +1 -1
  55. package/dist/components/xpl-dropdown-group2.js +1 -1
  56. package/dist/components/xpl-dropdown-heading2.js +1 -1
  57. package/dist/components/xpl-dropdown-option2.js +1 -1
  58. package/dist/components/xpl-dropdown2.js +1 -1
  59. package/dist/components/xpl-dynamic-table-cell.js +1 -1
  60. package/dist/components/xpl-dynamic-table-row.js +1 -1
  61. package/dist/components/xpl-dynamic-table.js +1 -1
  62. package/dist/components/xpl-grid-item.js +1 -1
  63. package/dist/components/xpl-grid.js +1 -1
  64. package/dist/components/xpl-header-accordion.js +1 -1
  65. package/dist/components/xpl-icon2.js +1 -6
  66. package/dist/components/xpl-input2.js +1 -1
  67. package/dist/components/xpl-select2.js +1 -1
  68. package/dist/docs/xpl-accordion/readme.md +62 -0
  69. package/dist/docs/xpl-application-shell/readme.md +33 -0
  70. package/dist/docs/xpl-avatar/readme.md +35 -0
  71. package/dist/docs/xpl-backdrop/readme.md +34 -0
  72. package/dist/docs/xpl-badge/readme.md +29 -0
  73. package/dist/docs/xpl-breadcrumbs/xpl-breadcrumb-item/readme.md +19 -0
  74. package/dist/docs/xpl-breadcrumbs/xpl-breadcrumbs/readme.md +22 -0
  75. package/dist/docs/xpl-button/readme.md +44 -0
  76. package/dist/docs/xpl-button-row/readme.md +41 -0
  77. package/dist/docs/xpl-calendar/readme.md +48 -0
  78. package/dist/docs/xpl-checkbox/readme.md +47 -0
  79. package/dist/docs/xpl-choicelist/readme.md +43 -0
  80. package/dist/docs/xpl-content-area/readme.md +17 -0
  81. package/dist/docs/xpl-dashboard/readme.md +10 -0
  82. package/dist/docs/xpl-data-card/readme.md +54 -0
  83. package/dist/docs/xpl-divider/readme.md +30 -0
  84. package/dist/docs/xpl-dropdown/readme.md +80 -0
  85. package/dist/docs/xpl-dropdown/xpl-dropdown-group/readme.md +39 -0
  86. package/dist/docs/xpl-dropdown/xpl-dropdown-heading/readme.md +30 -0
  87. package/dist/docs/xpl-dropdown/xpl-dropdown-option/readme.md +36 -0
  88. package/dist/docs/xpl-dynamic-table/readme.md +19 -0
  89. package/dist/docs/xpl-dynamic-table-cell/readme.md +18 -0
  90. package/dist/docs/xpl-dynamic-table-row/readme.md +19 -0
  91. package/dist/docs/xpl-grid/readme.md +10 -0
  92. package/dist/docs/xpl-grid-item/readme.md +20 -0
  93. package/dist/docs/xpl-header-accordion/readme.md +39 -0
  94. package/dist/docs/xpl-icon/readme.md +80 -0
  95. package/dist/docs/xpl-input/readme.md +90 -0
  96. package/dist/docs/xpl-input/xpl-input-color/readme.md +61 -0
  97. package/dist/docs/xpl-input/xpl-input-date/readme.md +56 -0
  98. package/dist/docs/xpl-input/xpl-input-file/readme.md +79 -0
  99. package/dist/docs/xpl-input/xpl-input-time/readme.md +69 -0
  100. package/dist/docs/xpl-large-card/readme.md +40 -0
  101. package/dist/docs/xpl-list/readme.md +34 -0
  102. package/dist/docs/xpl-main-nav/readme.md +28 -0
  103. package/dist/docs/xpl-modal/readme.md +55 -0
  104. package/dist/docs/xpl-nav-item/readme.md +24 -0
  105. package/dist/docs/xpl-pagination/readme.md +52 -0
  106. package/dist/docs/xpl-popover/readme.md +48 -0
  107. package/dist/docs/xpl-progress/readme.md +22 -0
  108. package/dist/docs/xpl-radio/readme.md +43 -0
  109. package/dist/docs/xpl-secondary-nav/readme.md +10 -0
  110. package/dist/docs/xpl-select/readme.md +88 -0
  111. package/dist/docs/xpl-skeleton/readme.md +31 -0
  112. package/dist/docs/xpl-slideout/readme.md +46 -0
  113. package/dist/docs/xpl-tab/readme.md +25 -0
  114. package/dist/docs/xpl-tab-panel/readme.md +18 -0
  115. package/dist/docs/xpl-table/readme.md +46 -0
  116. package/dist/docs/xpl-table-header/readme.md +13 -0
  117. package/dist/docs/xpl-table-header-cell/readme.md +47 -0
  118. package/dist/docs/xpl-tabs/readme.md +54 -0
  119. package/dist/docs/xpl-tag/readme.md +30 -0
  120. package/dist/docs/xpl-toast/readme.md +42 -0
  121. package/dist/docs/xpl-toggle/readme.md +23 -0
  122. package/dist/docs/xpl-toolbar/readme.md +18 -0
  123. package/dist/docs/xpl-tooltip/readme.md +35 -0
  124. package/dist/docs/xpl-utility-bar/readme.md +55 -0
  125. package/dist/esm/xpl-avatar_41.entry.js +11724 -1158
  126. package/dist/esm/xpl-dynamic-table-cell.entry.js +2 -2
  127. package/dist/esm/xpl-dynamic-table-row.entry.js +2 -2
  128. package/dist/esm/xpl-dynamic-table.entry.js +1 -1
  129. package/dist/esm/xpl-grid-item.entry.js +1 -1
  130. package/dist/esm/xpl-grid.entry.js +1 -1
  131. package/dist/types/components/xpl-data-card/xpl-data-card.d.ts +2 -3
  132. package/dist/types/components/xpl-dynamic-table/dynamic-table.stories.d.ts +4 -0
  133. package/dist/types/components/xpl-header-accordion/header-accordion.stories.d.ts +4 -0
  134. package/dist/types/components/xpl-icon/icon-types.d.ts +2 -0
  135. package/dist/types/components/xpl-icon/xpl-icon.d.ts +1 -3
  136. package/dist/types/components/xpl-input/input.stories.d.ts +4 -0
  137. package/dist/types/components/xpl-list/list.stories.d.ts +4 -0
  138. package/dist/types/components/xpl-progress/progress.stories.d.ts +4 -0
  139. package/dist/types/components/xpl-radio/radio.stories.d.ts +4 -0
  140. package/dist/types/components/xpl-select/select.stories.d.ts +4 -0
  141. package/dist/types/components/xpl-select/xpl-select.d.ts +1 -3
  142. package/dist/types/components/xpl-slideout/slideout.stories.d.ts +6 -0
  143. package/dist/types/components/xpl-table/table.stories.d.ts +4 -0
  144. package/dist/types/components/xpl-table-header/table-header.stories.d.ts +4 -0
  145. package/dist/types/components/xpl-table-header-cell/table-header-cell.stories.d.ts +4 -0
  146. package/dist/types/components/xpl-table-header-cell/xpl-table-header-cell.d.ts +1 -2
  147. package/dist/types/components/xpl-tabs/tabs.stories.d.ts +4 -0
  148. package/dist/types/components/xpl-toast/toast.stories.d.ts +4 -0
  149. package/dist/types/components/xpl-toggle/toggle.stories.d.ts +4 -0
  150. package/dist/types/components/xpl-tooltip/tooltip.stories.d.ts +4 -0
  151. package/dist/types/components.d.ts +24 -28
  152. package/package.json +7 -4
  153. package/dist/apollo-core/p-31461db7.entry.js +0 -1
  154. package/dist/apollo-core/p-5c0236db.entry.js +0 -6
  155. package/dist/apollo-core/p-7f8e5cd0.entry.js +0 -1
@@ -0,0 +1,48 @@
1
+ # xpl-popover
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
12
+ | `disabled` | `disabled` | Whether the popover is disabled or not. | `boolean` | `false` |
13
+ | `display` | `display` | The display style of the popover, either as an arrow or a menu. - 'arrow': Displays an arrow pointing to the trigger element. - 'menu': Displays a menu-style popover without an arrow. | `"arrow" \| "menu"` | `'arrow'` |
14
+ | `isOpen` | `is-open` | Whether the popover is open by default or not. | `boolean` | `false` |
15
+ | `position` | `position` | The position of the trigger element relative to the popover. | `"bottom-end" \| "bottom-left" \| "bottom-middle" \| "bottom-right" \| "bottom-start" \| "middle-left" \| "middle-right" \| "top-end" \| "top-left" \| "top-middle" \| "top-right" \| "top-start"` | `'bottom-middle'` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | -------------- | --------------------------------------------------- | ---------------------- |
22
+ | `isOpenChange` | Event emitted when the popover is opened or closed. | `CustomEvent<boolean>` |
23
+
24
+
25
+ ## Slots
26
+
27
+ | Slot | Description |
28
+ | ----------------- | ----------------------------------------------------- |
29
+ | `"Inner Content"` | Content inside the popover |
30
+ | `"trigger"` | The element that, when clicked, will open the popover |
31
+
32
+
33
+ ## Dependencies
34
+
35
+ ### Used by
36
+
37
+ - [xpl-input-color](../xpl-input/xpl-input-color)
38
+
39
+ ### Graph
40
+ ```mermaid
41
+ graph TD;
42
+ xpl-input-color --> xpl-popover
43
+ style xpl-popover fill:#f9f,stroke:#333,stroke-width:4px
44
+ ```
45
+
46
+ ----------------------------------------------
47
+
48
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,22 @@
1
+ # xpl-progress
2
+
3
+ A progress indicator guides users through any linear, multi-step task by showing the user their completed, current, and future steps.
4
+
5
+ Progress indicators help manage a user’s expectations when completing a multistep process. They show which step the user is currently on, the total number of steps, and overall progress in completing a task.
6
+
7
+ Horizontal Progress Indicator is used in most desktop applications where a stepped process is required to finish a task and it is beneficial to the user to see their progress. This creates confidence in the user and sets expectations for the length and complexity of the process.
8
+
9
+ <!-- Auto Generated Below -->
10
+
11
+
12
+ ## Properties
13
+
14
+ | Property | Attribute | Description | Type | Default |
15
+ | ------------- | -------------- | ----------------------------------------------------- | ---------- | ----------- |
16
+ | `currentStep` | `current-step` | Current step, is the index of the current active step | `number` | `0` |
17
+ | `steps` | -- | The steps is an array of the steps name. | `string[]` | `undefined` |
18
+
19
+
20
+ ----------------------------------------------
21
+
22
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,43 @@
1
+ # xpl-radio
2
+
3
+ Radio buttons allow users to make selections or choices. Radios are always single select, and can also act as controls.
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------- | ------------- | ------------------------------------------------------------------------------------------ | --------- | ----------- |
12
+ | `checked` | `checked` | Whether the input is "on" | `boolean` | `undefined` |
13
+ | `description` | `description` | Description text for the field | `string` | `undefined` |
14
+ | `disabled` | `disabled` | Whether the input is disabled | `boolean` | `undefined` |
15
+ | `name` | `name` | The name attribute for the html input. (submittted in form as name/value pair) | `string` | `undefined` |
16
+ | `required` | `required` | Whether the input is required | `boolean` | `undefined` |
17
+ | `styled` | `styled` | Whether the input is contained in a box with a border and, in disabled state, a background | `boolean` | `undefined` |
18
+ | `value` | `value` | The value attribute for the radio input. (submittted in form as name/value pair) | `string` | `undefined` |
19
+
20
+
21
+ ## Events
22
+
23
+ | Event | Description | Type |
24
+ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
25
+ | `radioChange` | Event that emits the current value of the radio input Returns the value of the radio input if a value is provided, otherwise returns the checked state | `CustomEvent<boolean \| string>` |
26
+
27
+
28
+ ## Dependencies
29
+
30
+ ### Used by
31
+
32
+ - [xpl-choicelist](../xpl-choicelist)
33
+
34
+ ### Graph
35
+ ```mermaid
36
+ graph TD;
37
+ xpl-choicelist --> xpl-radio
38
+ style xpl-radio fill:#f9f,stroke:#333,stroke-width:4px
39
+ ```
40
+
41
+ ----------------------------------------------
42
+
43
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,10 @@
1
+ # secondary-nav
2
+
3
+ The Secondary Nav component is a component that allows navigation within the content area. It yields one slot where a <ul> element with <xpl-nav-item> elements should be rendered.
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ----------------------------------------------
9
+
10
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,88 @@
1
+ # xpl-select
2
+
3
+ Select allows users to make a single selection or multiple selections from a list of options. Items can be a simple list, grouped, simple multi-select. User selections typically appear within the Select Box once created unless multiple selections are made, where truncation or another method of showing these selections is required.
4
+
5
+ ***When the list of options contains “Actions”, use a ***[Dropdown component](https://xplor-apollo.herokuapp.com/?path=/story/components-dropdown--simple).
6
+
7
+ The `selectIcon` property accepts icon names as strings. See [xpl-icon available icons](../xpl-icon/ICONS.md) for the complete list.
8
+
9
+ ---
10
+
11
+ <!-- Auto Generated Below -->
12
+
13
+
14
+ ## Properties
15
+
16
+ | Property | Attribute | Description | Type | Default |
17
+ | -------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ---------------- |
18
+ | `choices` | -- | 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; isSelected?: boolean; isDisabled?: boolean; options?: DropdownItem[]; groupName?: string; } | `Partial<DropdownOption & DropdownOptionGroup>[]` | `[]` |
19
+ | `classNames` | `class-names` | The class name to apply to the select component. | `string` | `undefined` |
20
+ | `customDisplayValue` | `custom-display-value` | If true, enables custom display value rendering via slot. | `boolean` | `undefined` |
21
+ | `description` | `description` | Optional text that appears below the input label. | `string` | `undefined` |
22
+ | `disabled` | `disabled` | Whether the field is disabled | `boolean` | `undefined` |
23
+ | `error` | `error` | 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. | `string` | `undefined` |
24
+ | `label` | `label` | The label that appears above the select dropdown | `string` | `undefined` |
25
+ | `mode` | `mode` | Whether to allow a single choice or multiple choices. | `"multi" \| "single"` | `'single'` |
26
+ | `name` | `name` | The name of the hidden input field that contains the selected option's value(s) | `string` | `undefined` |
27
+ | `placeholder` | `placeholder` | Placeholder text that appears when the field has no value | `string` | `undefined` |
28
+ | `selectIcon` | `select-icon` | The icon to display in the select trigger button. See [xpl-icon available icons](../xpl-icon/ICONS.md) for valid icon names. | `string` | `'chevron-down'` |
29
+ | `selectedValues` | `selected-values` | The value(s) currently selected in the select component. | `string \| string[]` | `undefined` |
30
+ | `truncate` | `truncate` | 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. | `boolean` | `true` |
31
+
32
+
33
+ ## Events
34
+
35
+ | Event | Description | Type |
36
+ | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
37
+ | `changeEvent` | Emits the value of the selected option in the select menu on change | `CustomEvent<string \| string[]>` |
38
+ | `dropdownStateChange` | Emits when the dropdown opens or closes | `CustomEvent<boolean>` |
39
+ | `selectChange` | Emits the value of the selected option in the select menu on change | `CustomEvent<string>` |
40
+ | `triggerDropdown` | Emits before the dropdown state changes, allowing listeners to prevent the default behavior. The event detail contains the previous and new dropdown states. | `CustomEvent<{ prevState: boolean; nextState: boolean; }>` |
41
+
42
+
43
+ ## Methods
44
+
45
+ ### `reset() => Promise<void>`
46
+
47
+ Resets the select component to its initial state with no selections.
48
+ This clears all selected values and returns the component to its default state.
49
+
50
+ #### Returns
51
+
52
+ Type: `Promise<void>`
53
+
54
+
55
+
56
+
57
+ ## Dependencies
58
+
59
+ ### Used by
60
+
61
+ - [xpl-pagination](../xpl-pagination)
62
+ - [xpl-tabs](../xpl-tabs)
63
+
64
+ ### Depends on
65
+
66
+ - [xpl-tag](../xpl-tag)
67
+ - [xpl-icon](../xpl-icon)
68
+ - [xpl-dropdown](../xpl-dropdown)
69
+
70
+ ### Graph
71
+ ```mermaid
72
+ graph TD;
73
+ xpl-select --> xpl-tag
74
+ xpl-select --> xpl-icon
75
+ xpl-select --> xpl-dropdown
76
+ xpl-dropdown --> xpl-dropdown-group
77
+ xpl-dropdown --> xpl-dropdown-option
78
+ xpl-dropdown-group --> xpl-dropdown-group
79
+ xpl-dropdown-group --> xpl-dropdown-option
80
+ xpl-dropdown-group --> xpl-dropdown-heading
81
+ xpl-pagination --> xpl-select
82
+ xpl-tabs --> xpl-select
83
+ style xpl-select fill:#f9f,stroke:#333,stroke-width:4px
84
+ ```
85
+
86
+ ----------------------------------------------
87
+
88
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,31 @@
1
+ # xpl-skeleton
2
+
3
+ Skeleton components are progress indicators used for full page loading states that reduce the perception of long loading times and provide both reassurance to the user as well as clues for how the page will ultimately look.
4
+
5
+ Includes:
6
+ Components - Text, Shape, Data
7
+ Variants - Text: Display, Title, Body Shape: rectangle, pill, circle, square
8
+ Properties - Text/Body: show 1, 2 or 3 lines
9
+
10
+ **Note: The “shimmer” effect uses Tailwind’s `animated-pulse` for the duration skeletons are present. The [animated pulse](https://tailwindcss.com/docs/animation#adding-a-pulse-animation) animates the color between our `color-background-surface-transparent-10` and `color-background-surface-transparent-5` variables.
11
+
12
+
13
+ <!-- Auto Generated Below -->
14
+
15
+
16
+ ## Properties
17
+
18
+ | Property | Attribute | Description | Type | Default |
19
+ | ------------ | ------------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------- |
20
+ | `classNames` | `class-names` | A CSS class name to apply to the component. | `string` | `undefined` |
21
+ | `fullWidth` | `full-width` | If true, the skeleton will take up the full width of its container. | `boolean` | `undefined` |
22
+ | `height` | `height` | The height of the skeleton. (e.g. '100px', '100%', 'auto') accepts any valid CSS height value | `string` | `undefined` |
23
+ | `margin` | `margin` | The margin of the skeleton. (e.g. '10px', '1rem', '1rem 0') accepts any valid CSS margin value | `string` | `undefined` |
24
+ | `shape` | `shape` | The shape of the skeleton. | `"circle" \| "rectangle" \| "square"` | `'rectangle'` |
25
+ | `size` | `size` | The predefined size of the skeleton. | `"body" \| "custom" \| "display" \| "title-1" \| "title-2" \| "title-3" \| "title-4" \| "title-5"` | `'custom'` |
26
+ | `width` | `width` | The width of the skeleton. (e.g. '100px', '100%', 'auto') accepts any valid CSS width value | `string` | `undefined` |
27
+
28
+
29
+ ----------------------------------------------
30
+
31
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,46 @@
1
+ # xpl-slideout
2
+
3
+ Content and Footer subcomponents are optional and can be hidden. Slideout always has a header with an X close button upper right. Slide Out Panel OPTIONALLY uses the [<xpl-backdrop>](https://xplor-apollo.herokuapp.com/?path=/story/components-backdrop--backdrop) component to overlay content and create focus on the Slide Out Panel content.
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------ | ------------- | ------------------------------------------------------------------------ | ------------------------ | ----------- |
12
+ | `backdrop` | `backdrop` | Whether to show a backdrop behind the slideout. | `boolean` | `false` |
13
+ | `isOpen` | `is-open` | Whether the slideout is open. | `boolean` | `false` |
14
+ | `showFooter` | `show-footer` | Whether to show the footer section in the slideout. | `boolean` | `true` |
15
+ | `variant` | `variant` | The visual style variant of the slideout. Can be 'default' or 'warning'. | `"default" \| "warning"` | `'default'` |
16
+
17
+
18
+ ## Events
19
+
20
+ | Event | Description | Type |
21
+ | -------------- | ----------------------------------------- | ---------------------- |
22
+ | `isOpenChange` | Emitted when the isOpen property changes. | `CustomEvent<boolean>` |
23
+
24
+
25
+ ## Dependencies
26
+
27
+ ### Depends on
28
+
29
+ - [xpl-backdrop](../xpl-backdrop)
30
+ - [xpl-button](../xpl-button)
31
+ - [xpl-icon](../xpl-icon)
32
+ - [xpl-divider](../xpl-divider)
33
+
34
+ ### Graph
35
+ ```mermaid
36
+ graph TD;
37
+ xpl-slideout --> xpl-backdrop
38
+ xpl-slideout --> xpl-button
39
+ xpl-slideout --> xpl-icon
40
+ xpl-slideout --> xpl-divider
41
+ style xpl-slideout fill:#f9f,stroke:#333,stroke-width:4px
42
+ ```
43
+
44
+ ----------------------------------------------
45
+
46
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,25 @@
1
+ # xpl-tab
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------- | ---------- | ---------------------------------------------------------- | --------- | ----------- |
12
+ | `selected` | `selected` | Whether the tab is selected | `boolean` | `false` |
13
+ | `target` | `target` | The target of the tab, required for the tab to be selected | `string` | `undefined` |
14
+
15
+
16
+ ## Events
17
+
18
+ | Event | Description | Type |
19
+ | ----------- | ----------------------------------------------- | --------------------- |
20
+ | `tabChange` | Event that emits the target of the selected tab | `CustomEvent<string>` |
21
+
22
+
23
+ ----------------------------------------------
24
+
25
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,18 @@
1
+ # xpl-tab-panel
2
+
3
+
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ---------- | ---------- | ---------------------------------------------------------- | --------- | ----------- |
12
+ | `selected` | `selected` | Whether the panel is selected | `boolean` | `false` |
13
+ | `target` | `target` | The target of the tab, required for the tab to be selected | `string` | `undefined` |
14
+
15
+
16
+ ----------------------------------------------
17
+
18
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,46 @@
1
+ # xpl-table
2
+
3
+ Tables are used to organize and display information from a data set.
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- |
12
+ | `columns` | -- | The header values for each column. | `string[]` | `undefined` |
13
+ | `data` | -- | The data for the body of the table. | `string[][]` | `undefined` |
14
+ | `footer` | -- | The data for the footer of the table. | `string[][]` | `undefined` |
15
+ | `freeze` | `freeze` | When true, the first column of the table is sticky and will cover the leftmost rows in a horizontally scrollable container. | `boolean` | `undefined` |
16
+ | `isSortable` | `is-sortable` | Toggles to show the sort button on each table head | `boolean` | `false` |
17
+ | `multiselect` | `multiselect` | Toggles a selectable checkbox for each row in the table | `boolean` | `undefined` |
18
+ | `selectedValues` | -- | The values for the input for each row when multiselect is activated. | `string[]` | `[]` |
19
+ | `sortableColumns` | -- | Manually determined if the column is sortable | `boolean[]` | `[]` |
20
+ | `striped` | `striped` | Toggles an optional styling of the background of each even row of the table body. | `boolean` | `undefined` |
21
+
22
+
23
+ ## Events
24
+
25
+ | Event | Description | Type |
26
+ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
27
+ | `sortChanged` | Emits an event whenever the sort changes. The 'sortChanged' event passes an object with colNum (number), colName (string), sortTypeArr(string[]). The default action can be overridden by calling event.preventDefault(). | `CustomEvent<{ colNum: number; colName: string; sortTypeArr: string[]; }>` |
28
+ | `tableSelect` | Callback function that is called when the checkbox for a row of a `multiselect` table is checked | `CustomEvent<any>` |
29
+
30
+
31
+ ## Dependencies
32
+
33
+ ### Depends on
34
+
35
+ - [xpl-icon](../xpl-icon)
36
+
37
+ ### Graph
38
+ ```mermaid
39
+ graph TD;
40
+ xpl-table --> xpl-icon
41
+ style xpl-table fill:#f9f,stroke:#333,stroke-width:4px
42
+ ```
43
+
44
+ ----------------------------------------------
45
+
46
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,13 @@
1
+ # xpl-table-header
2
+
3
+ Component parts used to assemble the Dynamic Table.
4
+
5
+ > **Note:** This component is currently in beta. Use with caution as it may have breaking changes in future releases.
6
+
7
+
8
+ <!-- Auto Generated Below -->
9
+
10
+
11
+ ----------------------------------------------
12
+
13
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,47 @@
1
+ # xpl-table-header-cell
2
+
3
+ > **Note:** This component is currently in beta. Use with caution as it may have breaking changes in future releases.
4
+
5
+ The `icon` property accepts icon names as strings. See [xpl-icon available icons](../xpl-icon/ICONS.md) for the complete list.
6
+
7
+ ---
8
+
9
+ <!-- Auto Generated Below -->
10
+
11
+
12
+ ## Properties
13
+
14
+ | Property | Attribute | Description | Type | Default |
15
+ | ---------- | ---------- | -------------------------------------------------------------------------------------------------------- | --------------------------------- | ----------- |
16
+ | `icon` | `icon` | Icon to display in the cell. See [xpl-icon available icons](../xpl-icon/ICONS.md) for valid icon names. | `string` | `undefined` |
17
+ | `label` | `label` | | `string` | `''` |
18
+ | `sortable` | `sortable` | | `boolean` | `false` |
19
+ | `type` | `type` | | `"checkbox" \| "icon" \| "label"` | `'label'` |
20
+ | `width` | `width` | | `number` | `undefined` |
21
+
22
+
23
+ ## Events
24
+
25
+ | Event | Description | Type |
26
+ | ------------- | ---------------------------------------- | ---------------------------------------- |
27
+ | `sortChanged` | Emitted when the sort direction changes. | `CustomEvent<"asc" \| "desc" \| "none">` |
28
+
29
+
30
+ ## Dependencies
31
+
32
+ ### Depends on
33
+
34
+ - [xpl-checkbox](../xpl-checkbox)
35
+ - [xpl-icon](../xpl-icon)
36
+
37
+ ### Graph
38
+ ```mermaid
39
+ graph TD;
40
+ xpl-table-header-cell --> xpl-checkbox
41
+ xpl-table-header-cell --> xpl-icon
42
+ style xpl-table-header-cell fill:#f9f,stroke:#333,stroke-width:4px
43
+ ```
44
+
45
+ ----------------------------------------------
46
+
47
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,54 @@
1
+ # xpl-tabs
2
+
3
+ Tabs organize content across different screens, data sets, and other interactions.
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ----------- | ------------ | -------------------------------------------------------- | --------- | ----------- |
12
+ | `fullWidth` | `full-width` | Whether to make the tabs full width | `boolean` | `false` |
13
+ | `value` | `value` | The selected tab target value, defaults to the first tab | `string` | `undefined` |
14
+
15
+
16
+ ## Events
17
+
18
+ | Event | Description | Type |
19
+ | ----------- | ----------------------------------------------- | --------------------- |
20
+ | `tabChange` | Event that emits the target of the selected tab | `CustomEvent<string>` |
21
+
22
+
23
+ ## Slots
24
+
25
+ | Slot | Description |
26
+ | ----------- | ------------------------------------------------------------------------------------ |
27
+ | `"heading"` | The heading for each tab (required, target attribute is required on the xpl-tab) |
28
+ | `"panel"` | The panel for each tab (required, target attribute is required on the xpl-tab-panel) |
29
+
30
+
31
+ ## Dependencies
32
+
33
+ ### Depends on
34
+
35
+ - [xpl-select](../xpl-select)
36
+
37
+ ### Graph
38
+ ```mermaid
39
+ graph TD;
40
+ xpl-tabs --> xpl-select
41
+ xpl-select --> xpl-tag
42
+ xpl-select --> xpl-icon
43
+ xpl-select --> xpl-dropdown
44
+ xpl-dropdown --> xpl-dropdown-group
45
+ xpl-dropdown --> xpl-dropdown-option
46
+ xpl-dropdown-group --> xpl-dropdown-group
47
+ xpl-dropdown-group --> xpl-dropdown-option
48
+ xpl-dropdown-group --> xpl-dropdown-heading
49
+ style xpl-tabs fill:#f9f,stroke:#333,stroke-width:4px
50
+ ```
51
+
52
+ ----------------------------------------------
53
+
54
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,30 @@
1
+ # xpl-tag
2
+
3
+ Tags represent a set of interactive keywords that help label, organize, and categorize objects. Tags can be added or removed from an object by the user. Unlike Badges, Tags are clickable, draggable, used in dropdowns, multi-select, search bars, etc..
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Events
9
+
10
+ | Event | Description | Type |
11
+ | ------- | --------------------------------------------------------------------- | ------------------ |
12
+ | `close` | Callback function that is called when tag text or `x` icon is clicked | `CustomEvent<any>` |
13
+
14
+
15
+ ## Dependencies
16
+
17
+ ### Used by
18
+
19
+ - [xpl-select](../xpl-select)
20
+
21
+ ### Graph
22
+ ```mermaid
23
+ graph TD;
24
+ xpl-select --> xpl-tag
25
+ style xpl-tag fill:#f9f,stroke:#333,stroke-width:4px
26
+ ```
27
+
28
+ ----------------------------------------------
29
+
30
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,42 @@
1
+ # xpl-toast
2
+
3
+ Toasts are brief, non-disruptive messages that provide quick, at-a-glance feedback. They can have 3 sentiments; neutral, positive and negative and contain actions such as a button or link, or a close button. Messaging can include a title and caption limited to 85 characters. Keep your toast messaging short and to the point and tone in line with the sentiment of the Toast.
4
+
5
+ The Toast component is configurable by Sentiment plus show/hide properties for Icon, Caption, Button and Dismissible. Use the nested component’s properties to customize further as needed.
6
+
7
+ When possible, Toasts should auto-dismiss after 8 seconds. When an action is present, it may not be desirable to time out the Toast depending on your specific context.
8
+
9
+ Match your messaging with the sentiment of the toast. Most messages will have a neutral sentiment. Reserve negative sentiments for when an explicit failure has occurred. Give users the information they need to correct the issue.
10
+
11
+ Toasts only support a single action and up to 85 characters. If multiple actions can be taken, or the message is longer than a few words, use a [Modal component](https://xplor-apollo.herokuapp.com/?path=/story/components-modal--modal) instead.
12
+
13
+ <!-- Auto Generated Below -->
14
+
15
+
16
+ ## Properties
17
+
18
+ | Property | Attribute | Description | Type | Default |
19
+ | ------------- | ------------- | ----------- | ------------------------------------- | ----------- |
20
+ | `caption` | `caption` | | `string` | `undefined` |
21
+ | `dismissable` | `dismissable` | | `boolean` | `true` |
22
+ | `showIcon` | `show-icon` | | `boolean` | `true` |
23
+ | `timeout` | `timeout` | | `number` | `8000` |
24
+ | `variant` | `variant` | | `"neutral" \| "success" \| "warning"` | `'neutral'` |
25
+
26
+
27
+ ## Dependencies
28
+
29
+ ### Depends on
30
+
31
+ - [xpl-icon](../xpl-icon)
32
+
33
+ ### Graph
34
+ ```mermaid
35
+ graph TD;
36
+ xpl-toast --> xpl-icon
37
+ style xpl-toast fill:#f9f,stroke:#333,stroke-width:4px
38
+ ```
39
+
40
+ ----------------------------------------------
41
+
42
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,23 @@
1
+ # xpl-toggle
2
+
3
+ A Toggle is a type of form control that is used to switch between enabled and disabled states of an element.
4
+
5
+ <!-- Auto Generated Below -->
6
+
7
+
8
+ ## Properties
9
+
10
+ | Property | Attribute | Description | Type | Default |
11
+ | ------------- | ------------- | ------------------------------------------------------------------------------ | ---------------------- | ----------- |
12
+ | `checked` | `checked` | Whether the toggle is `on` | `boolean` | `undefined` |
13
+ | `description` | `description` | The toggle's description appears *above* the toggle. | `string` | `undefined` |
14
+ | `disabled` | `disabled` | Whether the toggle is disabled | `boolean` | `undefined` |
15
+ | `heading` | `heading` | The toggle's heading appears *above* the toggle. | `string` | `undefined` |
16
+ | `label` | `label` | The toggle's label appears *to the right of* the toggle. | `string` | `undefined` |
17
+ | `name` | `name` | The name attribute for the html input. (submittted in form as name/value pair) | `string` | `undefined` |
18
+ | `variant` | `variant` | The size of the toggle -- `default` or `small` | `"default" \| "small"` | `'default'` |
19
+
20
+
21
+ ----------------------------------------------
22
+
23
+ *Built with [StencilJS](https://stenciljs.com/)*
@@ -0,0 +1,18 @@
1
+ # xpl-toolbar
2
+
3
+ > **Note:** This component is currently in beta. Use with caution as it may have breaking changes in future releases.
4
+
5
+
6
+ <!-- Auto Generated Below -->
7
+
8
+
9
+ ## Properties
10
+
11
+ | Property | Attribute | Description | Type | Default |
12
+ | ------------------- | --------------------- | ------------------------------------------------------- | -------- | ------- |
13
+ | `selectedItemCount` | `selected-item-count` | The number of selected items to display in the toolbar. | `number` | `0` |
14
+
15
+
16
+ ----------------------------------------------
17
+
18
+ *Built with [StencilJS](https://stenciljs.com/)*