@xplortech/apollo-core 2.4.3 → 2.6.0

package/dist/docs/xpl-data-card/readme.md

@@ -0,0 +1,54 @@
+# xpl-data-card
+
+Data Cards display snippets of information and can be linked to larger data sets. Data Cards give users "at a glance" information about their data.
+
+The `icon` and `smallStatIcon` properties accept icon names as strings. See [xpl-icon available icons](../xpl-icon/ICONS.md) for the complete list.
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property               | Attribute                 | Description                                                                                                                                                                                                                                                                                                                                      | Type                                    | Default     |
+| ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------- | ----------- |
+| `detail`               | `detail`                  | An optional field that typically describes or modifies the small stat                                                                                                                                                                                                                                                                            | `string`                                | `undefined` |
+| `icon`                 | `icon`                    | An optional icon leading the header. Uses <xpl-icon /> components and should reinforce the understanding of the smallStat metric shown.  See [xpl-icon available icons](../xpl-icon/ICONS.md) for valid icon names.                                                                                                                              | `string`                                | `undefined` |
+| `leadingIcon`          | `leading-icon`            | Whether to display the icon or not.                                                                                                                                                                                                                                                                                                              | `boolean`                               | `true`      |
+| `link`                 | `link`                    | Whether the card is a link                                                                                                                                                                                                                                                                                                                       | `boolean`                               | `undefined` |
+| `name`                 | `name`                    | Name Term                                                                                                                                                                                                                                                                                                                                        | `string`                                | `undefined` |
+| `shortStat`            | `short-stat`              | Detail, stat, or value to be displayed in short format. Will be rendered when card is smaller than 441px.                                                                                                                                                                                                                                        | `string`                                | `undefined` |
+| `smallStat`            | `small-stat`              | An Optional stat further enhancing the main metric of the card.                                                                                                                                                                                                                                                                                  | `string`                                | `undefined` |
+| `smallStatIcon`        | `small-stat-icon`         | An optional icon leading the small stat. Uses <xpl-icon> components and should reinforce the understanding of the smallStat metric shown.  See [xpl-icon available icons](../xpl-icon/ICONS.md) for valid icon names.                                                                                                                            | `string`                                | `undefined` |
+| `smallStatVariant`     | `small-stat-variant`      | set a variant that changes the color of the small stat based on the following rules:   If trend is positive and greater than 0.5% color is green and up-right arrow is used   If the trend is between -0.5% and 0.5% then its neutral the color is gray   If the trend is negative less than -0.5% the color is red and down right arrow is used | `"negative" \| "neutral" \| "positive"` | `undefined` |
+| `stat`                 | `stat`                    | Detail, stat, or value to be displayed. Will be rendered when card is larger than 441px. Will also appear in the tooltip when shortStat is shown.                                                                                                                                                                                                | `string`                                | `undefined` |
+| `tooltipTextSmallStat` | `tooltip-text-small-stat` | An optional field for tooltip text of small stat                                                                                                                                                                                                                                                                                                 | `string`                                | `''`        |
+| `tooltipTextStat`      | `tooltip-text-stat`       | An optional field for tooltip text of stat                                                                                                                                                                                                                                                                                                       | `string`                                | `''`        |
+| `variant`              | `variant`                 | Color variant. Used to set the icon color and background.                                                                                                                                                                                                                                                                                        | `"primary" \| "secondary"`              | `undefined` |
+
+
+## Slots
+
+| Slot              | Description                                                                                                                                |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| `"graph-content"` | Content that is shown on the right-side of the card. Generally used for supplemental data visualizations for the data-card                 |
+| `"title"`         | The title for the card. This slot should be used as a replacement for the name field. Used to define a title and tooltip for the data-card |
+
+
+## Dependencies
+
+### Depends on
+
+- [xpl-icon](../xpl-icon)
+- [xpl-tooltip](../xpl-tooltip)
+
+### Graph
+```mermaid
+graph TD;
+  xpl-data-card --> xpl-icon
+  xpl-data-card --> xpl-tooltip
+  style xpl-data-card fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-divider/readme.md

@@ -0,0 +1,30 @@
+# xpl-divider
+
+Allows for easy separation and titling of sections within forms or other content.
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property | Attribute | Description                                                                                                                             | Type     | Default     |
+| -------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
+| `tier`   | `tier`    | 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. | `number` | `undefined` |
+
+
+## Dependencies
+
+### Used by
+
+ - [xpl-slideout](../xpl-slideout)
+
+### Graph
+```mermaid
+graph TD;
+  xpl-slideout --> xpl-divider
+  style xpl-divider fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-dropdown/readme.md

