diff --git a/.tooling/eleventy/assets/css/style.css b/.tooling/eleventy/assets/css/style.css index c75599a7f..2c193df9e 100644 --- a/.tooling/eleventy/assets/css/style.css +++ b/.tooling/eleventy/assets/css/style.css @@ -425,6 +425,7 @@ header .header-version-select { --omni-select-control-padding: 0px 4px 0px 0px; --omni-form-clear-control-width: 0px; --omni-select-items-container-width: auto; + --omni-select-field-height: 100%; } .docs-select { @@ -598,6 +599,7 @@ h2 { .static-article code:not([class]), .story-description code:not([class]), +.component-tab#docs code:not([class]), .keyboard-showcase code:not([class]) { font-family: ui-monospace, monospace; font-size: 14px; @@ -605,6 +607,7 @@ h2 { .static-article code:not([class]), .story-description code:not([class]), +.component-tab#docs code:not([class]), .keyboard-showcase code:not([class]) { padding: 2px 6px; margin: 0; diff --git a/.tooling/eleventy/components.njk b/.tooling/eleventy/components.njk index 3bcc08a33..2857ec4fe 100644 --- a/.tooling/eleventy/components.njk +++ b/.tooling/eleventy/components.njk @@ -127,6 +127,66 @@ eleventyComputed: {% endif %} + {% set instanceFuncs = customElements | getInstanceFunctions(component.name) %} + {% if instanceFuncs.length > 0 %} +
Name | +Parameters | +Returns | +Description | +
---|---|---|---|
{{f.name}} | +
|
+
|
+ {{ f.description | safe }} | +
Name | +Parameters | +Returns | +Description | +
---|---|---|---|
{{f.name}} | +
|
+
|
+ {{ f.description | safe }} | +
Tag Name | Description |
---|---|
-[omni-button](src/button/README.md) +[omni-loading-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Control that allows an action to be executed. +Loading icon component. |
-[omni-calendar](src/calendar/README.md) +[omni-render-element](/Users/runner/work/omni-components/omni-components/src/render-element/README.md) | -Calendar component to set specific date. +Element that defers content rendering to a provided function / promise. |
-[omni-check](src/check/README.md) +[omni-modal](/Users/runner/work/omni-components/omni-components/src/modal/README.md) | -Control that allows a selection to be made. +Control to display modal content with optional header and footer content. |
-[omni-chip](src/chip/README.md) +[omni-button](/Users/runner/work/omni-components/omni-components/src/button/README.md) | -Control that can be used for input, setting attributes, or performing actions. +Control that allows an action to be executed. |
-[omni-color-field](src/color-field/README.md) +[omni-alert](/Users/runner/work/omni-components/omni-components/src/alert/README.md) | -Color input control. +Component that displays an alert. |
-[omni-currency-field](src/currency-field/README.md) +[omni-clear-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Control to enter a formatted currency value. +Clear icon component. |
-[omni-date-picker](src/date-picker/README.md) +[omni-search-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Control to get / set a specific date using a calendar. +Search icon component. |
-[omni-email-field](src/email-field/README.md) +[omni-search-field](/Users/runner/work/omni-components/omni-components/src/search-field/README.md) | -Email input control, used in forms for input validation and to display correct virtual keyboard on mobile. +Search input control. |
-[omni-hyperlink](src/hyperlink/README.md) +[omni-chevron-down-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Control to indicate an action to be executed. Typically used for navigational purposes. +Chevron down icon component. |
-[omni-icon](src/icon/README.md) +[omni-more-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Component that displays an icon. +More icon component. |
-[omni-arrow-right-icon](src/icons/README.md) +[omni-select](/Users/runner/work/omni-components/omni-components/src/select/README.md) | -Arrow right icon component. +Control to get / set a value within a list of options. |
-[omni-backspace-icon](src/icons/README.md) +[omni-icon](/Users/runner/work/omni-components/omni-components/src/icon/README.md) | -Backspace icon component. +Component that displays an icon. |
-[omni-calendar-icon](src/icons/README.md) +[omni-color-field](/Users/runner/work/omni-components/omni-components/src/color-field/README.md) | -A calendar icon component. +Color input control. |
-[omni-caps-lock-icon](src/icons/README.md) +[omni-text-field](/Users/runner/work/omni-components/omni-components/src/text-field/README.md) | -Caps lock icon component. +Control to input text. |
-[omni-caps-off-icon](src/icons/README.md) +[omni-label](/Users/runner/work/omni-components/omni-components/src/label/README.md) | -Caps off icon component. +Label component that renders styled text. |
-[omni-caps-on-icon](src/icons/README.md) +[omni-switch](/Users/runner/work/omni-components/omni-components/src/switch/README.md) | -Caps on icon component. +Control to switch a value on or off. |
-[omni-check-icon](src/icons/README.md) +[omni-chevron-left-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Check icon component. +Chevron left icon component. |
-[omni-chevron-down-icon](src/icons/README.md) +[omni-chevron-right-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Chevron down icon component. +Chevron right icon component. |
-[omni-chevron-left-icon](src/icons/README.md) +[omni-calendar](/Users/runner/work/omni-components/omni-components/src/calendar/README.md) | -Chevron left icon component. +Calendar component to set specific date. |
-[omni-chevron-right-icon](src/icons/README.md) +[omni-indeterminate-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Chevron right icon component. +Indeterminate icon component. |
-[omni-clear-icon](src/icons/README.md) +[omni-check-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Clear icon component. +Check icon component. + + |
+ +[omni-check](/Users/runner/work/omni-components/omni-components/src/check/README.md) + + | + +Control that allows a selection to be made. |
-[omni-close-icon](src/icons/README.md) +[omni-close-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | @@ -359,231 +367,231 @@ Close icon component. |
-[omni-eye-hidden-icon](src/icons/README.md) +[omni-chip](/Users/runner/work/omni-components/omni-components/src/chip/README.md) | -Hidden eye icon component +Control that can be used for input, setting attributes, or performing actions. |
-[omni-eye-visible-icon](src/icons/README.md) +[omni-arrow-right-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Visible eye icon component. +Arrow right icon component. |
-[omni-indeterminate-icon](src/icons/README.md) +[omni-backspace-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Indeterminate icon component. +Backspace icon component. |
-[omni-loading-icon](src/icons/README.md) +[omni-caps-off-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Loading icon component. +Caps off icon component. |
-[omni-lock-closed-icon](src/icons/README.md) +[omni-caps-on-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Closed lock icon component. +Caps on icon component. |
-[omni-lock-open-icon](src/icons/README.md) +[omni-caps-lock-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Open lock icon component. +Caps lock icon component. |
-[omni-minus-icon](src/icons/README.md) +[omni-next-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Minus icon component. +Next icon component. |
-[omni-more-icon](src/icons/README.md) +[omni-previous-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -More icon component. +Previous icon component. |
-[omni-next-icon](src/icons/README.md) +[omni-send-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Next icon component. +Send icon component. |
-[omni-plus-icon](src/icons/README.md) +[omni-keyboard-button](/Users/runner/work/omni-components/omni-components/src/keyboard/README.md) | -Plus icon component. +An internal keyboard button control used in the keyboard component. |
-[omni-previous-icon](src/icons/README.md) +[omni-keyboard](/Users/runner/work/omni-components/omni-components/src/keyboard/README.md) | -Previous icon component. +A responsive on-screen keyboard control component. |
-[omni-search-icon](src/icons/README.md) +[omni-currency-field](/Users/runner/work/omni-components/omni-components/src/currency-field/README.md) | -Search icon component. +Control to enter a formatted currency value. |
-[omni-send-icon](src/icons/README.md) +[omni-calendar-icon](/Users/runner/work/omni-components/omni-components/src/icons/README.md) | -Send icon component. +A calendar icon component. |
-[omni-keyboard](src/keyboard/README.md) +[omni-date-picker](/Users/runner/work/omni-components/omni-components/src/date-picker/README.md) | -A responsive on-screen keyboard control component. +Control to get / set a specific date using a calendar. |
-[omni-keyboard-button](src/keyboard/README.md) +[omni-email-field](/Users/runner/work/omni-components/omni-components/src/email-field/README.md) | -An internal keyboard button control used in the keyboard component. +Email input control, used in forms for input validation and to display correct virtual keyboard on mobile. |
-[omni-label](src/label/README.md) +[omni-hyperlink](/Users/runner/work/omni-components/omni-components/src/hyperlink/README.md) | -Label component that renders styled text. +Control to indicate an action to be executed. Typically used for navigational purposes. |
-[omni-modal](src/modal/README.md) +[omni-eye-hidden-icon](src/icons/README.md) | -Control to display modal content with optional header and footer content. +Hidden eye icon component |
-[omni-number-field](src/number-field/README.md) +[omni-eye-visible-icon](src/icons/README.md) | -Input control to enter a single line of numbers. +Visible eye icon component. |
-[omni-password-field](src/password-field/README.md) +[omni-lock-closed-icon](src/icons/README.md) | -Password input control. +Closed lock icon component. |
-[omni-pin-field](src/pin-field/README.md) +[omni-lock-open-icon](src/icons/README.md) | -Input control to enter a masked numeric value. +Open lock icon component. |
-[omni-radio](src/radio/README.md) +[omni-minus-icon](src/icons/README.md) | -Control to select a single value from a group of values. +Minus icon component. |
-[omni-radio-group](src/radio/README.md) +[omni-plus-icon](src/icons/README.md) | -Control to group radio components for single selection +Plus icon component. |
-[omni-render-element](src/render-element/README.md) +[omni-number-field](/Users/runner/work/omni-components/omni-components/src/number-field/README.md) | -Element that defers content rendering to a provided function / promise. +Input control to enter a single line of numbers. |
-[omni-search-field](src/search-field/README.md) +[omni-password-field](/Users/runner/work/omni-components/omni-components/src/password-field/README.md) | -Search input control. +Password input control. |
-[omni-select](src/select/README.md) +[omni-pin-field](/Users/runner/work/omni-components/omni-components/src/pin-field/README.md) | -Control to get / set a value within a list of options. +Input control to enter a masked numeric value. |
-[omni-switch](src/switch/README.md) +[omni-radio](/Users/runner/work/omni-components/omni-components/src/radio/README.md) | -Control to switch a value on or off. +Control to select a single value from a group of values. |
-[omni-tab](src/tab/README.md) +[omni-radio-group](/Users/runner/work/omni-components/omni-components/src/radio/README.md) | -Control that can be used to display slotted content, for use within an Tab Group component. +Control to group radio components for single selection |
-[omni-tab-group](src/tab/README.md) +[omni-tab](/Users/runner/work/omni-components/omni-components/src/tab/README.md) | -Component that displays content in tabs. +Control that can be used to display slotted content, for use within an Tab Group component. |
-[omni-tab-header](src/tab/README.md) +[omni-tab-header](/Users/runner/work/omni-components/omni-components/src/tab/README.md) | @@ -591,27 +599,27 @@ Control that can be used to display custom slotted content, for use within Tab G |
-[omni-text-field](src/text-field/README.md) +[omni-tab-group](/Users/runner/work/omni-components/omni-components/src/tab/README.md) | -Control to input text. +Component that displays content in tabs. |
-[omni-toast](src/toast/README.md) +[omni-toast-stack](/Users/runner/work/omni-components/omni-components/src/toast/README.md) | -Component to visually notify a user of a message. +A toast container that animates in and stacks toast elements. |
-[omni-toast-stack](src/toast/README.md) +[omni-toast](/Users/runner/work/omni-components/omni-components/src/toast/README.md) | -A toast container that animates in and stacks toast elements. +Component to visually notify a user of a message. |
Alert.show()
function.
+ Alert.showAsync()
function.
+ Set the display status of the <omni-alert>
.
+
+ The status
attribute supports the following options:
+
+
+
+ 'success'
- Checkmark icon to indicate success.'warning'
- Yield icon to indicate warning.'error'
- Exclamation icon to indicate error.'info'
- Information icon to indicate info.'none'
- No icon. (Default)
'center'
).`,
+ render: (args: Args) => html`
+ 'center'
).`,
+ render: (args: Args) => html`
+ 'Ok'
).`,
+ render: (args: Args) => html`
+ secondary-action
attribute (Defaults to 'Cancel'
).enable-secondary
attribute.'right'
).`,
+ render: (args: Args) => html`
+ message
attribute.`,
+ render: (args: Args) => html`
+ header
slot
+ header
slot`,
+ '[Default Slot]': '',
+ primary: '',
+ secondary: '',
+
+ hide: true,
+
+ message: 'Message Alert',
+ description: 'Additional context for the alert.',
+
+ enableSecondary: undefined,
+
+ status: undefined,
+ headerAlign: undefined,
+ descriptionAlign: undefined,
+ primaryAction: undefined,
+ secondaryAction: undefined,
+ actionAlign: undefined
+ }
+};
+
+export const Custom_Body: ComponentStoryFormatdescription
attribute.`,
+ render: (args: Args) => html`
+ description
attribute.
+ description
attribute.`,
+ primary: '',
+ secondary: '',
+
+ hide: true,
+
+ message: 'Message Alert',
+ description: 'Additional context for the alert.',
+
+ enableSecondary: undefined,
+
+ status: undefined,
+ headerAlign: undefined,
+ descriptionAlign: undefined,
+ primaryAction: undefined,
+ secondaryAction: undefined,
+ actionAlign: undefined
+ }
+};
+
+export const Custom_Primary_Action: ComponentStoryFormatprimary-action
attribute.`,
+ render: (args: Args) => html`
+ secondary-action
attribute.`,
+ render: (args: Args) => html`
+ $2
`);
+
return jsdoc;
}