UNPKG

@3mo/select-field

Version:

A select field web component

833 lines 18.1 kB
{ "version": "experimental", "tags": [ { "name": "mo-field-select", "path": ".\\packages\\SelectField\\FieldSelect.ts", "attributes": [ { "name": "dense", "type": "boolean", "default": "false" }, { "name": "open", "type": "boolean", "default": "false" }, { "name": "default", "description": "The default value.", "type": "string | undefined" }, { "name": "reflectDefault", "description": "Whether the default value should be reflected to the attribute.", "type": "boolean", "default": "false" }, { "name": "multiple", "description": "Whether multiple options can be selected.", "type": "boolean", "default": "false" }, { "name": "searchable", "description": "Whether the options should be searchable.", "type": "boolean", "default": "false" }, { "name": "freeInput", "description": "Whether the user can input values that are not in the options.", "type": "boolean", "default": "false" }, { "name": "index", "description": "The selected index.", "type": "Index" }, { "name": "data", "description": "The selected data.", "type": "Data<T>" }, { "name": "menuAlignment", "description": "Menu popover alignment", "type": "PopoverAlignment | undefined" }, { "name": "menuPlacement", "description": "Menu popover placement", "type": "PopoverPlacement | undefined" }, { "name": "value", "description": "The selected value.", "type": "Value" }, { "name": "label", "description": "The field's label", "type": "string", "default": "\"\"" }, { "name": "readonly", "description": "Whether the field is readonly", "type": "boolean", "default": "false" }, { "name": "disabled", "description": "Whether the field is disabled", "type": "boolean", "default": "false" }, { "name": "required", "description": "Whether the field is required", "type": "boolean", "default": "false" } ], "properties": [ { "name": "dataChange", "type": "EventDispatcher<Data<T>>" }, { "name": "indexChange", "type": "EventDispatcher<Index>" }, { "name": "dense", "attribute": "dense", "type": "boolean", "default": "false" }, { "name": "open", "attribute": "open", "type": "boolean", "default": "false" }, { "name": "valueInputElement", "type": "HTMLInputElement" }, { "name": "searchInputElement", "type": "HTMLInputElement | undefined" }, { "name": "menu", "type": "Menu | undefined" }, { "name": "listItems", "type": "ListItem[]" }, { "name": "options", "type": "Option<T>[]" }, { "name": "selectedOptions", "type": "Option<T>[]" }, { "name": "default", "attribute": "default", "description": "The default value.", "type": "string | undefined" }, { "name": "reflectDefault", "attribute": "reflectDefault", "description": "Whether the default value should be reflected to the attribute.", "type": "boolean", "default": "false" }, { "name": "multiple", "attribute": "multiple", "description": "Whether multiple options can be selected.", "type": "boolean", "default": "false" }, { "name": "searchable", "attribute": "searchable", "description": "Whether the options should be searchable.", "type": "boolean", "default": "false" }, { "name": "freeInput", "attribute": "freeInput", "description": "Whether the user can input values that are not in the options.", "type": "boolean", "default": "false" }, { "name": "index", "attribute": "index", "description": "The selected index.", "type": "Index" }, { "name": "data", "attribute": "data", "description": "The selected data.", "type": "Data<T>" }, { "name": "menuAlignment", "attribute": "menuAlignment", "description": "Menu popover alignment", "type": "PopoverAlignment | undefined" }, { "name": "menuPlacement", "attribute": "menuPlacement", "description": "Menu popover placement", "type": "PopoverPlacement | undefined" }, { "name": "change", "type": "EventDispatcher<T | undefined>" }, { "name": "input", "type": "EventDispatcher<T | undefined>" }, { "name": "validityChange", "type": "EventDispatcher<boolean>" }, { "name": "isPopulated", "type": "boolean" }, { "name": "value", "attribute": "value", "description": "The selected value.", "type": "Value" }, { "name": "label", "attribute": "label", "description": "The field's label", "type": "string", "default": "\"\"" }, { "name": "readonly", "attribute": "readonly", "description": "Whether the field is readonly", "type": "boolean", "default": "false" }, { "name": "disabled", "attribute": "disabled", "description": "Whether the field is disabled", "type": "boolean", "default": "false" }, { "name": "required", "attribute": "required", "description": "Whether the field is required", "type": "boolean", "default": "false" } ], "events": [ { "name": "change", "type": "CustomEvent<T | undefined>" }, { "name": "input", "type": "CustomEvent<T | undefined>" }, { "name": "dataChange", "type": "CustomEvent<Data<T>>" }, { "name": "indexChange", "type": "CustomEvent<Index>" }, { "name": "validityChange", "type": "CustomEvent<boolean>" } ], "slots": [ { "name": "", "description": "The select options." }, { "name": "start", "description": "Content to be placed at the start of the field" }, { "name": "end", "description": "Content to be placed at the end of the field" } ], "cssParts": [ { "name": "input", "description": "The input element." }, { "name": "dropDownIcon", "description": "The dropdown icon." }, { "name": "menu", "description": "The menu consisting of list of options." }, { "name": "list", "description": "The list of options." }, { "name": "container", "description": "Field's container" } ] }, { "name": "mo-option", "path": ".\\packages\\SelectField\\Option.ts", "attributes": [ { "name": "index", "type": "number | undefined" }, { "name": "value", "type": "string | undefined" }, { "name": "data", "type": "T | undefined" }, { "name": "multiple", "type": "boolean", "default": "false" }, { "name": "inputText", "type": "string | undefined" }, { "name": "selected", "type": "boolean", "default": "false" }, { "name": "disabled", "description": "Whether the list item is disabled", "type": "boolean", "default": "false" }, { "name": "icon", "description": "Icon to be displayed in the list item", "type": "MaterialIcon | undefined" }, { "name": "preventClickOnSpace", "description": "Whether the list item should prevent click on space", "type": "true", "default": "true" } ], "properties": [ { "name": "requestSelectValueUpdate", "type": "EventDispatcher<void>" }, { "name": "index", "attribute": "index", "type": "number | undefined" }, { "name": "value", "attribute": "value", "type": "string | undefined" }, { "name": "data", "attribute": "data", "type": "T | undefined" }, { "name": "multiple", "attribute": "multiple", "type": "boolean", "default": "false" }, { "name": "inputText", "attribute": "inputText", "type": "string | undefined" }, { "name": "normalizedValue", "type": "string | number | undefined" }, { "name": "text", "type": "string" }, { "name": "change", "type": "SelectionListItemEventDispatcher<T>", "default": "\"new SelectionListItemEventDispatcher(this)\"" }, { "name": "selected", "attribute": "selected", "type": "boolean", "default": "false" }, { "name": "role", "type": "\"option\"", "default": "\"option\"" }, { "name": "tabIndex", "type": "number", "default": "0" }, { "name": "disabled", "attribute": "disabled", "description": "Whether the list item is disabled", "type": "boolean", "default": "false" }, { "name": "icon", "attribute": "icon", "description": "Icon to be displayed in the list item", "type": "MaterialIcon | undefined" }, { "name": "preventClickOnSpace", "attribute": "preventClickOnSpace", "description": "Whether the list item should prevent click on space", "type": "true", "default": "true" } ], "slots": [ { "name": "", "description": "Default slot for content" } ] }, { "name": "mo-field-select", "path": ".\\packages\\SelectField\\dist\\FieldSelect.d.ts", "attributes": [ { "name": "default", "description": "The default value.", "type": "string | undefined" }, { "name": "reflectDefault", "description": "Whether the default value should be reflected to the attribute.", "type": "boolean" }, { "name": "multiple", "description": "Whether multiple options can be selected.", "type": "boolean" }, { "name": "searchable", "description": "Whether the options should be searchable.", "type": "boolean" }, { "name": "freeInput", "description": "Whether the user can input values that are not in the options.", "type": "boolean" }, { "name": "index", "description": "The selected index.", "type": "Index" }, { "name": "data", "description": "The selected data.", "type": "Data<T>" }, { "name": "menuAlignment", "description": "Menu popover alignment", "type": "PopoverAlignment | undefined" }, { "name": "menuPlacement", "description": "Menu popover placement", "type": "PopoverPlacement | undefined" }, { "name": "value", "description": "The selected value.", "type": "Value" }, { "name": "label", "description": "The field's label", "type": "string", "default": "\"\"" }, { "name": "readonly", "description": "Whether the field is readonly", "type": "boolean", "default": "false" }, { "name": "disabled", "description": "Whether the field is disabled", "type": "boolean", "default": "false" }, { "name": "required", "description": "Whether the field is required", "type": "boolean", "default": "false" } ], "properties": [ { "name": "dataChange", "type": "EventDispatcher<Data<T>>" }, { "name": "indexChange", "type": "EventDispatcher<Index>" }, { "name": "dense", "type": "boolean" }, { "name": "open", "type": "boolean" }, { "name": "valueInputElement", "type": "HTMLInputElement" }, { "name": "searchInputElement", "type": "HTMLInputElement | undefined" }, { "name": "menu", "type": "Menu | undefined" }, { "name": "listItems", "type": "ListItem[]" }, { "name": "options", "type": "Option<T>[]" }, { "name": "selectedOptions", "type": "Option<T>[]" }, { "name": "default", "attribute": "default", "description": "The default value.", "type": "string | undefined" }, { "name": "reflectDefault", "attribute": "reflectDefault", "description": "Whether the default value should be reflected to the attribute.", "type": "boolean" }, { "name": "multiple", "attribute": "multiple", "description": "Whether multiple options can be selected.", "type": "boolean" }, { "name": "searchable", "attribute": "searchable", "description": "Whether the options should be searchable.", "type": "boolean" }, { "name": "freeInput", "attribute": "freeInput", "description": "Whether the user can input values that are not in the options.", "type": "boolean" }, { "name": "index", "attribute": "index", "description": "The selected index.", "type": "Index" }, { "name": "data", "attribute": "data", "description": "The selected data.", "type": "Data<T>" }, { "name": "menuAlignment", "attribute": "menuAlignment", "description": "Menu popover alignment", "type": "PopoverAlignment | undefined" }, { "name": "menuPlacement", "attribute": "menuPlacement", "description": "Menu popover placement", "type": "PopoverPlacement | undefined" }, { "name": "change", "type": "EventDispatcher<T | undefined>" }, { "name": "input", "type": "EventDispatcher<T | undefined>" }, { "name": "validityChange", "type": "EventDispatcher<boolean>" }, { "name": "isPopulated", "type": "boolean" }, { "name": "value", "attribute": "value", "description": "The selected value.", "type": "Value" }, { "name": "label", "attribute": "label", "description": "The field's label", "type": "string", "default": "\"\"" }, { "name": "readonly", "attribute": "readonly", "description": "Whether the field is readonly", "type": "boolean", "default": "false" }, { "name": "disabled", "attribute": "disabled", "description": "Whether the field is disabled", "type": "boolean", "default": "false" }, { "name": "required", "attribute": "required", "description": "Whether the field is required", "type": "boolean", "default": "false" } ], "events": [ { "name": "change", "type": "CustomEvent<T | undefined>" }, { "name": "input", "type": "CustomEvent<T | undefined>" }, { "name": "dataChange", "type": "CustomEvent<Data<T>>" }, { "name": "indexChange", "type": "CustomEvent<Index>" }, { "name": "validityChange", "type": "CustomEvent<boolean>" } ], "slots": [ { "name": "", "description": "The select options." }, { "name": "start", "description": "Content to be placed at the start of the field" }, { "name": "end", "description": "Content to be placed at the end of the field" } ], "cssParts": [ { "name": "input", "description": "The input element." }, { "name": "dropDownIcon", "description": "The dropdown icon." }, { "name": "menu", "description": "The menu consisting of list of options." }, { "name": "list", "description": "The list of options." }, { "name": "container", "description": "Field's container" } ] }, { "name": "mo-option", "path": ".\\packages\\SelectField\\dist\\Option.d.ts", "attributes": [ { "name": "disabled", "description": "Whether the list item is disabled", "type": "boolean", "default": "false" }, { "name": "icon", "description": "Icon to be displayed in the list item", "type": "MaterialIcon | undefined" }, { "name": "preventClickOnSpace", "description": "Whether the list item should prevent click on space", "type": "true", "default": "true" } ], "properties": [ { "name": "requestSelectValueUpdate", "type": "EventDispatcher<void>" }, { "name": "index", "type": "number | undefined" }, { "name": "value", "type": "string | undefined" }, { "name": "data", "type": "T | undefined" }, { "name": "multiple", "type": "boolean" }, { "name": "inputText", "type": "string | undefined" }, { "name": "normalizedValue", "type": "string | number | undefined" }, { "name": "text", "type": "string" }, { "name": "change", "type": "SelectionListItemEventDispatcher<T>", "default": "\"new SelectionListItemEventDispatcher(this)\"" }, { "name": "selected", "type": "boolean" }, { "name": "role", "type": "\"option\"", "default": "\"option\"" }, { "name": "tabIndex", "type": "number", "default": "0" }, { "name": "disabled", "attribute": "disabled", "description": "Whether the list item is disabled", "type": "boolean", "default": "false" }, { "name": "icon", "attribute": "icon", "description": "Icon to be displayed in the list item", "type": "MaterialIcon | undefined" }, { "name": "preventClickOnSpace", "attribute": "preventClickOnSpace", "description": "Whether the list item should prevent click on space", "type": "true", "default": "true" } ], "slots": [ { "name": "", "description": "Default slot for content" } ] } ] }