@@ -0,0 +1,83 @@
+# xpl-dropdown
+
+A Dropdown is a menu with a list of actions a user can take. Use a dropdown when you want to present a list of actions in a limited space. Dropdowns are single-select ***actions***, can be presented in groups, and can be triggered by other elements such as a button, icon, text etc. 
+A selection within a dropdown does not change the parent trigger.
+
+***If you want to present a list of **options** a user can select, or multi-select options, please use [XPL-Select](https://xplor-apollo.herokuapp.com/?path=/story/components-select--select).***
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute           | Description                                                                         | Type                                                        | Default     |
+| ----------------- | ------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------- | ----------- |
+| `anchorToTrigger` | `anchor-to-trigger` | whether to anchor the dropdown to the trigger element, requires triggerId to be set | `boolean`                                                   | `false`     |
+| `closeOnSelect`   | `close-on-select`   | options that are listed                                                             | `boolean`                                                   | `true`      |
+| `isOpen`          | `open`              | text to display as heading                                                          | `boolean`                                                   | `false`     |
+| `mode`            | `mode`              | constant representing number of options that can be selected                        | `"multi" \| "single"`                                       | `'single'`  |
+| `options`         | --                  | options that are listed                                                             | `Partial<DropdownOption & DropdownOptionGroup>[]`           | `undefined` |
+| `selectOnFocus`   | `select-on-focus`   | whether selection should be made when focusing on interactive element               | `boolean`                                                   | `false`     |
+| `selectedValues`  | `selected-values`   | The currently selected value(s) in the dropdown.                                    | `string \| string[]`                                        | `undefined` |
+| `triggerId`       | `trigger-id`        | the id for the element that triggers the open state                                 | `string`                                                    | `undefined` |
+| `update`          | --                  | call back function invoked when a selection is made                                 | `(e: any, { component }: { component: Dropdown; }) => void` | `undefined` |
+
+
+## Events
+
+| Event          | Description                                          | Type                   |
+| -------------- | ---------------------------------------------------- | ---------------------- |
+| `isOpenChange` | Emitted when the open state of the dropdown changes. | `CustomEvent<boolean>` |
+
+
+## Methods
+
+### `handleSelect(e: any, { component }: { component: XplDropdownOption; }) => Promise<void>`
+
+called on dropdown option click and keydown events to update isSelected states
+
+#### Parameters
+
+| Name  | Type                                | Description |
+| ----- | ----------------------------------- | ----------- |
+| `e`   | `any`                               |             |
+| `__1` | `{ component: XplDropdownOption; }` |             |
+
+#### Returns
+
+Type: `Promise<void>`
+
+
+
+
+## Dependencies
+
+### Used by
+
+ - [xpl-input-phone](../xpl-input/xpl-input-phone)
+ - [xpl-input-time](../xpl-input/xpl-input-time)
+ - [xpl-select](../xpl-select)
+
+### Depends on
+
+- [xpl-dropdown-group](xpl-dropdown-group)
+- [xpl-dropdown-option](xpl-dropdown-option)
+
+### Graph
+```mermaid
+graph TD;
+  xpl-dropdown --> xpl-dropdown-group
+  xpl-dropdown --> xpl-dropdown-option
+  xpl-dropdown-group --> xpl-dropdown-group
+  xpl-dropdown-group --> xpl-dropdown-option
+  xpl-dropdown-group --> xpl-dropdown-heading
+  xpl-dropdown-option --> xpl-icon
+  xpl-input-phone --> xpl-dropdown
+  xpl-input-time --> xpl-dropdown
+  xpl-select --> xpl-dropdown
+  style xpl-dropdown fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-dropdown/xpl-dropdown-group/readme.md

@@ -0,0 +1,40 @@
+# xpl-dropdown-group
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property    | Attribute | Description                | Type                                              | Default     |
+| ----------- | --------- | -------------------------- | ------------------------------------------------- | ----------- |
+| `groupName` | `label`   | text to display as heading | `string`                                          | `undefined` |
+| `options`   | --        | options that are listed    | `Partial<DropdownOption & DropdownOptionGroup>[]` | `undefined` |
+
+
+## Dependencies
+
+### Used by
+
+ - [xpl-dropdown](..)
+ - [xpl-dropdown-group](.)
+
+### Depends on
+
+- [xpl-dropdown-group](.)
+- [xpl-dropdown-option](../xpl-dropdown-option)
+- [xpl-dropdown-heading](../xpl-dropdown-heading)
+
+### Graph
+```mermaid
+graph TD;
+  xpl-dropdown-group --> xpl-dropdown-group
+  xpl-dropdown-option --> xpl-icon
+  xpl-dropdown --> xpl-dropdown-group
+  style xpl-dropdown-group fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-dropdown/xpl-dropdown-heading/readme.md

@@ -0,0 +1,30 @@
+# xpl-dropdown-heading
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property | Attribute | Description                | Type     | Default     |
+| -------- | --------- | -------------------------- | -------- | ----------- |
+| `label`  | `label`   | text to display as heading | `string` | `undefined` |
+
+
+## Dependencies
+
+### Used by
+
+ - [xpl-dropdown-group](../xpl-dropdown-group)
+
+### Graph
+```mermaid
+graph TD;
+  xpl-dropdown-group --> xpl-dropdown-heading
+  style xpl-dropdown-heading fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-dropdown/xpl-dropdown-option/readme.md

@@ -0,0 +1,42 @@
+# xpl-dropdown-option
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property     | Attribute  | Description                                                                               | Type      | Default     |
+| ------------ | ---------- | ----------------------------------------------------------------------------------------- | --------- | ----------- |
+| `icon`       | `icon`     | optional icon name to display before the label (uses xpl-icon)                            | `string`  | `undefined` |
+| `isDisabled` | `disabled` | whether option is disabled                                                                | `boolean` | `undefined` |
+| `isSelected` | `selected` | whether option is selected                                                                | `boolean` | `undefined` |
+| `label`      | `label`    | text to display for option                                                                | `string`  | `undefined` |
+| `subtitle`   | `subtitle` | optional subtitle text to display below label                                             | `string`  | `undefined` |
+| `value`      | `value`    | The selected options value to be submitted with the form, should this option be selected. | `string`  | `undefined` |
+
+
+## Dependencies
+
+### Used by
+
+ - [xpl-dropdown](..)
+ - [xpl-dropdown-group](../xpl-dropdown-group)
+
+### Depends on
+
+- [xpl-icon](../../xpl-icon)
+
+### Graph
+```mermaid
+graph TD;
+  xpl-dropdown-option --> xpl-icon
+  xpl-dropdown --> xpl-dropdown-option
+  xpl-dropdown-group --> xpl-dropdown-option
+  style xpl-dropdown-option fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-dynamic-table/readme.md

@@ -0,0 +1,19 @@
+# xpl-dynamic-table
+
+> **Note:** This component is currently in beta. Use with caution as it may have breaking changes in future releases.
+
+The Dynamic Table is a rich content table that can accommodate multiple types of data. 
+
+<!-- Auto Generated Below -->
+
+
+## Events
+
+| Event                     | Description                                        | Type                    |
+| ------------------------- | -------------------------------------------------- | ----------------------- |
+| `selectedItemCountChange` | Emitted when the number of selected items changes. | `CustomEvent<string[]>` |
+
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-dynamic-table-cell/readme.md

@@ -0,0 +1,18 @@
+# xpl-dynamic-table-cell
+
+> **Note:** This component is currently in beta. Use with caution as it may have breaking changes in future releases.
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property   | Attribute  | Description                                     | Type      | Default |
+| ---------- | ---------- | ----------------------------------------------- | --------- | ------- |
+| `disabled` | `disabled` | Whether the cell and its contents are disabled. | `boolean` | `false` |
+
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-dynamic-table-row/readme.md

@@ -0,0 +1,19 @@
+# xpl-dynamic-table-row
+
+> **Note:** This component is currently in beta. Use with caution as it may have breaking changes in future releases.
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property   | Attribute  | Description                                 | Type      | Default |
+| ---------- | ---------- | ------------------------------------------- | --------- | ------- |
+| `disabled` | `disabled` | Whether the row and its cells are disabled. | `boolean` | `false` |
+| `selected` | `selected` | Whether the row is selected.                | `boolean` | `false` |
+
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-grid/readme.md

@@ -0,0 +1,10 @@
+# xpl-grid
+
+XPL-Grid is a code only utility component to help with responsive layouts. 
+
+<!-- Auto Generated Below -->
+
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-grid-item/readme.md

@@ -0,0 +1,20 @@
+# xpl-grid-item
+
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property | Attribute | Description                                                                                | Type     | Default |
+| -------- | --------- | ------------------------------------------------------------------------------------------ | -------- | ------- |
+| `lg`     | `lg`      | The number of columns the element should span  out of a 6 column grid on a  lg size screen | `number` | `6`     |
+| `md`     | `md`      | The number of columns the element should span  out of a 6 column grid on a  md size screen | `number` | `6`     |
+| `sm`     | `sm`      | The number of columns the element should span  out of a 6 column grid on a  sm size screen | `number` | `6`     |
+| `xs`     | `xs`      | The number of columns the element should span  out of a 6 column grid on a  xs size screen | `number` | `6`     |
+
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-header-accordion/readme.md

@@ -0,0 +1,39 @@
+# xpl-header-accordion
+
+The toolbar component allows users to manipulate selections within the Dynamic Table.  It is only visible when a row or cell is in the selected state and bulk actions can be taken on that row or cell. 
+
+> **Note:** This component is currently in beta. Use with caution as it may have breaking changes in future releases.
+
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property          | Attribute          | Description                                                   | Type      | Default     |
+| ----------------- | ------------------ | ------------------------------------------------------------- | --------- | ----------- |
+| `contentId`       | `content-id`       | The id of the content region controlled by the accordion.     | `string`  | `undefined` |
+| `disabled`        | `disabled`         | Whether the accordion is disabled.                            | `boolean` | `false`     |
+| `hasCheckbox`     | `has-checkbox`     | Whether to display a parent checkbox in the accordion header. | `boolean` | `true`      |
+| `initialExpanded` | `initial-expanded` | Whether the accordion is expanded initially.                  | `boolean` | `false`     |
+| `selectedCount`   | `selected-count`   | The number of selected child items, or -1 to auto-calculate.  | `number`  | `-1`        |
+
+
+## Dependencies
+
+### Depends on
+
+- [xpl-checkbox](../xpl-checkbox)
+- [xpl-icon](../xpl-icon)
+
+### Graph
+```mermaid
+graph TD;
+  xpl-header-accordion --> xpl-checkbox
+  xpl-header-accordion --> xpl-icon
+  style xpl-header-accordion fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-icon/readme.md

@@ -0,0 +1,92 @@
+# xpl-icon
+
+## Available Icons
+
+For a complete list of available icon names, see [ICONS.md](./ICONS.md) (164 icons).
+
+You can also browse icons visually in [Storybook](?path=/story/components-icons--icons) with search functionality.
+
+## Usage
+
+```html
+<xpl-icon icon="rocket" size="24"></xpl-icon>
+```
+
+The `icon` property accepts any icon name as a string. See the links above for the full list of available icons.
+
+---
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property            | Attribute          | Description              | Type     | Default     |
+| ------------------- | ------------------ | ------------------------ | -------- | ----------- |
+| `backgroundColor`   | `background-color` | Icon's background color. | `string` | `undefined` |
+| `icon` _(required)_ | `icon`             | Name of icon.            | `string` | `undefined` |
+| `size`              | `size`             | Size of icon             | `number` | `undefined` |
+
+
+## Dependencies
+
+### Used by
+
+ - [xpl-accordion](../xpl-accordion)
+ - [xpl-banner](../xpl-banner)
+ - [xpl-button](../xpl-button)
+ - [xpl-data-card](../xpl-data-card)
+ - [xpl-dropdown-option](../xpl-dropdown/xpl-dropdown-option)
+ - [xpl-header-accordion](../xpl-header-accordion)
+ - [xpl-input](../xpl-input)
+ - [xpl-input-color](../xpl-input/xpl-input-color)
+ - [xpl-input-date](../xpl-input/xpl-input-date)
+ - [xpl-input-file](../xpl-input/xpl-input-file)
+ - [xpl-input-phone](../xpl-input/xpl-input-phone)
+ - [xpl-input-time](../xpl-input/xpl-input-time)
+ - [xpl-large-card](../xpl-large-card)
+ - [xpl-list](../xpl-list)
+ - [xpl-modal](../xpl-modal)
+ - [xpl-pagination](../xpl-pagination)
+ - [xpl-progress-bar](../xpl-progress-bar)
+ - [xpl-select](../xpl-select)
+ - [xpl-side-nav-item](../xpl-side-nav/xpl-side-nav-item)
+ - [xpl-slideout](../xpl-slideout)
+ - [xpl-table](../xpl-table)
+ - [xpl-table-header-cell](../xpl-table-header-cell)
+ - [xpl-toast](../xpl-toast)
+ - [xpl-utility-bar](../xpl-utility-bar)
+
+### Graph
+```mermaid
+graph TD;
+  xpl-accordion --> xpl-icon
+  xpl-banner --> xpl-icon
+  xpl-button --> xpl-icon
+  xpl-data-card --> xpl-icon
+  xpl-dropdown-option --> xpl-icon
+  xpl-header-accordion --> xpl-icon
+  xpl-input --> xpl-icon
+  xpl-input-color --> xpl-icon
+  xpl-input-date --> xpl-icon
+  xpl-input-file --> xpl-icon
+  xpl-input-phone --> xpl-icon
+  xpl-input-time --> xpl-icon
+  xpl-large-card --> xpl-icon
+  xpl-list --> xpl-icon
+  xpl-modal --> xpl-icon
+  xpl-pagination --> xpl-icon
+  xpl-progress-bar --> xpl-icon
+  xpl-select --> xpl-icon
+  xpl-side-nav-item --> xpl-icon
+  xpl-slideout --> xpl-icon
+  xpl-table --> xpl-icon
+  xpl-table-header-cell --> xpl-icon
+  xpl-toast --> xpl-icon
+  xpl-utility-bar --> xpl-icon
+  style xpl-icon fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/docs/xpl-input/readme.md

@@ -0,0 +1,100 @@
+# xpl-input
+
+A flexible form input that supports multiple `type` values: `text`, `number`, `password`, `date`, `time`, `file`, `color`, and `phone`. Each type delegates to a dedicated sub-component (`xpl-input-date`, `xpl-input-time`, `xpl-input-phone`, etc.) while sharing a common label, description, and error-message wrapper.
+
+For `type="phone"`, the value is always emitted in **E.164** format (e.g. `+14155551234`). See [`xpl-input-phone`](xpl-input-phone) for full phone-input documentation.
+
+<!-- Auto Generated Below -->
+
+
+## Properties
+
+| Property              | Attribute                | Description                                                                                                                                                                                                                                          | Type                                                                                   | Default     |
+| --------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ----------- |
+| `_id`                 | `_id`                    | 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.  Applies to all input types.                                                             | `string`                                                                               | `undefined` |
+| `accept`              | `accept`                 | The accepted file types for the file input. Corresponds to the `accept` attribute on the input element. Example: 'image/*' for all image types, '.pdf' for PDF files, etc.  Applies to file inputs.                                                  | `string`                                                                               | `''`        |
+| `allowCustomOption`   | `allow-custom-option`    | For time inputs, whether to allow custom option in the input even if not available in the dropdown. Example: A step of 30 minutes will allow 15:03, 15:37, etc.  Applies to time inputs.                                                             | `boolean`                                                                              | `false`     |
+| `autocomplete`        | `autocomplete`           | Hint for form autofill feature  Applies to text, password, number.                                                                                                                                                                                   | `string`                                                                               | `undefined` |
+| `dateFormat`          | `date-format`            | The date format to use for the datepicker input. This is used by flatpickr to format the date. Default is 'Y-m-d' (e.g., 2023-10-01).  See https://flatpickr.js.org/formatting/ for more details.  Applies to date inputs.                           | `string`                                                                               | `'Y-m-d'`   |
+| `defaultCountry`      | `default-country`        | Default country code (ISO 3166-1 alpha-2) when value is empty, e.g. "US".  Applies to phone inputs.                                                                                                                                                  | `string`                                                                               | `'US'`      |
+| `description`         | `description`            | Optional text that appears below the input label.  Applies to all input types.                                                                                                                                                                       | `string`                                                                               | `undefined` |
+| `disabled`            | `disabled`               | Whether the field is disabled  Applies to all input types.                                                                                                                                                                                           | `boolean`                                                                              | `undefined` |
+| `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.  Applies to all input types.                          | `string`                                                                               | `undefined` |
+| `hideAcceptText`      | `hide-accept-text`       | Hides the "Accept" text that indicates the accepted file types This is useful for cases where you want to hide the "Accept" text.  Applies to file inputs.                                                                                           | `boolean`                                                                              | `false`     |
+| `hideEyeDropper`      | `hide-eye-dropper`       | Hide eye dropper  Applies to color inputs.                                                                                                                                                                                                           | `boolean`                                                                              | `undefined` |
+| `hideFileNames`       | `hide-file-names`        | Hides the file names in the file upload component This is useful for cases where you want to hide the file names after selection.  Applies to file inputs.                                                                                           | `boolean`                                                                              | `false`     |
+| `hideTriggerOnSelect` | `hide-trigger-on-select` | Hides the trigger element when a file is selected. This is useful for cases where you want to hide the trigger after a file is selected.  Applies to file inputs.                                                                                    | `boolean`                                                                              | `false`     |
+| `isInternational`     | `is-international`       | Enables international mode with country selector for phone inputs. When false, the phone input is locked to defaultCountry with no country picker.                                                                                                   | `boolean`                                                                              | `true`      |
+| `label`               | `label`                  | Label text for the field  Applies to all input types.                                                                                                                                                                                                | `string`                                                                               | `undefined` |
+| `max`                 | `max`                    | Maximum value for the input.  Applies to number, time, and date inputs.  If the input is a time input, the value must be in 24 hour format, ex: 18:25 for 6:25 PM                                                                                    | `number \| string`                                                                     | `undefined` |
+| `maxCharacterCount`   | `max-character-count`    | 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.  This is only applicable if `multiline` is `true`.               | `number`                                                                               | `undefined` |
+| `min`                 | `min`                    | The minimum value for the input.  Applies to number, time, and date inputs.  If the input is a time input, the value must be in 24 hour format, ex: 05:25 for 5:25 AM                                                                                | `number \| string`                                                                     | `undefined` |
+| `mode`                | `mode`                   | 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.)  Applies to date inputs.                                                                     | `"range" \| "single"`                                                                  | `'single'`  |
+| `multiline`           | `multiline`              | Whether to render as a singleline text input or as a multiline textarea. (If `true`, `pre` and `post` values will be ignored, if present.)  Applies to text inputs.                                                                                  | `boolean`                                                                              | `false`     |
+| `multiple`            | `multiple`               | Whether the user can select multiple files at once. Corresponds to the `multiple` attribute on the input element.  Applies to file inputs.                                                                                                           | `boolean`                                                                              | `false`     |
+| `name`                | `name`                   | Most inputs are used in forms, and should have a `name` associated with the input for handling form data.  Applies to all input types.                                                                                                               | `string`                                                                               | `undefined` |
+| `placeholder`         | `placeholder`            | Placeholder text that appears when the field has no value  Applies to text, password, number, and date inputs.                                                                                                                                       | `string`                                                                               | `undefined` |
+| `post`                | `post`                   | A string (recommended max 3 characters) that gets shown visually to the left of (before) the input.  Applies to text, password, number, and date inputs. Note: This will be ignored if `multiline` is `true`.                                        | `string`                                                                               | `undefined` |
+| `pre`                 | `pre`                    | A string (recommended max 8 characters) that gets shown visually to the right of (after) the input.  Applies to text, password, number, and date inputs. Note: This will be ignored if `multiline` is `true`.                                        | `string`                                                                               | `undefined` |
+| `preferredCountries`  | --                       | Country codes to show at the top of the country list, e.g. ["US", "CA", "GB"].  Applies to phone inputs.                                                                                                                                             | `string[]`                                                                             | `undefined` |
+| `readonly`            | `readonly`               | Whether the input is editable  Applies to text, password, number, and date inputs.                                                                                                                                                                   | `boolean`                                                                              | `undefined` |
+| `required`            | `required`               | Whether the input is required  Applies to all input types.                                                                                                                                                                                           | `boolean`                                                                              | `undefined` |
+| `step`                | `step`                   | The granularity that the value in a `number` input must adhere to when incrementing or decrementing. The default stepping value for number inputs is 1  Applies to number and time inputs.                                                           | `number`                                                                               | `undefined` |
+| `timeFormat`          | `time-format`            | The time format to display for the input.  Applies to time inputs.  If 12h is selected, the value will be displayed in 12 hour format, ex: 05:25 PM for 17:25 If 24h is selected, the value will be displayed in 24 hour format, ex: 17:25 for 17:25 | `"12h" \| "24h"`                                                                       | `'24h'`     |
+| `type`                | `type`                   | The type of form control                                                                                                                                                                                                                             | `"color" \| "date" \| "file" \| "number" \| "password" \| "phone" \| "text" \| "time"` | `'text'`    |
+| `value`               | `value`                  | Including a `value` will pre-populate the input with the given string.  Applies to text, password, number, and date inputs.                                                                                                                          | `string`                                                                               | `undefined` |
+
+
+## Events
+
+| Event         | Description                                                                        | Type                      |
+| ------------- | ---------------------------------------------------------------------------------- | ------------------------- |
+| `blurEvent`   | The event handler for the blur event                                               | `CustomEvent<FocusEvent>` |
+| `focusEvent`  | The event handler for the focus event                                              | `CustomEvent<FocusEvent>` |
+| `inputEvent`  | Event that emits the current value of the input  Applies to text like inputs only. | `CustomEvent<string>`     |
+| `valueChange` | Event that emits the current value of the input                                    | `CustomEvent<string>`     |
+
+
+## Dependencies
+
+### Used by
+
+ - [xpl-input-color](xpl-input-color)
+ - [xpl-input-phone](xpl-input-phone)
+ - [xpl-input-time](xpl-input-time)
+
+### Depends on
+
+- [xpl-input-file](xpl-input-file)
+- [xpl-input-color](xpl-input-color)
+- [xpl-input-date](xpl-input-date)
+- [xpl-input-time](xpl-input-time)
+- [xpl-input-phone](xpl-input-phone)
+- [xpl-icon](../xpl-icon)
+
+### Graph
+```mermaid
+graph TD;
+  xpl-input --> xpl-input-file
+  xpl-input --> xpl-input-color
+  xpl-input --> xpl-input-date
+  xpl-input --> xpl-input-time
+  xpl-input --> xpl-input-phone
+  xpl-input --> xpl-icon
+  xpl-input-file --> xpl-icon
+  xpl-input-color --> xpl-input
+  xpl-input-date --> xpl-icon
+  xpl-input-time --> xpl-input
+  xpl-dropdown --> xpl-dropdown-group
+  xpl-dropdown --> xpl-dropdown-option
+  xpl-dropdown-group --> xpl-dropdown-group
+  xpl-dropdown-group --> xpl-dropdown-option
+  xpl-dropdown-group --> xpl-dropdown-heading
+  xpl-dropdown-option --> xpl-icon
+  xpl-input-phone --> xpl-input
+  style xpl-input fill:#f9f,stroke:#333,stroke-width:4px
+```
+
+----------------------------------------------
+
+*Built with [StencilJS](https://stenciljs.com/)*