balm-ui
Version:
A modular and customizable UI library based on Material Design and Vue 3
1,658 lines • 51 kB
JSON
{
"ui-icon/type": {
"type": "string | number",
"options": [
"filled",
"outlined",
"round",
"twoTone",
"sharp"
],
"description": "Material icon theme."
},
"ui-icon/outlined": {
"type": "boolean",
"description": "Outlined icons customize stroke and fill attributes for a light, clean style that works well in dense UIs. The stroke weight of outlined icons can be adjusted to complement or contrast the weight of your typography."
},
"ui-icon/round": {
"type": "boolean",
"description": "Rounded icons use a corner radius that pairs well with brands that use heavier typography, curved logos, or circular elements to express their style."
},
"ui-icon/two-tone": {
"type": "boolean",
"description": "Two-tone icons have added dimension, using the attributes of stroke, fill, and color. Contrasting stroke and fill colors enables the use of multiple brand colors and can improve legibility."
},
"ui-icon/sharp": {
"type": "boolean",
"description": "Sharp icons display corners with straight edges, for a crisp style that remains legible even at smaller scales. These rectangular shapes can support brand styles that aren’t well-reflected by rounded shapes."
},
"ui-icon/size": {
"type": "number",
"description": "Material icon sizing."
},
"ui-icon/dark": {
"type": "boolean",
"description": "An icon on a light background with a dark foreground color."
},
"ui-icon/light": {
"type": "boolean",
"description": "An icon on a dark background with a light foreground color."
},
"ui-icon/inactive": {
"type": "boolean",
"description": "An icon is disabled or inactive."
},
"ui-button/type": {
"type": "string | number",
"options": [
"text",
"outlined",
"raised",
"unelevated"
],
"description": "Button type."
},
"ui-button/outlined": {
"type": "boolean",
"description": "Styles an outlined button that is flush with the surface."
},
"ui-button/raised": {
"type": "boolean",
"description": "Styles a contained button that is elevated above the surface."
},
"ui-button/unelevated": {
"type": "boolean",
"description": "Styles a contained button that is flush with the surface."
},
"ui-button/icon": {
"type": "string",
"description": "Indicates an icon element."
},
"ui-button/disabled": {
"type": "boolean",
"description": "Disabled buttons cannot be interacted with and have no visual interaction effect."
},
"ui-button/native-type": {
"type": "string",
"options": [
"button",
"submit",
"reset"
],
"description": "The <button> native attribute."
},
"ui-fab/type": {
"type": "string | number",
"options": [
"regular",
"extended"
],
"description": "FAB type."
},
"ui-fab/extended": {
"type": "boolean",
"description": "Modifies the FAB to wider size which includes a text label."
},
"ui-fab/icon": {
"type": "string",
"description": "Indicates an icon element."
},
"ui-fab/mini": {
"type": "boolean",
"description": "Modifies the FAB to a smaller size."
},
"ui-fab/exited": {
"type": "boolean",
"description": "Animates the FAB out of view. When this class is removed, the FAB will return to view."
},
"ui-icon-button/model-value": {
"type": "boolean",
"description": "Sets the toggle state."
},
"ui-icon-button/icon": {
"type": "string",
"description": "Indicates an icon element."
},
"ui-icon-button/toggle": {
"type": "object",
"description": "Two icons of the icon button toggle. (Format: `{ on: string, off: string }`)"
},
"ui-segmented-buttons/model-value": {
"type": "array | number",
"description": "Sets the segmented buttons index(es)."
},
"ui-segmented-buttons/items": {
"type": "array",
"description": "Segmented button items."
},
"ui-segmented-buttons/singleSelect": {
"type": "boolean",
"description": "To make the segmented button single select."
},
"ui-segmented-button/selected": {
"type": "boolean",
"description": "Styles a selected segmented button."
},
"ui-segmented-button/text": {
"type": "string",
"description": "Segmented button text."
},
"ui-segmented-button/icon": {
"type": "string",
"description": "Segmented button icon."
},
"ui-top-app-bar/content-selector": {
"type": "string",
"description": "Selector used to style the content below the top app bar, to prevent the top app bar from covering it."
},
"ui-top-app-bar/type": {
"type": "string | number",
"options": [
"standard",
"fixed",
"dense",
"prominent",
"prominentDense",
"short",
"shortCollapsed",
"nonRegular"
],
"description": "Top app bar type."
},
"ui-top-app-bar/fixed": {
"type": "boolean",
"description": "Fixed top app bars stay at the top of the page and elevate above the content when scrolled."
},
"ui-top-app-bar/dense": {
"type": "boolean",
"description": "The dense top app bar is shorter."
},
"ui-top-app-bar/prominent": {
"type": "boolean",
"description": "The prominent top app bar is taller."
},
"ui-top-app-bar/prominent-dense": {
"type": "boolean",
"description": "The prominent top app bar with dense."
},
"ui-top-app-bar/short": {
"type": "boolean",
"description": "Short top app bars are top app bars that can collapse to the navigation icon side when scrolled."
},
"ui-top-app-bar/short-collapsed": {
"type": "boolean",
"description": "Short top app bars can be configured to always appear collapsed."
},
"ui-top-app-bar/title": {
"type": "string",
"description": "Application title."
},
"ui-top-app-bar/nav-icon": {
"type": "string | false",
"description": "A navigation icon. (Set 'close' for the contextual action bar)"
},
"ui-top-app-bar/nav-id": {
"type": "string",
"description": "Control the navigation drawer is opened or closed."
},
"ui-grid/fixed-column-width": {
"type": "boolean",
"description": "Specifies the grid should have fixed column width."
},
"ui-grid/position": {
"type": "string",
"options": [
"left",
"right"
],
"description": "Specifies the alignment of the whole grid."
},
"ui-grid-cell/nested": {
"type": "boolean",
"description": "The nested layout grid."
},
"ui-grid-cell/columns": {
"type": "number | object",
"description": "Specifies the number of columns the cell spans."
},
"ui-grid-cell/order": {
"type": "number",
"description": "Specifies the order of the cell."
},
"ui-grid-cell/align": {
"type": "string",
"description": "Specifies the alignment of cell."
},
"ui-form/type": {
"type": "string | number",
"options": [
"horizontal",
"vertical"
],
"description": "Form type."
},
"ui-form/item-margin-bottom": {
"type": "number",
"description": "Sets the form items margin bottom."
},
"ui-form/nowrap": {
"type": "boolean",
"description": "Force the <label> text to stay on a single line and ellipse the overflow text."
},
"ui-form/label-top-aligned": {
"type": "boolean",
"description": "Styles the form item with a top vertical-aligned label."
},
"ui-form/label-right-aligned": {
"type": "boolean",
"description": "Styles the form item with a right text-aligned label."
},
"ui-form/label-top-right-aligned": {
"type": "boolean",
"description": "Styles the form item with a top vertical-aligned and right text-aligned label."
},
"ui-form/label-width": {
"type": "number",
"description": "Sets the horizontal form items' label width."
},
"ui-form/label-margin-right": {
"type": "number",
"description": "Sets the horizontal form items' label margin right."
},
"ui-form/label-margin-bottom": {
"type": "number",
"description": "Sets the vertical form items' label margin bottom."
},
"ui-form/action-align": {
"type": "string",
"options": [
"left",
"center",
"right"
],
"description": "Sets the form actions align."
},
"ui-form-field/nowrap": {
"type": "boolean",
"description": "Force the text to stay on a single line and ellipse the overflow text."
},
"ui-form-field/align-end": {
"type": "boolean",
"description": "Position the input after the label."
},
"ui-form-field/space-between": {
"type": "boolean",
"description": "Align the input and label space between."
},
"ui-divider/type": {
"type": "string | number",
"options": [
"horizontal",
"vertical"
],
"description": "Text divider type."
},
"ui-drawer/type": {
"type": "string | number",
"options": [
"permanent",
"dismissible",
"modal"
],
"description": "Drawer type."
},
"ui-drawer/nav-id": {
"type": "string",
"description": "The external menu button selector."
},
"ui-drawer/model-value": {
"type": "boolean",
"description": "The drawer toggle state."
},
"ui-drawer/viewport-height": {
"type": "boolean",
"description": "Viewport full height(100vh)."
},
"ui-tabs/model-value": {
"type": "number",
"description": "Sets the tabs index."
},
"ui-tabs/items": {
"type": "array",
"description": "Tab items."
},
"ui-tabs/type": {
"type": "string | number",
"options": [
"text",
"iconOnly",
"textWithIcon"
],
"description": "The permutation of tab labels."
},
"ui-tabs/stacked": {
"type": "boolean",
"description": "Indicates that the tab icon and label should flow vertically instead of horizontally."
},
"ui-tabs/min-width": {
"type": "boolean",
"description": "Indicates that the tab should shrink in size to be as narrow as possible without causing text to wrap."
},
"ui-tabs/content-indicator": {
"type": "boolean",
"description": "Text label width-matching indicator."
},
"ui-tab-bar/model-value": {
"type": "number",
"description": "Sets the tabs index."
},
"ui-tab/type": {
"type": "string | number",
"options": [
"text",
"iconOnly",
"textWithIcon"
],
"description": "The permutation of tab labels."
},
"ui-tab/stacked": {
"type": "boolean",
"description": "Indicates that the tab icon and label should flow vertically instead of horizontally."
},
"ui-tab/min-width": {
"type": "boolean",
"description": "Indicates that the tab should shrink in size to be as narrow as possible without causing text to wrap."
},
"ui-tab/content-indicator": {
"type": "boolean",
"description": "Text label width-matching indicator."
},
"ui-tab/text": {
"type": "string",
"description": "Tab text."
},
"ui-tab/icon": {
"type": "string",
"description": "Tab icon."
},
"ui-panels/model-value": {
"type": "number",
"description": "Sets the panels index."
},
"ui-tab-indicator/type": {
"type": "string",
"options": [
"underline",
"icon"
],
"description": "Indicator type."
},
"ui-tab-indicator/fade": {
"type": "boolean",
"description": "Sets up the tab indicator to fade in on activation and fade out on deactivation."
},
"ui-tab-scroller/scroll-x": {
"type": "number",
"description": "The current scroll value."
},
"ui-tab-scroller/align": {
"type": "string",
"options": [
"start",
"center",
"end"
],
"description": "Tab alignment."
},
"ui-menu-anchor/position": {
"type": "string",
"options": [
"top left",
"top right",
"middle left",
"middle right",
"bottom left",
"bottom right"
],
"description": "Menu button position to the menu anchor."
},
"ui-menu-anchor/absolute": {
"type": "boolean",
"description": "The menu surface can use absolute positioning when being displayed. This requires that the element containing the menu has the `position: relative` style."
},
"ui-menu/model-value": {
"type": "boolean",
"description": "Sets the menu state."
},
"ui-menu/items": {
"type": "array",
"description": "Menu items."
},
"ui-menu/quick-open": {
"type": "boolean",
"description": "Turn off menu open animations."
},
"ui-menu/position": {
"type": "string",
"options": [
"TOP_LEFT",
"TOP_RIGHT",
"BOTTOM_LEFT",
"BOTTOM_RIGHT",
"TOP_START",
"TOP_END",
"BOTTOM_START",
"BOTTOM_END"
],
"description": "Menu position to the menu button."
},
"ui-menu/distance": {
"type": "object",
"description": "Anchor margin. (Format: `{ top, right, bottom, left }`)"
},
"ui-menu/fixed": {
"type": "boolean",
"description": "Used to indicate that the menu is using fixed positioning."
},
"ui-menu/fullwidth": {
"type": "boolean",
"description": "Sets the menu surface's width to match that of its parent anchor. Do not use with `fixed` or if hoisting to body."
},
"ui-menu/css-only": {
"type": "boolean",
"description": "Show static menu."
},
"ui-menuitem/nested": {
"type": "boolean",
"description": "Used to wrap a group of <ui-menuitem> that will represent a selection group."
},
"ui-menuitem/item": {
"type": "object",
"description": "A menu item."
},
"ui-menuitem/value": {
"type": "string",
"description": "The menu selected value."
},
"ui-menuitem/disabled": {
"type": "boolean",
"description": "To disable an item."
},
"ui-menuitem/selected": {
"type": "boolean",
"description": "Used to indicate which element in an item group is selected."
},
"ui-pagination/model-value": {
"type": "number",
"description": "Current page number."
},
"ui-pagination/total": {
"type": "number",
"description": "The total number of data items."
},
"ui-pagination/page-span": {
"type": "number | false",
"description": "Display the first N pages of the current page. (MIN VALUE: 3)"
},
"ui-pagination/show-total": {
"type": "boolean",
"description": "Display total info."
},
"ui-pagination/page-size": {
"type": "number | array",
"description": "The number of data items per page."
},
"ui-pagination/page-size-text": {
"type": "string | array",
"description": "The page size before/after text."
},
"ui-pagination/of-text": {
"type": "string",
"description": "The page total of text."
},
"ui-pagination/unit-text": {
"type": "string",
"description": "The page total unit text."
},
"ui-pagination/show-jumper": {
"type": "boolean",
"description": "Determine whether you can jump to pages directly."
},
"ui-pagination/jumper-text": {
"type": "string | array",
"description": "The jumper before/after text."
},
"ui-pagination/jumper-button-outlined": {
"type": "boolean",
"description": "Styles an outlined jumper button."
},
"ui-pagination/jumper-button-text": {
"type": "string",
"description": "The jumper button text."
},
"ui-pagination/position": {
"type": "string",
"options": [
"left",
"center",
"right"
],
"description": "The pagination position."
},
"ui-pagination/mini": {
"type": "boolean",
"description": "Whether to use simple mode."
},
"ui-textfield/type": {
"type": "string | number",
"options": [
"filled",
"outlined"
],
"description": "Text field type."
},
"ui-textfield/outlined": {
"type": "boolean",
"description": "Styles the text field as an outlined text field. (`label` or `placeholder` required)"
},
"ui-textfield/model-value": {
"type": "string | number",
"description": "Sets the text field value."
},
"ui-textfield/input-type": {
"type": "string",
"options": [
"text",
"password",
"email",
"number",
"search",
"url",
"tel"
],
"description": "Native <input> type."
},
"ui-textfield/input-id": {
"type": "string",
"description": "The id attribute of the <input> and the for attribute of the <label>."
},
"ui-textfield/label": {
"type": "string",
"description": "A text caption or description for the text field, which use the input's `placeholder` attribute instead."
},
"ui-textfield/placeholder": {
"type": "string",
"description": "The placeholder attribute of the <input>."
},
"ui-textfield/disabled": {
"type": "boolean",
"description": "Styles the text field as a disabled text field."
},
"ui-textfield/required": {
"type": "boolean",
"description": "Styles the text field as a required text field."
},
"ui-textfield/fullwidth": {
"type": "boolean",
"description": "Styles the text field as a full width text field."
},
"ui-textfield/end-aligned": {
"type": "boolean",
"description": "Styles the text field with an end-aligned input."
},
"ui-textfield/icon": {
"type": "string",
"description": "Indicates an icon element with a leading icon."
},
"ui-textfield/with-leading-icon": {
"type": "boolean",
"description": "Styles the text field as a text field with a leading icon."
},
"ui-textfield/with-trailing-icon": {
"type": "boolean",
"description": "Styles the text field as a text field with a trailing icon."
},
"ui-textfield/prefix-text": {
"type": "string",
"description": "Sets the text content of the prefix."
},
"ui-textfield/suffix-text": {
"type": "string",
"description": "Sets the text content of the suffix."
},
"ui-textfield/with-counter": {
"type": "boolean",
"description": "Styles the text area as a text area with an internal character counter."
},
"ui-textfield/helper-text-id": {
"type": "string",
"description": "Required for the id attribute of the <ui-textfield-helper>."
},
"ui-textfield/pattern": {
"type": "string",
"description": "Specifies a regular expression that an <input> element's value is checked against"
},
"ui-textfield/minlength": {
"type": "number",
"description": "Specifies the minimum number of characters required in an <input> element"
},
"ui-textfield/maxlength": {
"type": "number",
"description": "Specifies the maximum number of characters allowed in an <input> element"
},
"ui-textfield/min": {
"type": "number",
"description": "Specifies a minimum value for an <input> element"
},
"ui-textfield/max": {
"type": "number",
"description": "Specifies the maximum value for an <input> element"
},
"ui-textfield/step": {
"type": "number",
"description": "Specifies the interval between legal numbers in an input field"
},
"ui-textfield/rows": {
"type": "number",
"description": "Specifies the visible number of lines in a text area"
},
"ui-textfield/cols": {
"type": "number",
"description": "Specifies the visible width of a text area"
},
"ui-textfield/attrs": {
"type": "object",
"description": "Other attributes for <input> or <textarea>."
},
"ui-textfield-icon/trailing": {
"type": "boolean",
"description": "Display trailing icon."
},
"ui-textfield-icon/unclickable": {
"type": "boolean",
"description": "Display un-clickable icon."
},
"ui-textfield-helper/valid-msg": {
"type": "string | false",
"description": "Indicates the helper text is a validation message."
},
"ui-textfield-helper/id": {
"type": "string",
"description": "Corresponding to the `helper-text-id` prop matching <ui-textfield>"
},
"ui-textfield-helper/visible": {
"type": "boolean",
"description": "Makes the helper text permanently visible."
},
"ui-textfield-helper/with-counter": {
"type": "boolean",
"description": "Show character counter."
},
"ui-autocomplete/outlined": {
"type": "boolean",
"description": "Styles the autocomplete as an outlined text field. (`label` or `placeholder` required)"
},
"ui-autocomplete/model-value": {
"type": "string | number",
"description": "Sets the autocomplete value."
},
"ui-autocomplete/source": {
"type": "array",
"description": "Defines the data to use, must be specified."
},
"ui-autocomplete/source-format": {
"type": "object",
"description": "Defines the data source format."
},
"ui-autocomplete/input-id": {
"type": "string",
"description": "The id attribute of the <input> and the for attribute of the <label>."
},
"ui-autocomplete/label": {
"type": "string",
"description": "A text caption or description for the autocomplete, which use the input's `placeholder` attribute instead."
},
"ui-autocomplete/placeholder": {
"type": "string",
"description": "The placeholder attribute of the <input>."
},
"ui-autocomplete/disabled": {
"type": "boolean",
"description": "Styles the autocomplete as a disabled text field."
},
"ui-autocomplete/required": {
"type": "boolean",
"description": "Styles the autocomplete as a required text field."
},
"ui-autocomplete/autofocus": {
"type": "boolean",
"description": "If set to `true` the first item will automatically be focused when the menu is shown."
},
"ui-autocomplete/delay": {
"type": "number",
"description": "The delay in milliseconds between when a keystroke occurs and when a search is performed. A zero-delay makes sense for local data (more responsive), but can produce a lot of load for remote data, while being less responsive."
},
"ui-autocomplete/minlength": {
"type": "number",
"description": "The minimum number of characters a user must type before a search is performed. Zero is useful for local data with just a few items, but a higher value should be used when a single character search could match a few thousand items."
},
"ui-autocomplete/remote": {
"type": "boolean",
"description": "Get data by AJAX. Default usage for local data."
},
"ui-autocomplete/highlight": {
"type": "boolean",
"description": "Styles the autocomplete suggestion value as a strong text."
},
"ui-autocomplete/filter-keywords": {
"type": "boolean",
"description": "Enables the filter keywords suggestion."
},
"ui-autocomplete/fullwidth": {
"type": "boolean",
"description": "Styles the autocomplete as a full width text field."
},
"ui-autocomplete/end-aligned": {
"type": "boolean",
"description": "Styles the autocomplete with an end-aligned input."
},
"ui-autocomplete/icon": {
"type": "string",
"description": "Indicates an icon element with a leading icon."
},
"ui-autocomplete/with-leading-icon": {
"type": "boolean",
"description": "Styles the autocomplete as a text field with a leading icon."
},
"ui-autocomplete/with-trailing-icon": {
"type": "boolean",
"description": "Styles the autocomplete as a text field with a trailing icon."
},
"ui-autocomplete/inside": {
"type": "boolean",
"description": "Styles for the overflow inside component (e.g. in `<ui-dialog>`)"
},
"ui-select/type": {
"type": "string | number",
"options": [
"filled",
"outlined"
],
"description": "Enhanced select type."
},
"ui-select/outlined": {
"type": "boolean",
"description": "Styles the select as an outlined select."
},
"ui-select/model-value": {
"type": "string | number",
"description": "The value of the currently selected option."
},
"ui-select/options": {
"type": "array",
"description": "An array of options to show to the user."
},
"ui-select/options-format": {
"type": "object",
"description": "Defines the option data format."
},
"ui-select/default-label": {
"type": "string",
"description": "Placeholder item label."
},
"ui-select/default-value": {
"type": "string | number",
"description": "Placeholder item value."
},
"ui-select/label": {
"type": "string",
"description": "A text caption or description for the select."
},
"ui-select/disabled": {
"type": "boolean",
"description": "Styles the select as disabled."
},
"ui-select/required": {
"type": "boolean",
"description": "Styles the select as required."
},
"ui-select/fullwidth": {
"type": "boolean",
"description": "Styles the select as full width select."
},
"ui-select/icon": {
"type": "string",
"description": "Indicates an icon element with a leading icon."
},
"ui-select/with-leading-icon": {
"type": "boolean",
"description": "Styles the select as a select with a leading icon."
},
"ui-select/helper-text-id": {
"type": "string",
"description": "Required for the id attribute of the <ui-select-helper>."
},
"ui-select/inside": {
"type": "function",
"description": "Exclude row selections."
},
"ui-select-helper/valid-msg": {
"type": "string | false",
"description": "Indicates the helper text is a validation message."
},
"ui-select-helper/id": {
"type": "string",
"description": "Corresponding to the `helper-text-id` prop matching <ui-select>"
},
"ui-select-helper/visible": {
"type": "boolean",
"description": "Makes the helper text permanently visible."
},
"ui-select-icon/unclickable": {
"type": "boolean",
"description": "Display un-clickable icon."
},
"ui-checkbox/model-value": {
"type": "boolean | array",
"description": "Sets the checkbox value."
},
"ui-checkbox/indeterminate": {
"type": "boolean",
"description": "Styles the checkbox as an indeterminate checkbox."
},
"ui-checkbox/input-id": {
"type": "string",
"description": "The id attribute of the <input> and the for attribute of the <label>."
},
"ui-checkbox/value": {
"type": "string | number",
"description": "The value attribute of the <input>."
},
"ui-checkbox/disabled": {
"type": "boolean",
"description": "Styles the checkbox as a disabled checkbox."
},
"ui-checkbox/attrs": {
"type": "object",
"description": "Other attributes for <input>."
},
"ui-radio/model-value": {
"type": "boolean | array",
"description": "Sets the radio value."
},
"ui-radio/input-id": {
"type": "string",
"description": "The id attribute of the <input> and the for attribute of the <label>."
},
"ui-radio/value": {
"type": "string | number",
"description": "The value attribute of the <input>."
},
"ui-radio/disabled": {
"type": "boolean",
"description": "Styles the radio button as a disabled radio button."
},
"ui-radio/attrs": {
"type": "object",
"description": "Other attributes for <input>."
},
"ui-chips/type": {
"type": "string | number",
"options": [
"action",
"input",
"choice",
"filter"
],
"description": "Chips type."
},
"ui-chips/model-value": {
"type": "string | number | array",
"description": "Single or multiple selection from a set of options."
},
"ui-chips/options": {
"type": "array",
"description": "An array of options to show to the user. Applicable only for choice or filter chips."
},
"ui-chips/options-format": {
"type": "object",
"description": "Defines the option data format."
},
"ui-chips/items": {
"type": "array",
"description": "A set of chips. Applicable only for updating the input chips."
},
"ui-chip/icon": {
"type": "string",
"description": "Indicates an leading icon element."
},
"ui-chip/selected": {
"type": "boolean",
"description": "Hides the leading icon in a filter chip when the chip is selected."
},
"ui-chip/deletable": {
"type": "boolean",
"description": "Indicates a trailing icon which removes the chip from the DOM. Only use with input chips."
},
"ui-file/input-id": {
"type": "string",
"description": "The id attribute of the <input> and the for attribute of the <label>."
},
"ui-file/accept": {
"type": "string",
"description": "File types that can be accepted."
},
"ui-file/multiple": {
"type": "boolean",
"description": "Whether to support selected multiple file."
},
"ui-file/disabled": {
"type": "boolean",
"description": "To disable a upload button."
},
"ui-file/outlined": {
"type": "boolean",
"description": "Styles an outlined upload button that is flush with the surface."
},
"ui-file/text": {
"type": "string",
"description": "Text for the default upload button."
},
"ui-file/preview": {
"type": "boolean",
"description": "Enabled preview file data."
},
"ui-datepicker/outlined": {
"type": "boolean",
"description": "Styles the datepicker as an outlined text field. (label or placeholder required)"
},
"ui-datepicker/model-value": {
"type": "string | number | array",
"description": "Sets the datepicker value."
},
"ui-datepicker/input-id": {
"type": "string",
"description": "The id attribute of the <input> and the for attribute of the <label>."
},
"ui-datepicker/label": {
"type": "string",
"description": "A text caption or description for the datepicker, which use the input's `placeholder` attribute instead."
},
"ui-datepicker/placeholder": {
"type": "string",
"description": "The placeholder attribute of the <input>."
},
"ui-datepicker/disabled": {
"type": "boolean",
"description": "Styles the datepicker as a disabled text field."
},
"ui-datepicker/required": {
"type": "boolean",
"description": "Styles the datepicker as a required text field."
},
"ui-datepicker/fullwidth": {
"type": "boolean",
"description": "Styles the datepicker as a full width text field."
},
"ui-datepicker/end-aligned": {
"type": "boolean",
"description": "Styles the datepicker with an end-aligned input."
},
"ui-datepicker/icon": {
"type": "string",
"description": "Indicates an icon element with a leading icon."
},
"ui-datepicker/with-leading-icon": {
"type": "boolean",
"description": "Styles the datepicker as a text field with a leading icon. (Use with `before` slot)"
},
"ui-datepicker/with-trailing-icon": {
"type": "boolean",
"description": "Styles the datepicker as a text field with a trailing icon. (Use with `after` slot)"
},
"ui-datepicker/config": {
"type": "object",
"description": "Flatpickr configuration."
},
"ui-datepicker/toggle": {
"type": "boolean",
"description": "Show calendar icon button."
},
"ui-datepicker/clear": {
"type": "boolean",
"description": "Show clear icon button."
},
"ui-datepicker/month-options": {
"type": "object",
"description": "Flatpickr month select options."
},
"ui-rangepicker/outlined": {
"type": "boolean",
"description": "Styles the rangepicker as an outlined text field. (labels or placeholders required)"
},
"ui-rangepicker/model-value": {
"type": "array",
"description": "Sets the rangepicker value."
},
"ui-rangepicker/labels": {
"type": "array",
"description": "A text caption or description for the rangepicker, which use the start and end input's `placeholder` attribute instead."
},
"ui-rangepicker/placeholders": {
"type": "array",
"description": "The placeholder attribute of the start and end <input>."
},
"ui-rangepicker/disabled": {
"type": "boolean",
"description": "Styles the rangepicker as a disabled text field."
},
"ui-rangepicker/config": {
"type": "object",
"description": "Flatpickr configuration."
},
"ui-rangepicker/disable-range-plugin": {
"type": "boolean",
"description": "Disables the flatpickr rangePlugin and use two `<ui-datepicker>` instead."
},
"ui-switch/model-value": {
"type": "boolean",
"description": "Sets the switch value."
},
"ui-switch/true-value": {
"type": "boolean | number | string",
"description": "Switch true value."
},
"ui-switch/false-value": {
"type": "boolean | number | string",
"description": "Switch false value."
},
"ui-switch/disabled": {
"type": "boolean",
"description": "Styles the switch as a disabled switch."
},
"ui-slider/type": {
"type": "string | number",
"options": [
"continuous",
"discrete"
],
"description": "Slider type."
},
"ui-slider/discrete": {
"type": "boolean",
"description": "Styles the slider as a discrete slider."
},
"ui-slider/with-tick-marks": {
"type": "boolean",
"description": "Discrete sliders support display markers on their tracks."
},
"ui-slider/model-value": {
"type": "number | array",
"description": "The current value of the slider. (Array value for range slider)"
},
"ui-slider/min": {
"type": "number",
"description": "The minimum value a slider can have."
},
"ui-slider/max": {
"type": "number",
"description": "The maximum value a slider can have."
},
"ui-slider/step": {
"type": "number",
"description": "Specifies the increments at which a slider value can be set."
},
"ui-slider/disabled": {
"type": "boolean",
"description": "Whether or not the slider is disabled."
},
"ui-list/type": {
"type": "string | number",
"options": [
"singleLine",
"twoLine"
],
"description": "List type."
},
"ui-list/single-selection": {
"type": "boolean",
"description": "The list can handle selecting/deselecting list elements based on click or keyboard action."
},
"ui-list/model-value": {
"type": "number",
"description": "The index of the selected list item. Applicable only for the single selection list."
},
"ui-list/non-interactive": {
"type": "boolean",
"description": "Disables interactivity affordances."
},
"ui-list/dense": {
"type": "boolean",
"description": "Styles the density of the list, making it appear more compact."
},
"ui-list/avatar": {
"type": "boolean",
"description": "Configures the leading tiles of each row to display images instead of icons. This will make the graphics of the list items larger."
},
"ui-nav/type": {
"type": "string | number",
"options": [
"singleLine",
"twoLine"
],
"description": "List type."
},
"ui-nav/non-interactive": {
"type": "boolean",
"description": "Disables interactivity affordances."
},
"ui-nav/dense": {
"type": "boolean",
"description": "Styles the density of the list, making it appear more compact."
},
"ui-nav/avatar": {
"type": "boolean",
"description": "Configures the leading tiles of each row to display images instead of icons. This will make the graphics of the list items larger."
},
"ui-item/selected": {
"type": "boolean",
"description": "Styles the row in an selected state."
},
"ui-item/disabled": {
"type": "boolean",
"description": "Styles the row in an disabled state."
},
"ui-nav-item/href": {
"type": "string",
"description": "Resolved url. This would be the `href` attribute of an `a` element."
},
"ui-nav-item/active": {
"type": "boolean",
"description": "Styles the row in an activated state."
},
"ui-list-divider/padded": {
"type": "boolean",
"description": "Leaves gaps on each side of divider to match padding of the last tile."
},
"ui-list-divider/inset": {
"type": "boolean",
"description": "Increases the leading margin of the divider so that it does not intersect the avatar column."
},
"ui-item-divider/padded": {
"type": "boolean",
"description": "Leaves gaps on each side of divider to match padding of the last tile."
},
"ui-item-divider/inset": {
"type": "boolean",
"description": "Increases the leading margin of the divider so that it does not intersect the avatar column."
},
"ui-image-list/type": {
"type": "string | number",
"options": [
"standard",
"masonry"
],
"description": "Image list type."
},
"ui-image-list/masonry": {
"type": "boolean",
"description": "Indicates that this Image List should use the Masonry variant."
},
"ui-image-list/text-protection": {
"type": "boolean",
"description": "Indicates that supporting content should be positioned in a scrim overlaying each image (instead of positioned separately under each image)."
},
"ui-image-item/image": {
"type": "string",
"description": "Add the `src` attribute directly to the <img> in the image container."
},
"ui-image-item/bg-image": {
"type": "string",
"description": "Use a <div> instead of <img> element."
},
"ui-card/outlined": {
"type": "boolean",
"description": "Removes the shadow and displays a hairline outline instead."
},
"ui-card-media/square": {
"type": "boolean",
"description": "Automatically scales the media area's height to equal its width."
},
"ui-card-media/rectangle": {
"type": "boolean",
"description": "Automatically scales the media area's height according to its width, maintaining a 16:9 aspect ratio."
},
"ui-card-actions/full-bleed": {
"type": "boolean",
"description": "Removes the action area's padding and causes its only child (a `mdc-card__action` element) to consume 100% of the action area's width"
},
"ui-table/data": {
"type": "array",
"description": "Data source."
},
"ui-table/model-value": {
"type": "array",
"description": "Selected row indexes/ids. (Required: `rowCheckbox: true`)"
},
"ui-table/thead": {
"type": "array",
"description": "Table header renderer."
},
"ui-table/tbody": {
"type": "array",
"description": "Table content renderer."
},
"ui-table/tfoot": {
"type": "array",
"description": "Table footer renderer."
},
"ui-table/fullwidth": {
"type": "boolean",
"description": "Styles the table as a full width table."
},
"ui-table/row-checkbox": {
"type": "boolean",
"description": "Data table with row selection."
},
"ui-table/row-checkbox-disabled": {
"type": "boolean",
"description": "Data table with row selection."
},
"ui-table/selected-key": {
"type": "string | false",
"description": "The `model-value` use custom key field, default use row index."
},
"ui-table/row-id-prefix": {
"type": "string",
"description": "The prefix of `data-row-id` attribute value on row element `tr`."
},
"ui-table/sort-icon-align-end": {
"type": "boolean",
"description": "The sort icon will be positioned after the label."
},
"ui-table/show-progress": {
"type": "boolean",
"description": "Styles the table with progress indicator for data loading."
},
"ui-table/fixed-header": {
"type": "boolean",
"description": "Styles the table as a fixed header."
},
"ui-table/default-col-width": {
"type": "number",
"description": "Set the default column width for the fixed table."
},
"ui-table/scroll": {
"type": "object",
"description": "Set the table container size for the fixed table."
},
"ui-collapse/model-value": {
"type": "boolean",
"description": "Default expanded state."
},
"ui-collapse/with-icon": {
"type": "boolean",
"description": "Default icons."
},
"ui-collapse/icon-end-aligned": {
"type": "boolean",
"description": "Styles icon end aligned."
},
"ui-collapse/ripple": {
"type": "boolean | number",
"description": "Sets the ripple color."
},
"ui-badge/count": {
"type": "number",
"description": "Number to show in badge."
},
"ui-badge/overlap": {
"type": "boolean",
"description": "Make the badge overlap with its container."
},
"ui-badge/max-count": {
"type": "number",
"description": "Max count to show."
},
"ui-badge/dot": {
"type": "boolean",
"description": "Whether to display a dot instead of `count`."
},
"ui-badge/state": {
"type": "string",
"options": [
"success",
"info",
"warning",
"error",
"help"
],
"description": "State type for text badge."
},
"ui-alert/state": {
"type": "string",
"options": [
"success",
"info",
"warning",
"error",
"help"
],
"description": "State type."
},
"ui-alert/state-outlined": {
"type": "boolean",
"description": "Show outlined state."
},
"ui-alert/closable": {
"type": "boolean",
"description": "Whether alert can be closed."
},
"ui-dialog/model-value": {
"type": "boolean",
"description": "Sets the dialog state."
},
"ui-dialog/escape-key": {
"type": "boolean",
"description": "Sets the action reflected when the Escape key is pressed. Setting to `false` disables closing the dialog via Escape key."
},
"ui-dialog/closable": {
"type": "boolean",
"description": "Closes the dialog, when a user actions on the accept or cancel button."
},
"ui-dialog/mask-closable": {
"type": "boolean",
"description": "Closes the dialog, when the dialog scrim is clicked."
},
"ui-dialog/no-scrim": {
"type": "boolean",
"description": "Hides the dialog scrim."
},
"ui-dialog/reset-scroll": {
"type": "boolean",
"description": "Reset scroll bar, when the dialog is closed."
},
"ui-dialog/fullscreen": {
"type": "boolean",
"description": "Styles a full-screen dialog for mobile/small-screen devices."
},
"ui-dialog/sheet": {
"type": "boolean",
"description": "Styles a floating sheet dialog."
},
"ui-dialog/no-content-padding": {
"type": "boolean",
"description": "Styles a no default padding dialog content."
},
"ui-dialog-title/closable": {
"type": "boolean",
"description": "Displays close icon button."
},
"ui-dialog-actions/accept-text": {
"type": "string",
"description": "The accept button text."
},
"ui-dialog-actions/cancel-text": {
"type": "string",
"description": "The cancel button text."
},
"ui-snackbar/action-type": {
"type": "number",
"description": "Sets action button or dismiss icon for the snackbar. (0: action button, 1: dismiss icon)"
},
"ui-snackbar/model-value": {
"type": "boolean",
"description": "Sets the snackbar state."
},
"ui-snackbar/timeout-ms": {
"type": "number",
"description": "The automatic dismiss timeout in milliseconds. Value must be between 4000 and 10000 (or -1 to disable the timeout completely)."
},
"ui-snackbar/message": {
"type": "string",
"description": "Message text."
},
"ui-snackbar/action-button-text": {
"type": "string",
"description": "The action button/icon elements, if present."
},
"ui-snackbar/stacked": {
"type": "boolean",
"description": "Positions the action button/icon below the message instead of alongside it."
},
"ui-snackbar/leading": {
"type": "boolean",
"description": "Positions the snackbar on the leading edge of the screen (left in LTR, right in RTL) instead of centered. (tablet and desktop only)"
},
"ui-snackbar/position": {
"type": "string",
"options": [
"bottom",
"center",
"top"
],
"description": "Snackbar position."
},
"ui-banner/model-value": {
"type": "boolean",
"description": "Sets the banner state."
},
"ui-banner/centered": {
"type": "boolean",
"description": "Displayed centered. By default, banners are positioned as leading."
},
"ui-banner/fixed": {
"type": "boolean",
"description": "When used below top app bars, banners should remain fixed at the top of the screen."
},
"ui-banner/with-image": {
"type": "boolean",
"description": "Images can help communicate a banner’s message."
},
"ui-banner/mobile-stacked": {
"type": "boolean",
"description": "On mobile view, banners with long text should have their action(s) be positioned below the text instead of alongside it."
},
"ui-banner/primary-button-text": {
"type": "boolean",
"description": "The primary action text."
},
"ui-banner/secondary-button-text": {
"type": "boolean",
"description": "The secondary action text."
},
"ui-progress/active": {
"type": "boolean",
"description": "Puts the linear progress indicator in an indeterminate state."
},
"ui-progress/progress": {
"type": "number",
"description": "Sets the progress bar to this value. Value should be between [0, 1]."
},
"ui-progress/buffer": {
"type": "number",
"description": "Sets the buffer bar to this value. Value should be between [0, 1]."
},
"ui-progress/label": {
"type": "string",
"description": "Label indicating how the progress bar should be announced to the user."
},
"ui-progress/closed": {
"type": "boolean",
"description": "Hides the linear progress indicator."
},
"ui-spinner/active": {
"type": "boolean",
"description": "Puts the circular progress indicator in an indeterminate state."
},
"ui-spinner/progress": {
"type": "number",
"description": "Sets the progress bar to this value. Value should be between [0, 1]."
},
"ui-spinner/size": {
"type": "string",
"options": [
"large",
"medium",
"small"
],
"description": "To set the circular progress size."
},
"ui-spinner/four-colored": {
"type": "boolean",
"description": "You may choose to have the indicator in inderminate state animate through 4 colors."
},
"ui-spinner/label": {
"type": "string",
"description": "Label indicating how the progress bar should be announced to the user."
},
"ui-spinner/closed": {
"type": "boolean",
"description": "Hides the circular progress indicator."
},
"ui-tooltip/type": {
"type": "string | number",
"options": [
"plain",
"rich"
],
"description": "Tooltip type."
},
"ui-tooltip/rich": {
"type": "boolean",
"description": "Styles a rich tooltip."
},
"ui-tooltip/width": {
"type": "number",
"description": "Custom max width for tooltip."
},
"ui-editor/model-value": {
"type": "string",
"description": "Sets the editor value."
},
"ui-editor/options": {
"type": "object",
"description": "Quill options."
},
"ui-editor/toolbar": {
"type": "array | string",
"description": "Custom or 'full' editor toolbar."
},
"ui-editor/placeholder": {
"type": "string",
"description": "Placeholder text to show when editor is empty."
},
"ui-editor/readonly": {
"type": "boolean",
"description": "Whether to instantiate the editor to read-only mode."
},
"ui-editor/fullwidth": {
"type": "boolean",
"description": "Styles the editor as a full width editor."
},
"ui-editor/theme": {
"type": "string",
"options": [
"bubble",
"snow"
],
"description": "Name of theme to use."
},
"ui-editor/toolbar-icons": {
"type": "object",
"description": "Custom toolbar icons."
},
"ui-editor/toolbar-tips": {
"type": "object",
"description": "Custom toolbar tooltips."
},
"ui-editor/toolbar-options": {
"type": "object",
"description": "Custom toolbar options of the Font Famliy, Font Size and Line Height."
},
"ui-editor/toolbar-handlers": {
"type": "object",
"description": "Custom toolbar handlers."
},
"ui-editor/custom-image-handler": {
"type": "boolean",
"description": "Enable custom image handler."
},
"ui-editor/emotions": {
"type": "array",
"description": "The emoticon extension. Supports emoji and image."
},
"ui-editor/with-counter": {
"type": "boolean",
"description": "Styles the editor with an internal character counter."
},
"ui-editor/extension": {
"type": "object | false",
"description": "Custom extension for Quill."
},
"ui-tree/model-value": {
"type": "string | array",
"description": "Selected node keys."
},
"ui-tree/filter-parent-node": {
"type": "boolean",
"description": "Selected node keys excludes all parent nodes."
},
"ui-tree/data": {
"type": "array",
"description": "The tree data source."
},
"ui-tree/data-format": {
"type": "object",
"description": "Defines the tree data source format."
},
"ui-tree/max-level": {
"type": "number",
"description": "Set max level for tree nodes."
},
"ui-tree/multiple": {
"type": "boolean",
"description": "Whether to support selected multiple tree nodes."
},
"ui-tree/single-checked": {
"type": "boolean",
"description": "Set single checked. Applicable only for the multiple tree."
},
"ui-tree/load-data": {
"type": "function",
"description": "Load data asynchronously."
},
"ui-tree/auto-expand-parent": {
"type": "boolean",
"description": "Whether to automatically expand root parent(s) treeNode."
},
"ui-tree/auto-expand-selected": {
"type": "boolean",
"description": "Whether to automatically expand selected treeNode and it's parent treeNode."
},
"ui-tree/auto-expand-all": {
"type": "boolean",
"description": "Whether to automatically expand all treeNodes."
},
"ui-tree/default-expanded-keys": {
"type": "array",
"description": "Specify the node keys of the default expanded treeNodes."
},
"ui-skeleton/loading": {
"type": "boolean",
"description": "Display the skeleton."
},
"ui-skeleton/active": {
"type": "boolean",
"description": "Show animation effect."
},
"ui-skeleton/avatar": {
"type": "boolean | object",
"description": "Show avatar placeholder."
},
"ui-skeleton/title": {
"type": "boolean | object",
"description": "Show title placeholder."
},
"ui-skeleton/paragraph": {
"type