@3mo/command-palette
Version:
Command-palettes are a common way to provide users with a list of actions they can perform in a given context.
514 lines • 11.1 kB
JSON
{
"version": "experimental",
"tags": [
{
"name": "eb-command-palette",
"path": ".\\packages\\CommandPalette\\CommandPalette.ts",
"properties": [
{
"name": "dataSource",
"type": "() => <T>(Constructor: Constructor<CommandPaletteDataSource<T>>) => void",
"default": "\"() => {\\n\\t\\treturn <T>(Constructor: Constructor<CommandPaletteDataSource<T>>) => {\\n\\t\\t\\tCommandPalette.dataSources.add(new Constructor())\\n\\t\\t}\\n\\t}\""
},
{
"name": "popover",
"type": "string",
"default": "\"auto\""
},
{
"name": "keyword",
"type": "string",
"default": "\"\""
},
{
"name": "filteredDataSourceId",
"type": "string | undefined"
},
{
"name": "dataSources",
"type": "Set<CommandPaletteDataSource<any>>",
"default": "\"new Set<CommandPaletteDataSource<any>>()\""
}
]
},
{
"name": "mo-command-palette-button",
"path": ".\\packages\\CommandPalette\\CommandPaletteButton.ts"
},
{
"name": "mo-command-palette-search-field",
"path": ".\\packages\\CommandPalette\\CommandPaletteSearchField.ts",
"attributes": [
{
"name": "fetching",
"type": "boolean",
"default": "false"
},
{
"name": "minLength",
"type": "number | undefined"
},
{
"name": "maxLength",
"type": "number | undefined"
},
{
"name": "pattern",
"type": "string | undefined"
},
{
"name": "autoComplete",
"type": "FieldTextAutoComplete | undefined"
},
{
"name": "selectOnFocus",
"description": "Selects the input text when the field receives focus.",
"type": "boolean",
"default": "false"
},
{
"name": "dense",
"description": "Whether the field is dense",
"type": "boolean",
"default": "false"
},
{
"name": "value",
"description": "The field's value",
"type": "string | undefined"
},
{
"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": "fetching",
"attribute": "fetching",
"type": "boolean",
"default": "false"
},
{
"name": "inputType",
"type": "string"
},
{
"name": "minLength",
"attribute": "minLength",
"type": "number | undefined"
},
{
"name": "maxLength",
"attribute": "maxLength",
"type": "number | undefined"
},
{
"name": "pattern",
"attribute": "pattern",
"type": "string | undefined"
},
{
"name": "autoComplete",
"attribute": "autoComplete",
"type": "FieldTextAutoComplete | undefined"
},
{
"name": "inputElement",
"type": "HTMLInputElement"
},
{
"name": "selectOnFocus",
"attribute": "selectOnFocus",
"description": "Selects the input text when the field receives focus.",
"type": "boolean",
"default": "false"
},
{
"name": "dense",
"attribute": "dense",
"description": "Whether the field is dense",
"type": "boolean",
"default": "false"
},
{
"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 field's value",
"type": "string | undefined"
},
{
"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": "validityChange",
"type": "CustomEvent<boolean>"
}
],
"slots": [
{
"name": "",
"description": "The field's content"
},
{
"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": "container",
"description": "Field's container"
}
]
},
{
"name": "mo-keyboard-key",
"path": ".\\packages\\CommandPalette\\KeyboardKey.ts",
"attributes": [
{
"name": "key",
"type": "string"
},
{
"name": "splitter",
"type": "string | undefined"
}
],
"properties": [
{
"name": "key",
"attribute": "key",
"type": "string"
},
{
"name": "splitter",
"attribute": "splitter",
"type": "string | undefined"
}
]
},
{
"name": "eb-command-palette",
"path": ".\\packages\\CommandPalette\\dist\\CommandPalette.d.ts",
"properties": [
{
"name": "dataSource",
"type": "() => <T>(Constructor: Constructor<CommandPaletteDataSource<T>>) => void"
},
{
"name": "popover",
"type": "string"
},
{
"name": "keyword",
"type": "string"
},
{
"name": "filteredDataSourceId",
"type": "string | undefined"
},
{
"name": "dataSources",
"type": "Set<CommandPaletteDataSource<any>>"
}
]
},
{
"name": "mo-command-palette-button",
"path": ".\\packages\\CommandPalette\\dist\\CommandPaletteButton.d.ts"
},
{
"name": "mo-command-palette-search-field",
"path": ".\\packages\\CommandPalette\\dist\\CommandPaletteSearchField.d.ts",
"attributes": [
{
"name": "minLength",
"type": "number | undefined"
},
{
"name": "maxLength",
"type": "number | undefined"
},
{
"name": "pattern",
"type": "string | undefined"
},
{
"name": "autoComplete",
"type": "FieldTextAutoComplete | undefined"
},
{
"name": "selectOnFocus",
"description": "Selects the input text when the field receives focus.",
"type": "boolean",
"default": "false"
},
{
"name": "dense",
"description": "Whether the field is dense",
"type": "boolean",
"default": "false"
},
{
"name": "value",
"description": "The field's value",
"type": "string | undefined"
},
{
"name": "label",
"description": "The field's label",
"type": "string",
"default": "\"t('Search')\""
},
{
"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": "fetching",
"type": "boolean"
},
{
"name": "inputType",
"type": "string"
},
{
"name": "minLength",
"attribute": "minLength",
"type": "number | undefined"
},
{
"name": "maxLength",
"attribute": "maxLength",
"type": "number | undefined"
},
{
"name": "pattern",
"attribute": "pattern",
"type": "string | undefined"
},
{
"name": "autoComplete",
"attribute": "autoComplete",
"type": "FieldTextAutoComplete | undefined"
},
{
"name": "inputElement",
"type": "HTMLInputElement"
},
{
"name": "selectOnFocus",
"attribute": "selectOnFocus",
"description": "Selects the input text when the field receives focus.",
"type": "boolean",
"default": "false"
},
{
"name": "dense",
"attribute": "dense",
"description": "Whether the field is dense",
"type": "boolean",
"default": "false"
},
{
"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 field's value",
"type": "string | undefined"
},
{
"name": "label",
"attribute": "label",
"description": "The field's label",
"type": "string",
"default": "\"t('Search')\""
},
{
"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": "validityChange",
"type": "CustomEvent<boolean>"
}
],
"slots": [
{
"name": "",
"description": "The field's content"
},
{
"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": "container",
"description": "Field's container"
}
]
},
{
"name": "mo-keyboard-key",
"path": ".\\packages\\CommandPalette\\dist\\KeyboardKey.d.ts",
"properties": [
{
"name": "key",
"type": "string"
},
{
"name": "splitter",
"type": "string | undefined"
}
]
}
]
}