{
"version": 1.1,
"tags": [
{
"name": "uic-accordion",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "mode",
"description": "Controls the number of items allowed to be open,\neither a single one or multiple.",
"values": [
{
"name": "multiple"
},
{
"name": "single"
}
]
}
]
},
{
"name": "uic-accordion-item",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the accordion."
},
{
"name": "heading-level",
"description": "The heading level of the header element."
},
{
"name": "open",
"description": "If set to `true`, the accordions details are visible."
},
{
"name": "summary",
"description": "The summary to show in the accordion header."
}
]
},
{
"name": "uic-app-header",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "home-icon",
"description": "The icon displayed in the home button"
},
{
"name": "locale",
"description": "The locale used in translations"
},
{
"name": "notifications-badge",
"description": "Number that indicates new messages in the notifications badge"
},
{
"name": "notifications-supported",
"description": "Flag that indicates that the notifications icon should be displayed"
},
{
"name": "settings-supported",
"description": "Flag that indicates that the settings icon should be displayed"
},
{
"name": "user-profile-url",
"description": "Link to the TRUMPF user profile"
}
]
},
{
"name": "uic-app-user-info",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "no-data-text",
"description": "Text that is shown if no userData is provided"
},
{
"name": "user-profile-text",
"description": "Text for the user profile link"
},
{
"name": "user-profile-url",
"description": "Link to the user profile page"
}
]
},
{
"name": "uic-badge",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "max-value",
"description": "The highest possible number. If the value is higher, this limit together with a '+' is shown."
},
{
"name": "min-value",
"description": "The smallest possible value. If the value is smaller, the badge is hidden."
},
{
"name": "value",
"description": "The number or text that gets shown above an element, for example number of notifications for an app"
}
]
},
{
"name": "uic-bar-chart",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "bar-chart-root-class",
"description": "Can be used to define a custom bar chart root class for styling purposes."
},
{
"name": "chart-id",
"description": "id attribute for this chart. A unique id will be generated if this is empty"
},
{
"name": "disable-tooltip",
"description": "Whether tooltip should be show on hover/touchmove"
},
{
"name": "no-data-text",
"description": "Text for displaying when no data is available."
},
{
"name": "state",
"description": "State in which the bar chart is currently in."
},
{
"name": "transition-duration-ms",
"description": "Set the transition duration. As long as the transitions do not cause any issues, keep the default"
},
{
"name": "y-axis-label",
"description": "Label for the Y axis."
},
{
"name": "y-ticks",
"description": "Number of ticks (entries) on the Y axis.\nIn some cases d3 overwrites this value and chooses automatically\nthe best, depending on the current width and height of the chart."
}
]
},
{
"name": "uic-breadcrumb",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": []
},
{
"name": "uic-breadcrumb-item",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "ellipsis",
"description": "If set to `true`, hides the label and shows three dots (\"...\") instead."
},
{
"name": "icon",
"description": "The name of the icon to show next to the label."
},
{
"name": "label",
"description": "The label. Use the slot for custom content."
},
{
"name": "selected",
"description": "If set to `true`, the breadcrum item is visually highlighted."
}
]
},
{
"name": "uic-button",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the button."
},
{
"name": "download",
"description": "If the `href` value is set, this value will be used for download attribute of the tag."
},
{
"name": "href",
"description": "If a value is set, an tag with the specified href will be rendered instead of a button."
},
{
"name": "icon",
"description": "The name of the icon to show next to the label."
},
{
"name": "label",
"description": "The text shown inside the button.\nPlease prefer the use of the default slot (content within the button element).\nBecasue of a bug (https://github.com/ionic-team/stencil/issues/2054),\nthis text may not be visible when nesting button within other elements even if there is not default slot for the button."
},
{
"name": "loading",
"description": "If set to `true`, the button is currently loading."
},
{
"name": "selected",
"description": "If set to `true`, the button is considered selected or toggled."
},
{
"name": "size",
"description": "The size of the button.\nUse `icon` for a button with just an icon.",
"values": [
{
"name": "default"
},
{
"name": "icon"
},
{
"name": "icon-stretched"
}
]
},
{
"name": "target",
"description": "If the `href` value is set, this value will be used for target attribute of the tag."
},
{
"name": "variant",
"description": "The color variant to use. You can choose between color schemes that are suited for content or footer areas.\nUse the `primary` variants to show visually more pronounced versions of these schemes.",
"values": [
{
"name": "content"
},
{
"name": "content-primary"
},
{
"name": "footer"
},
{
"name": "footer-primary"
}
]
}
]
},
{
"name": "uic-check-list",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": []
},
{
"name": "uic-check-list-item",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "uic-controller",
"description": "If set to `true`, the item acts as controller for other items."
},
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with this element."
},
{
"name": "group",
"description": "The name of the group."
},
{
"name": "icon",
"description": "The optional icon."
},
{
"name": "multiline",
"description": "If set to `true`, enables an additional slot for secondary content."
},
{
"name": "selected",
"description": "If set to `true`, the list item is considered selected."
},
{
"name": "value",
"description": "The value."
}
]
},
{
"name": "uic-checkbox",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "checked",
"description": "If set to `true`, the checkbox is considered to be checked.\nThis property can be overridden by the `mixed` property."
},
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the checkbox."
},
{
"name": "label",
"description": "The text to show next to the checkmark."
},
{
"name": "mixed",
"description": "If set to `true`, the checkbox is neither checked nor unchecked.\nMostly used in a hierarchy with multiple child checkboxes to indicate their different states."
},
{
"name": "multiline",
"description": "If set to `true`, the label will wrap."
}
]
},
{
"name": "uic-combobox",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the combobox."
},
{
"name": "label",
"description": "The text describing the values to choose from."
},
{
"name": "multiple",
"description": "If set to `true`, allows multiple selected values."
},
{
"name": "placeholder",
"description": "The text to show if no value is selected."
},
{
"name": "placement",
"description": "The initial placement of the popover.\nOnly use this property if you want to force an initial direction,\nsince the popover calculates its placement based on available space.",
"values": [
{
"name": "bottom"
},
{
"name": "top"
}
]
},
{
"name": "selected-text",
"description": "The text to display instead of the selected option's value."
},
{
"name": "value",
"description": "The value of the dropdown."
}
]
},
{
"name": "uic-dialog",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "background-dismissable",
"description": "Controls whether clicking background of dialog is dismissing it.\n\n- If true, clicking background of dialog is dismissing it without\n confirming any action offered as a button in dialog's footer.\n\n- If false, clicking background is ignored.\n\nBy default, state of `dismissable` property is adopted."
},
{
"name": "dialog-title",
"description": "Title of the dialog, displayed in the header"
},
{
"name": "dismissable",
"description": "Controls whether dialog can be dismissed without picking any option\nprovided as a footer button.\n\n- If true, an X mark is rendered in top-right corner of dialog and clicking\nit dismisses the dialog without confirming any action offered as a button\nin dialog's footer.\n\n- If false, there is X mark available for clicking. In addition, setting it\n`false` is required to hide the header."
},
{
"name": "has-backdrop",
"description": "Whether to render the background/backdrop, clicks will work anyway"
},
{
"name": "icon",
"description": "Custom icon to show to the left of the title"
},
{
"name": "is-on-page-without-main-menu",
"description": "There is a fixed top margin because the main menu (which most styleguide apps should have),\nshould not be blurred.\nUse this prop to make the background/backdrop fill the full screen instead."
},
{
"name": "is-open",
"description": "May be used as alternative to calling the open() and close() methods"
},
{
"name": "size",
"description": "Dialog sizes as defined in the styleguide",
"values": [
{
"name": "large"
},
{
"name": "medium"
},
{
"name": "medium-height"
},
{
"name": "small"
}
]
},
{
"name": "trailing-icon",
"description": "Custom icon to show to the right of the title"
},
{
"name": "type",
"description": "Predefined dialog type for common use cases",
"values": [
{
"name": "default"
},
{
"name": "error"
},
{
"name": "warning"
}
]
}
]
},
{
"name": "uic-donut-chart",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "chart-id",
"description": "id attribute for this chart. A unique id will be generated if this is empty"
},
{
"name": "no-data-text",
"description": "Text for displaying when no data is available."
},
{
"name": "root-class",
"description": "Can be used to define a custom bar chart root class for styling purposes."
},
{
"name": "state",
"description": "State in which the bar chart is currently in."
},
{
"name": "transition-duration-ms",
"description": "Set the transition duration. As long as the transitions do not cause any issues, keep the default"
}
]
},
{
"name": "uic-dropdown",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the dropdown."
},
{
"name": "helper-text",
"description": "Information with low emphasis."
},
{
"name": "hoist",
"description": "Controls whether integrated popover is hoisted on display or not."
},
{
"name": "icon-placement",
"description": "Icon alignment"
},
{
"name": "invalid",
"description": "If set to `true`, the value is considered incorrect.\nAn invalid state will show the error flag."
},
{
"name": "invalid-text",
"description": "Shown when invalid is `true`."
},
{
"name": "label",
"description": "The text describing the values to choose from."
},
{
"name": "multiple",
"description": "If set to `true`, allows multiple selected values."
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "open",
"description": "If set to `true`, the dropdown is visible."
},
{
"name": "placeholder",
"description": "The text to show if no value is selected."
},
{
"name": "placement",
"description": "The initial placement of the popover.\nOnly use this property if you want to force an initial direction,\nsince the popover calculates its placement based on available space.",
"values": [
{
"name": "bottom"
},
{
"name": "top"
}
]
},
{
"name": "required",
"description": "If set to `true`, a value has to be set."
},
{
"name": "selected-text",
"description": "The text to display instead of the selected option's value."
},
{
"name": "value",
"description": "The value of the dropdown."
},
{
"name": "variant",
"description": "The variant to use.",
"values": [
{
"name": "content"
},
{
"name": "header"
}
]
}
]
},
{
"name": "uic-filter",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "all-selected-text",
"description": "The text to display for all selected item."
},
{
"name": "bind-label",
"description": "The property path used to get the label of an item."
},
{
"name": "bind-value",
"description": "The property path used to get the value of an item."
},
{
"name": "confirm-selection-text",
"description": "The text to display for confirming the selection."
},
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the button."
},
{
"name": "group-by",
"description": "The property path or function used to group items."
},
{
"name": "hoist",
"description": "Controls whether popover is hoisted or not. A hoisted popover isn't cut\noff by its container."
},
{
"name": "label",
"description": "The text describing the values to choose from."
},
{
"name": "multiple",
"description": "If set to `true`, the user can select multiple items."
},
{
"name": "multiple-selected-text",
"description": "The text to display for multiple selected items."
},
{
"name": "no-search-results-text",
"description": "The text to display the search term results in empty results."
},
{
"name": "reset-selection-text",
"description": "The text to display for resetting the selection."
},
{
"name": "search-placeholder-text",
"description": "The placeholder text to display for the search field"
},
{
"name": "searchable",
"description": "Allow to search for a value."
},
{
"name": "selectable-group",
"description": "Allow to select group when groupBy is used."
},
{
"name": "selectable-group-as-model",
"description": "If set to `false`, selecting a group will select all of its children but not the group itself."
},
{
"name": "selected-text",
"description": "The text to display instead of the selected option's value."
}
]
},
{
"name": "uic-flyout",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "name",
"description": "Unique name used to identify the flyout"
},
{
"name": "opened",
"description": "Flag that indicates if the flyout is opened (visible) or not (hidden)"
},
{
"name": "position",
"description": "Horizontal position of the flyout",
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
}
]
},
{
"name": "uic-footer",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": []
},
{
"name": "uic-footer-menu",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": []
},
{
"name": "uic-gauge-chart",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "chart-id",
"description": "id attribute for this chart. A unique id will be generated if this is empty"
},
{
"name": "label",
"description": "Label for the value. Displayed right below the chart, if set."
},
{
"name": "max",
"description": "The maximum value of the gauge."
},
{
"name": "min",
"description": "The minimum value of the gauge."
},
{
"name": "no-data-text",
"description": "Text for displaying when no data is available."
},
{
"name": "root-class",
"description": "Can be used to define a custom bar chart root class for styling purposes."
},
{
"name": "state",
"description": "State in which the bar chart is currently in."
},
{
"name": "transition-duration-ms",
"description": "Set the transition duration. As long as the transitions do not cause any issues, keep the default"
},
{
"name": "use-color-from-thresholds",
"description": "Set to true to use the threshold color for the value arc, ff the value is within one of the defined thresholds."
},
{
"name": "value",
"description": "The data prop for binding. Each key in the object is one arc with it's proportions calculated from the value, given as number"
}
]
},
{
"name": "uic-header",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": []
},
{
"name": "uic-header-menu",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "current",
"description": "Name of the currently selected header-menu-item"
},
{
"name": "name",
"description": "Name that identifies the menu"
},
{
"name": "role",
"description": "The `role` attribute of the header-menu",
"values": [
{
"name": "menu"
},
{
"name": "menubar"
},
{
"name": "tablist"
}
]
},
{
"name": "toggle",
"description": "Flag that indicates whether the menu behaves as a toggle switch"
},
{
"name": "variant",
"description": "Variant of the header-menu",
"values": [
{
"name": "primary"
},
{
"name": "secondary"
}
]
},
{
"name": "vertical",
"description": "If set to `true` the menu items are arranged vertically"
}
]
},
{
"name": "uic-header-menu-indicator",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "vertical",
"description": "If set to `true` a vertical indicator is displayed on the left side"
}
]
},
{
"name": "uic-header-menu-item",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "badge",
"description": "Optional badge text"
},
{
"name": "disabled",
"description": "Flag that indicates if the menu item is disabled"
},
{
"name": "download",
"description": "Used for the link download attribute if `href` is set"
},
{
"name": "expanded",
"description": "If the item has nested items"
},
{
"name": "href",
"description": "If set, the menu item acts as a link"
},
{
"name": "icon",
"description": "Name of the icon that should be rendered instead of or before the label"
},
{
"name": "icon-only",
"description": "Flag that indicates that the menu-item only renders an icon without label"
},
{
"name": "label",
"description": "Label text use as aria-label attribute and slot fallback"
},
{
"name": "level",
"description": "The level in a nested menu"
},
{
"name": "name",
"description": "Name that must be unique in the menu scope identifies the menu-item"
},
{
"name": "role",
"description": "The `role` attribute of the element",
"values": [
{
"name": "menuitem"
},
{
"name": "tab"
}
]
},
{
"name": "selected",
"description": "Flag that indicates if the menu item is currently selected or not"
},
{
"name": "target",
"description": "Used for the link target attribute if `href` is set"
},
{
"name": "trailing-icon",
"description": "Name of the icon that should be rendered after the label"
}
]
},
{
"name": "uic-horizontal-menu-container",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "close-submenu-after-selection",
"description": "When clicking a leaf item, choose whether the submenus should collapse or stay open"
},
{
"name": "preselected-menu-item",
"description": "Name of the setting that should be selected initially. If there is a first level setting with an equal name it opens automatically."
},
{
"name": "prevent-auto-navigation",
"description": "Block any menu input if it is prohibited, for example if there are unsaved changes"
}
]
},
{
"name": "uic-icon",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "name",
"description": "The name of the icon to show. Corresponds to an ID of a symbol inside an SVG sheet."
},
{
"name": "size",
"description": "A convenient way to set a predefined icon size.",
"values": [
{
"name": "small"
}
]
}
]
},
{
"name": "uic-icon-button",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the button."
},
{
"name": "icon",
"description": "The name of the icon to show."
},
{
"name": "selected",
"description": "If set to `true`, the button is considered selected or toggled."
},
{
"name": "variant",
"description": "Button variant. Use the \"light\" variant on dark backgrounds",
"values": [
{
"name": "dark"
},
{
"name": "light"
}
]
}
]
},
{
"name": "uic-iconset",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "name",
"description": "The name of the iconset."
}
]
},
{
"name": "uic-input-field",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "autocapitalize",
"description": "The input's autocaptialize attribute."
},
{
"name": "autocomplete",
"description": "The input's autocomplete attribute."
},
{
"name": "autocorrect",
"description": "The input's autocorrect attribute."
},
{
"name": "autofocus",
"description": "The input's autofocus attribute."
},
{
"name": "clearable",
"description": "If set to `true`, the user can clear all input using a button."
},
{
"name": "disabled",
"description": "Set to true to disable the input."
},
{
"name": "flag",
"description": "An indicator."
},
{
"name": "helper-text",
"description": "Information with low emphasis."
},
{
"name": "inputmode",
"description": "The inputmode of the input.\nA hint to the browser for which keyboard to display.",
"values": [
{
"name": "decimal"
},
{
"name": "email"
},
{
"name": "none"
},
{
"name": "numeric"
},
{
"name": "search"
},
{
"name": "tel"
},
{
"name": "text"
},
{
"name": "url"
}
]
},
{
"name": "invalid",
"description": "If set to `true`, the value is considered incorrect.\nAn invalid state will show the error flag."
},
{
"name": "invalid-text",
"description": "Shown when invalid is `true`."
},
{
"name": "label",
"description": "The label."
},
{
"name": "max",
"description": "The input's max attribute."
},
{
"name": "maxlength",
"description": "The input's maxlength attribute."
},
{
"name": "min",
"description": "The input's min attribute."
},
{
"name": "minlength",
"description": "The input's minlength attribute."
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "pattern",
"description": "The input's pattern attribute."
},
{
"name": "placeholder",
"description": "The placeholder text."
},
{
"name": "readonly",
"description": "Set to true for a readonly input."
},
{
"name": "required",
"description": "The input's required attribute."
},
{
"name": "spellcheck",
"description": "If `true`, the element will have its spelling and grammar checked."
},
{
"name": "step",
"description": "The input's step attribute."
},
{
"name": "type",
"description": "The type of the input.",
"values": [
{
"name": "email"
},
{
"name": "number"
},
{
"name": "password"
},
{
"name": "search"
},
{
"name": "text"
},
{
"name": "url"
}
]
},
{
"name": "unit",
"description": "The unit of the value.\nDo not use in combination with `clearable`."
},
{
"name": "value",
"description": "The value."
}
]
},
{
"name": "uic-input-field-number",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "clamp-on-blur",
"description": "If set to `true`, clamps the value to `min` and `max` after losing focus.\nThe value will be clamped to each bound only if the bound is defined."
},
{
"name": "default-value",
"description": "The default value of the input after initialization.\nAlso used in combination with `clampOnBlur` to reset to a valid value."
},
{
"name": "disabled",
"description": "Set to `true` to disable the input."
},
{
"name": "flag",
"description": "An indicator."
},
{
"name": "helper-text",
"description": "Information with low emphasis."
},
{
"name": "invalid",
"description": "If set to `true`, the state is considered invalid."
},
{
"name": "invalid-text",
"description": "Information to show if the value is invalid."
},
{
"name": "label",
"description": "The label."
},
{
"name": "locale",
"description": "The locale to use for input validation."
},
{
"name": "max",
"description": "The maximum value."
},
{
"name": "min",
"description": "The minimum value."
},
{
"name": "placeholder",
"description": "The placeholder text."
},
{
"name": "precision",
"description": "The maximum number of decimal places.\nSet to `0` to only allow integer values."
},
{
"name": "required",
"description": "The input's required attribute."
},
{
"name": "step",
"description": "The increment size to use when using keyboard navigation."
},
{
"name": "unit",
"description": "The unit of the value, e.g \"mm\", \"kg\"."
},
{
"name": "value",
"description": "A valid number or `Number.NaN`."
}
]
},
{
"name": "uic-legend",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "clickable",
"description": ""
},
{
"name": "orientation",
"description": "",
"values": [
{
"name": "horizontal"
},
{
"name": "vertical"
}
]
}
]
},
{
"name": "uic-line-chart",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "chart-id",
"description": "id attribute for this chart. A unique id will be generated if this is empty"
},
{
"name": "curve-function-name",
"description": "Choose one of d3's curve interpolation functions.\nThe default ist curveLinear (= no interpolation)\nsee e.g. http://bl.ocks.org/d3indepth/b6d4845973089bc1012dec1674d3aff8 for a quick comparison",
"values": [
{
"name": "curveBasis"
},
{
"name": "curveBundle"
},
{
"name": "curveCardinal"
},
{
"name": "curveCatmullRom"
},
{
"name": "curveLinear"
},
{
"name": "curveMonotoneX"
},
{
"name": "curveNatural"
},
{
"name": "curveStep"
},
{
"name": "curveStepAfter"
},
{
"name": "curveStepBefore"
}
]
},
{
"name": "disable-tooltip",
"description": "Use this flag if you don't want to use the tooltips"
},
{
"name": "hide-dots",
"description": "Whether the datapoint dots shouldn't be displayed"
},
{
"name": "line-chart-root-class",
"description": "Can be used to define a custom line chart root class for styling purposes."
},
{
"name": "no-data-text",
"description": "Text for displaying when no data is available."
},
{
"name": "selected-group",
"description": "Set this prop to one of your group keys (= lines) to highlight it"
},
{
"name": "state",
"description": "State in which the line chart is currently in."
},
{
"name": "transition-duration-ms",
"description": "Set the transition duration. As long as the transitions do not cause any issues, keep the default"
},
{
"name": "x-scale-type",
"description": "Select the x axis scale to use\nTime scales always keep a continuous timeline even if time values are skipped in the input data.\nBand scales allow for skipped values even if using a time measure for the x axis.\nYou need to supply the `data` group keys as strings. It's best to use the standard iso format of yyyy-MM-dd'T'HH-mm-ss'Z' when using the time scale.",
"values": [
{
"name": "band"
},
{
"name": "time"
}
]
},
{
"name": "y-axis-label",
"description": "Label for the Y axis."
},
{
"name": "y-max-value",
"description": "The maximum value to display on the y axis\nUseful for showing values in context of an expected range (e.g. 0-100%)\nIf not set (default) the maximum y value is used."
},
{
"name": "y-min-value",
"description": "The minimum value to display on the y axis\nUseful for showing values in context of an expected range (e.g. 0-100%)\nIf not set (default) the minimum y value is used."
},
{
"name": "y-ticks",
"description": "Number of ticks (entries) on the Y axis.\nIn some cases d3 overwrites this value and chooses the best automatically,\ndepending on the current width and height of the chart."
}
]
},
{
"name": "uic-list",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": []
},
{
"name": "uic-list-item",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with this element."
},
{
"name": "icon",
"description": "The name of the icon to show next to the label."
},
{
"name": "multiline",
"description": "If set to `true`, enables an additional slot for secondary content."
},
{
"name": "selected",
"description": "If set to `true`, the list item is considered selected."
},
{
"name": "value",
"description": "The value."
}
]
},
{
"name": "uic-list-separator",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": []
},
{
"name": "uic-loader",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "variant",
"description": "The variant to use. Use the \"light\" variant on dark backgrounds",
"values": [
{
"name": "dark"
},
{
"name": "light"
}
]
}
]
},
{
"name": "uic-message-list",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "acknowledged-by-text",
"description": "Translated text for 'acknowledged by'"
},
{
"name": "additional-info-text",
"description": "Translated text for 'show additional information' for the max view central column"
},
{
"name": "all-text",
"description": "Naming for 'All', for example in a different language"
},
{
"name": "current-text",
"description": "Naming for 'Current', for example in a different language"
},
{
"name": "history-duration",
"description": "sets the duration of messages shown in history, it's value is in hours"
},
{
"name": "history-text",
"description": "Naming for 'History', for example in a different language"
},
{
"name": "in-progress-text",
"description": "Translated text for 'error taken by'"
},
{
"name": "message-source-app-filter-label",
"description": "Naming of message source apps dropdown, for example in a different language"
},
{
"name": "messages-filter-label",
"description": "Naming of messages, for example in a different language"
},
{
"name": "no-messages-text",
"description": "Naming for 'no messages', for example in a different language"
},
{
"name": "show-all-messages-text",
"description": "Naming for 'Show all messages', for example in a different language"
},
{
"name": "user-id",
"description": ""
},
{
"name": "user-locale",
"description": "userLocale is the language selected by the user, for example 'de-DE'. See: https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument"
},
{
"name": "variant",
"description": "Show small side bar or large full screen menu",
"values": [
{
"name": "max"
},
{
"name": "min"
}
]
},
{
"name": "visible-message-type",
"description": "sets the type of view user wants to see through dropdown, All, Current or History"
}
]
},
{
"name": "uic-message-list-item",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "acknowledged-by-text",
"description": "Translated text for 'acknowledged by'"
},
{
"name": "additional-info-text",
"description": "Translated text for 'show additional information' for the max view central column"
},
{
"name": "in-progress-text",
"description": "Translated text for 'error taken by'"
},
{
"name": "mid",
"description": "Message-ID, used to expand the children of a specific parent message"
},
{
"name": "user-id",
"description": "Current user's id"
},
{
"name": "user-locale",
"description": "userLocale is the language selected by user'"
},
{
"name": "variant",
"description": "Show small side bar or large full screen menu",
"values": [
{
"name": "max"
},
{
"name": "min"
}
]
}
]
},
{
"name": "uic-message-toast",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "delete-message-after-millis",
"description": "Delete the message after x milliseconds automatically"
},
{
"name": "max-number-of-messages",
"description": "How many messages should be shown as a maximum. Any new message after that will be ignored."
},
{
"name": "replace-older-messages",
"description": "Set whether older messages should be replaced by newer ones"
},
{
"name": "show-details-text",
"description": "Translated 'show all messages' text"
},
{
"name": "swipe-delete-threshold",
"description": "How far to the right (in pixels) the message needs to be dragged to delete it"
}
]
},
{
"name": "uic-multiline-input",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "autocomplete",
"description": "The autocomplete attribute of textarea."
},
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with component."
},
{
"name": "helper-text",
"description": "Information with low emphasis."
},
{
"name": "invalid",
"description": "If set to `true`, the value is considered incorrect.\nAn invalid state will show the error flag."
},
{
"name": "label",
"description": "The label."
},
{
"name": "maxlength",
"description": "The maximum number of characters."
},
{
"name": "minlength",
"description": "The minmum number of characters."
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "placeholder",
"description": "A hint to the user of what can be entered in the control."
},
{
"name": "readonly",
"description": "Indicates that the user cannot modify the value of the control."
},
{
"name": "spellcheck",
"description": "If `true`, the element will have its spelling and grammar checked."
},
{
"name": "value",
"description": "The value of the textarea."
}
]
},
{
"name": "uic-output",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "align",
"description": "The alignment of the value.",
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
},
{
"name": "flag",
"description": "If set to `true`, shows a flag that defaults to the typical \"error\" icon.\nA string value shows a flag where the name of the flag denotes the icon."
},
{
"name": "label",
"description": "Indicates the kind of value."
},
{
"name": "max-lines",
"description": "Limits number of text lines to show."
},
{
"name": "multiline",
"description": "If set to `true`, the value can span multiple lines and will not be shortened."
},
{
"name": "unit",
"description": "The unit of the value, e.g \"mm\", \"kg\"."
},
{
"name": "value",
"description": "The value."
},
{
"name": "variant",
"description": "The output variant. Choose `copytext` to optimize for values with a lot of text.",
"values": [
{
"name": "copytext"
},
{
"name": "value"
}
]
}
]
},
{
"name": "uic-pagination",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "boundary-count",
"description": "Number of always visible pages at the beginning and end.\nIf not set, will be calculated based on maxVisible ((maxVisible - 3) / 4).\nMay overwrite max-visible."
},
{
"name": "input-debounce-ms",
"description": "The waiting time after input changes (mobile layout and ellipsis inputs)\nbefore the page is updated"
},
{
"name": "max-visible",
"description": "The maximum visible page count (default 7), useful to force narrow layout"
},
{
"name": "page",
"description": "The current page, in the range of 1 - total-pages"
},
{
"name": "sibling-count",
"description": "Number of always visible pages before and after the current one.\nIf not set, will be calculated based on maxVisible ((maxVisible - 3) / 4).\nMay overwrite max-visible."
},
{
"name": "total-pages",
"description": "The total page count, i.e. number of last page"
}
]
},
{
"name": "uic-popover",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "close-on-select",
"description": "Set to `true` to automatically close the popover when a list item is selected."
},
{
"name": "distance",
"description": "The distance in pixels from which to offset the panel away from its trigger."
},
{
"name": "hoist",
"description": "Set to `true` to prevent the panel from being clipped when the component is placed inside a container with\n`overflow: auto|scroll|hidden`."
},
{
"name": "open",
"description": "If set to `true`, the popover is visible."
},
{
"name": "placement",
"description": "The preferred placement of the dropdown panel.The actual placement may vary to keep the panel\ninside of the viewport.",
"values": [
{
"name": "bottom"
},
{
"name": "bottom-end"
},
{
"name": "bottom-start"
},
{
"name": "left"
},
{
"name": "left-end"
},
{
"name": "left-start"
},
{
"name": "right"
},
{
"name": "right-end"
},
{
"name": "right-start"
},
{
"name": "top"
},
{
"name": "top-end"
},
{
"name": "top-start"
}
]
},
{
"name": "skidding",
"description": "The distance in pixels from which to offset the panel along its trigger."
}
]
},
{
"name": "uic-progress-bar",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "max",
"description": "The maximum value of the progress bar"
},
{
"name": "value",
"description": "The current progress, relative to 100 or `max`, if defined"
},
{
"name": "variant",
"description": "The variant to use. Use the \"light\" variant on dark backgrounds",
"values": [
{
"name": "dark"
},
{
"name": "light"
}
]
}
]
},
{
"name": "uic-radio",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "checked",
"description": "If set to `true`, the radio is considered to be checked."
},
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the component."
},
{
"name": "icon",
"description": "The icon next to the label."
},
{
"name": "label",
"description": "The text to show next to the checked indicator."
},
{
"name": "value",
"description": "The value of the radio button."
}
]
},
{
"name": "uic-radio-group",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "label",
"description": "The text to show next to the radio buttons."
},
{
"name": "value",
"description": "The value of the radio button that should be checked."
}
]
},
{
"name": "uic-scroll-picker",
"description": {
"kind": "markdown",
"value": "This scroll picker is inspired by this code pen: https://codepen.io/gnauhca/pen/JrdpZZ"
},
"attributes": [
{
"name": "additional-item-count",
"description": "Displayed number of items above and below the selected value"
},
{
"name": "disabled",
"description": "Boolean to disable the scroll-picker"
},
{
"name": "unit",
"description": "The unit for the items"
},
{
"name": "value",
"description": "The value of the selected item"
}
]
},
{
"name": "uic-scrollpanel",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": []
},
{
"name": "uic-search-field",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If set to `true`, the user cannot enter text input."
},
{
"name": "placeholder",
"description": "The placeholder text."
},
{
"name": "value",
"description": "The value of the input."
}
]
},
{
"name": "uic-segmented-control",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": []
},
{
"name": "uic-sidebar",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "align-footer",
"description": "Flag that indicates if the sidebar bottom should be aligned with a footer"
},
{
"name": "align-header",
"description": "Flag that indicates if the sidebar top should be aligned with a header"
},
{
"name": "name",
"description": "Unique name used to identify the sidebar"
},
{
"name": "opened",
"description": "Flag that indicates if the sidebar is opened or not"
},
{
"name": "side",
"description": "On which side should the sidebar be positioned",
"values": [
{
"name": "left"
},
{
"name": "right"
}
]
}
]
},
{
"name": "uic-stepper",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "clamp-on-blur",
"description": "If set to `true`, clamps the value to `min` and `max` after losing focus.\nThe value will be clamped to each bound only if the bound is defined."
},
{
"name": "default-value",
"description": "The default value of the input after initialization.\nAlso used in combination with `clampOnBlur` to reset to a valid value."
},
{
"name": "disabled",
"description": "Set to `true` to disable the input."
},
{
"name": "helper-text",
"description": "Information with low emphasis."
},
{
"name": "invalid",
"description": "If set to `true`, the state is considered invalid."
},
{
"name": "invalid-text",
"description": "Information to show if the value is invalid."
},
{
"name": "label",
"description": "The label."
},
{
"name": "locale",
"description": "The locale to use for input validation."
},
{
"name": "max",
"description": "The maximum value."
},
{
"name": "min",
"description": "The minimum value."
},
{
"name": "placeholder",
"description": "The placeholder text."
},
{
"name": "precision",
"description": "The maximum number of decimal places.\nSet to `0` to only allow integer values."
},
{
"name": "step",
"description": "The increment size to use when using keyboard navigation."
},
{
"name": "unit",
"description": "The unit of the value, e.g \"mm\", \"kg\"."
},
{
"name": "value",
"description": "A valid number or `Number.NaN`."
}
]
},
{
"name": "uic-switch",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "checked",
"description": "If set to `true`, the switch is considered \"on\"."
},
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the switch."
},
{
"name": "label",
"description": "The label."
}
]
},
{
"name": "uic-tab",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with this tab."
},
{
"name": "icon",
"description": "The name of the icon."
},
{
"name": "label",
"description": "The text shown inside the tab."
},
{
"name": "selected",
"description": "If set to `true`, indicates that the tab is the selected one inside a tab-list."
},
{
"name": "value",
"description": "The value used to uniquely identify the tab inside the tab-list."
},
{
"name": "vertical",
"description": "If set to `true`, the tabs orientation is considered to be vertical."
}
]
},
{
"name": "uic-tab-list",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "manual-selection-indicator",
"description": "When the selection indicator should be set manually from the outside (with updateSelectionIndicator(tab)), this can block the default behavior"
},
{
"name": "prevent-auto-navigation",
"description": "Prevent the user from clicking a tab without a check from a parent component.\nFor example a tab opens an iframe where the user changes a name and doesn't save it, the parent component can then\ninterrupt the navigation."
},
{
"name": "value",
"description": "The value of the selected tab. Overrides tabs with `selected` set to `true`."
},
{
"name": "variant",
"description": "The color variant.",
"values": [
{
"name": "content"
},
{
"name": "main"
},
{
"name": "sub"
}
]
},
{
"name": "vertical",
"description": "If set to `true`, the direction of the tab list is vertical."
}
]
},
{
"name": "uic-table",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "full-width",
"description": "the table should always be at least 100% wide"
},
{
"name": "self-sorting",
"description": "this enables the self-sorting feature for the table. If you display incomplete data (i.e. with pagination) you should do the sorting by yourself using the uicTableSort events"
}
]
},
{
"name": "uic-table-column",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "field",
"description": "defines which field of the table will be displayed in the column"
},
{
"name": "group",
"description": "defines if the column should be a group"
},
{
"name": "label",
"description": "defines the label of the table column"
},
{
"name": "multiline",
"description": "wrap the content of this column if required, requires to set a max-width on table (e.g. using `full-width` or css prop `--uic-table-width`) or column"
},
{
"name": "sort-field",
"description": "defines the sort field name, if set, instead of using the column field"
},
{
"name": "sortable",
"description": "defines if the column should be sortable"
}
]
},
{
"name": "uic-table-column-checkbox",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "editable",
"description": "defines if the checkbox should be editable"
},
{
"name": "field",
"description": "defines which field of the table will be displayed in the column"
},
{
"name": "group",
"description": "defines if the column should be a group"
},
{
"name": "label",
"description": "defines the label of the table column"
},
{
"name": "sortable",
"description": "defines if the column should be sortable"
}
]
},
{
"name": "uic-table-column-custom",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "field",
"description": "field name that is be passed to the cellTemplate function"
},
{
"name": "group",
"description": "defines if the column should be a group"
},
{
"name": "label",
"description": "label that is displayed in the column header"
},
{
"name": "multiline",
"description": "wrap the content of this column if required, requires to set a max-width on table (e.g. using `full-width` or css prop `--uic-table-width`) or column"
},
{
"name": "sort-field",
"description": "field name that should be used for sorting instead of the column field"
},
{
"name": "sortable",
"description": "defines if the column should be sortable"
}
]
},
{
"name": "uic-table-column-icon",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "field",
"description": "defines which field of the table will be displayed in the column"
},
{
"name": "group",
"description": "defines if the column should be a group"
},
{
"name": "icon-field",
"description": "defines the icon field name of the table column"
},
{
"name": "label",
"description": "defines the label of the table column"
},
{
"name": "multiline",
"description": "wrap the content of this column if required, requires to set a max-width on table (e.g. using `full-width` or css prop `--uic-table-width`) or column"
},
{
"name": "sort-field",
"description": "defines the sort field name, if set, instead of using the column field"
},
{
"name": "sortable",
"description": "defines if the column should be sortable"
}
]
},
{
"name": "uic-table-column-selection",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "group",
"description": "defines if the column should be a group"
}
]
},
{
"name": "uic-table-head-sort",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "sort-field",
"description": "This is the name of the sort field used in the sort click event"
},
{
"name": "sorted-direction",
"description": "indicates in which direction the data is already sorted. This has to be empty when it is not sorted yet. Setting this does not trigger the sorting event. Clicking the button will update this attribute.",
"values": [
{
"name": "asc"
},
{
"name": "desc"
}
]
}
]
},
{
"name": "uic-tag",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "clearable",
"description": "If set to `true`, indicates that the user is able to remove the tag."
},
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the tag."
}
]
},
{
"name": "uic-thumbnail",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "scroll-step",
"description": "The number of pixels to scroll up or down when using the thumbnail buttons.\nDefaults to the CSS custom property --uic-thumbnail-item-height."
},
{
"name": "selected",
"description": "The index of the selected thumbnail-item."
}
]
},
{
"name": "uic-thumbnail-item",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "icon",
"description": "The name of the icon to show next to the thumbnail content."
},
{
"name": "placeholder",
"description": "If set to `true`, indicates that the content of the thumbnail item is a placeholder."
},
{
"name": "selected",
"description": "If set to `true`, indicates that the thumbnail is the selected one inside a thumbnail list."
}
]
},
{
"name": "uic-tile",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "headline",
"description": "The headline/label/title displayed in the header bar"
},
{
"name": "icon",
"description": "Custom icon to show to the left of the headline in the header bar"
},
{
"name": "is-clickable",
"description": "Whether the tile should behave like it's clickable,\ni.e. the click event bubbles and there are css hover, active & focus states"
},
{
"name": "is-dismissable",
"description": "Whether the tile should be closeable with a cross icon in the header bar."
},
{
"name": "is-draggable",
"description": "Whether the tile should behave like it's dragable,\ni.e. uses matching mouse cursor and there are css hover, active & focus states"
},
{
"name": "is-dragged",
"description": "Whether the tile is dragged right now,\ni.e. dashed border, opacity adjusted.\nSet this to true during movement when using a drag and drop lib."
},
{
"name": "is-loading",
"description": "Whether the tile is in a loading state or not,\ni.e. display a loader instead of the content"
},
{
"name": "variant",
"description": "Tile variant. \"outline\" should only be used for \"buttons\" to add more tiles",
"values": [
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "outline"
}
]
}
]
},
{
"name": "uic-tooltip",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "closeable",
"description": "Determines wether the tooltip should be closed by a close button.\n\nThe close button is always visible when setting `visible` and never visible with `hidden`.\nSetting `auto` shows the button only if the user opens the tooltip using a long press.",
"values": [
{
"name": "auto"
},
{
"name": "hidden"
},
{
"name": "visible"
}
]
},
{
"name": "disabled",
"description": "If set to `true` the user cannot interact with the tool and no tooltip is shown."
},
{
"name": "distance",
"description": "The distance in pixels from which to offset the tooltip away from its tool."
},
{
"name": "error",
"description": "If set to `true` shows a tooltip indicating an error."
},
{
"name": "hoist",
"description": "Set to `true` to prevent the panel from being clipped when the component is placed inside a container with\n`overflow: auto|scroll|hidden`."
},
{
"name": "open",
"description": "If set to `true`, opens the tooltip. May be used programmatically to open the tooltip."
},
{
"name": "placement",
"description": "The placement of UI indicating the direction.",
"values": [
{
"name": "bottom-end"
},
{
"name": "bottom-start"
},
{
"name": "top-end"
},
{
"name": "top-start"
}
]
},
{
"name": "tip",
"description": "The message to show the user as tip."
}
]
},
{
"name": "uic-virtual-scroll",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "buffer",
"description": "Amount of items to render in addition to visible items of the viewport.\nKeep this number as low as possible to enhance performance."
},
{
"name": "item-height",
"description": "The height of an item."
},
{
"name": "items",
"description": "The amount of items to render or an array with items to render.\nThe former option requires setting the `getItems` function."
}
]
},
{
"name": "uic-wizard-header-step",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "auto-flyout",
"description": "If set to `true`, the flyout is automatically opened when the step is selected."
},
{
"name": "disabled",
"description": "If set to `true`, the user cannot interact with the button."
},
{
"name": "flag",
"description": "The name of the flag to show next to the step number. May be overwritten by the \"flag\" slot."
},
{
"name": "flyout-button-label",
"description": "Set as custom label for the button of the flyout. Defaults to 'Close' which is not translated.\nTo use custom buttons the slot \"flyout-footer\" may be used."
},
{
"name": "flyout-open",
"description": "If set to `true`, the flyout is open(ed). Setting it to true will only take effect when the step is selected."
},
{
"name": "index",
"description": "The index of this step, displayed as number in the component. 1-based."
},
{
"name": "label",
"description": "The text shown next to the step number. May be overwritten by the default slot."
},
{
"name": "name",
"description": "The value used to uniquely identify the step."
},
{
"name": "selected",
"description": "If set to `true`, the button is considered selected or toggled."
},
{
"name": "state",
"description": "Select the state of this step. Used to show the default flags.",
"values": [
{
"name": "default"
},
{
"name": "done"
},
{
"name": "error"
},
{
"name": "in-progress"
}
]
},
{
"name": "vertical",
"description": "If set to `true`, the wizard header orientation is considered to be vertical."
}
]
}
]
}