{ "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json", "framework": "vue", "name": "vuetify-admin", "version": "0.1.0", "contributions": { "html": { "types-syntax": "typescript", "description-markup": "markdown", "tags": [ { "name": "VaActionPage", "description": "Main CRUD action page layout used for Show, Create end Edit views components.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "title", "value": { "kind": "expression", "type": "string" }, "description": "Optional H1 title of the page shown on the left of top header" } ] }, { "name": "VaAppBar", "description": "Default customizable admin VAppBar.\nContains main app title, header menus, direct resource creation links, global refresh action, profile menu.\nProfile user dropdown will not appear on guest mode.", "attributes": [ { "name": "title", "value": { "kind": "expression", "type": "string" }, "description": "Replace default admin app title set on VuetifyAdmin constructor." }, { "name": "headerMenu", "value": { "kind": "expression", "type": "array" }, "description": "Header links visible on left side." }, { "name": "profileMenu", "value": { "kind": "expression", "type": "array" }, "description": "Profile related links, visible inside authenticated dropdown menu." }, { "name": "disableCreate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable create menu." }, { "name": "disableReload", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable reload state button." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Color for the VAppBar." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduce height of VAppBar" }, { "name": "dark", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Apply dark theme variant for VAppBar" } ] }, { "name": "VaAside", "description": "Customizable admin aside component where you put some contextualized additional information.\nUse the associated `VaAsideLayout` component for content integration from anywhere on any context.", "attributes": [ { "name": "width", "value": { "kind": "expression", "type": "number" }, "description": "Width of the aside" } ] }, { "name": "VaBreadcrumbs", "description": "Default admin component for breadcrumbs, will generate automatically hierarchical links from current route.\nSupport hierarchical CRUD structure.", "attributes": [] }, { "name": "VaFooter", "description": "Default customizable admin VFooter with possibility of corporate related links and infos.", "attributes": [ { "name": "menu", "value": { "kind": "expression", "type": "array" }, "description": "Menu links." } ] }, { "name": "VaLayout", "description": "Admin composable component layout with one slot for each region.", "attributes": [] }, { "name": "VaMessages", "description": "Internal VaMessages system for snackbar/toaster infos and confirm dialog.\nIntegrated with all resource modules for message API calls.\nWill automatically show `message` error property in case or API errors.\nAlready included in main admin layout, use it only if you need total custom layout.", "attributes": [] }, { "name": "VaSidebar", "description": "Default customizable admin VNavigationDrawer with full hierarchical menu and minimize variant.", "attributes": [ { "name": "menu", "value": { "kind": "expression", "type": "array" }, "description": "Main place for side menu, support hierarchical structure, MDI icons, heading and dividers." }, { "name": "miniVariant", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Minimize the sidebar and show only icons." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Main color of VNavigationDrawer." }, { "name": "dark", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Apply dark theme variant for VNavigationDrawer" }, { "name": "value", "value": { "kind": "expression", "type": "null" }, "description": "Control visibility" } ] }, { "name": "VaActionButton", "description": "Component tu use for any custom action button. Can be used on data table rows or top header of create, show and edit pages.", "attributes": [ { "name": "icon", "value": { "kind": "expression", "type": "string" }, "description": "Icon button, must be a valid MDI." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Label of button, shown as label next icon or as tooltip." }, { "name": "hideLabel", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Hide label next of icon. Will appear as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Color of button." }, { "name": "text", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Show as text without background." }, { "name": "type", "value": { "kind": "expression", "type": "string" }, "description": "Set the button's type attribute." }, { "name": "to", "value": { "kind": "expression", "type": "string|object" }, "description": "Vue route to redirect on click." }, { "name": "href", "value": { "kind": "expression", "type": "string|object" }, "description": "Turn button to anchor and use href." }, { "name": "target", "value": { "kind": "expression", "type": "string" }, "description": "Anchor target if href used." }, { "name": "loading", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Active a spinner if enabled." } ] }, { "name": "VaAssociateButton", "description": "Action button for resource association. Used on lists with association enabled.\nDumb component, just a submit button.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." } ] }, { "name": "VaBulkActionButton", "description": "Generic customizable button for update bulk actions in VaList component.\nShown after items selections. Use `updateMany` data provider method under the hood.", "attributes": [ { "name": "icon", "value": { "kind": "expression", "type": "string" }, "description": "Icon button, must be a valid MDI." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Label of button, shown as label next icon or as tooltip." }, { "name": "hideLabel", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Hide label next of icon. Will appear as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Color of button." }, { "name": "text", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Show as text without background." }, { "name": "value", "value": { "kind": "expression", "type": "array" }, "description": "Selected resources items." }, { "name": "action", "value": { "kind": "expression", "type": "object" }, "description": "Data object to send on `updateMany` data provider method.\nContains the resource properties to update." } ] }, { "name": "VaBulkDeleteButton", "description": "Button for delete bulk actions for VaList. Shown after items selections.\nKeep all VaDeleteButton feature and use `deleteMany` data provider method under the hood.", "attributes": [ { "name": "value", "value": { "kind": "expression", "type": "array" }, "description": "Selected resources items." } ] }, { "name": "VaCloneButton", "description": "Button for all clone resource action.\nRedirect to create page by default with target ID of original resource to clone.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." }, { "name": "disableRedirect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable default redirect behavior for compatible buttons\nForce button to be shown, prevent hiding it according to default behavior if no action exist." } ] }, { "name": "VaCreateButton", "description": "Button for all create resource action. Redirect to create page by default.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." }, { "name": "disableRedirect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable default redirect behavior for compatible buttons\nForce button to be shown, prevent hiding it according to default behavior if no action exist." } ] }, { "name": "VaDeleteButton", "description": "Button for all delete resource action. Comes with confirm dialog.\nAuto hide if no delete action available unless show prop is active.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." }, { "name": "redirect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Redirect to resource list after successful deletion.\nDefault redirect active if current page is resource being deleted." } ] }, { "name": "VaDissociateButton", "description": "Action button for resource dissociation. Used on data tables with association enabled.\nComes with confirm dialog.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "POST Request property name for update." }, { "name": "sourceId", "value": { "kind": "expression", "type": "number|string" }, "description": "Id of resource to unlink." }, { "name": "sourceResource", "value": { "kind": "expression", "type": "string" }, "description": "Name of resource to be unlinked." } ] }, { "name": "VaEditButton", "description": "Button for all edit resource action. Redirect to edit page by default.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." }, { "name": "disableRedirect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable default redirect behavior for compatible buttons\nForce button to be shown, prevent hiding it according to default behavior if no action exist." } ] }, { "name": "VaExportButton", "description": "Action button for export all data from a list iterator, aka VaList.\nUse current state of VaList, i.e. keep current filters and sorts while removing pagination limitation.\nWill provoke a download of a CSV file generated on client side thanks to papaparse library.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." }, { "name": "options", "value": { "kind": "expression", "type": "object" }, "description": "Current state of list, with mainly current sorting." }, { "name": "filter", "value": { "kind": "expression", "type": "object" }, "description": "Current filter state of the list." } ] }, { "name": "VaListButton", "description": "Button for all list resource action. Redirect to list page by default.\nShown on internal CRUD page at top header.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." } ] }, { "name": "VaLocaleButton", "description": "Locale button which allows resource translation.\nWill list all configured supported languages as dropdown menu.\nChange current locale on current resource store for contextualized fetching or saving on backend API.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." } ] }, { "name": "VaSaveButton", "description": "Default saving button that can be used for VaForm component.\nDumb component, just a submit button, VaForm do the real work.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." }, { "name": "text", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Remove background button." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label." }, { "name": "redirect", "value": { "kind": "expression", "type": "string" }, "description": "Default route resource action to redirect after saving.\nDisable the default submit behavior if set.\nFor specific redirect on submit, prefer `redirect` prop on `VaForm`" } ] }, { "name": "VaShowButton", "description": "Button for all show resource action. Redirect to show page by default.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Item attached to the button." }, { "name": "icon", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "If true, show button with icon only, label will be shown as tooltip." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Customizable background or text color, dependably of text prop value." }, { "name": "disableRedirect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable default redirect behavior for compatible buttons\nForce button to be shown, prevent hiding it according to default behavior if no action exist." } ] }, { "name": "VaArrayField", "description": "Show each single value of multiple array type value as material chip group.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "color", "value": { "kind": "expression", "type": "string|func" }, "description": "Color of chip, can be a function for dynamic color according to a certain value." }, { "name": "small", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Small chip." }, { "name": "to", "value": { "kind": "expression", "type": "string|object" }, "description": "Router link associated to chip if needed." }, { "name": "itemText", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Property used for stringify inner item if object.\nUse a function for further stringify customization." }, { "name": "select", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Use enum select field instead of simple text as value formatter." }, { "name": "column", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Show list of chips as column." } ] }, { "name": "VaBooleanField", "description": "Show value as identifiable true/false icon.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "labelTrue", "value": { "kind": "expression", "type": "string" }, "description": "True text for tooltip." }, { "name": "labelFalse", "value": { "kind": "expression", "type": "string" }, "description": "False text for tooltip." }, { "name": "iconTrue", "value": { "kind": "expression", "type": "string" }, "description": "Icon for true value. Must be a valid MDI." }, { "name": "iconFalse", "value": { "kind": "expression", "type": "string" }, "description": "Icon for false value. Must be a valid MDI." } ] }, { "name": "VaChipField", "description": "Show value inside a material chip.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "color", "value": { "kind": "expression", "type": "string|func" }, "description": "Color of chip, can be a function for dynamic color according to a certain value." }, { "name": "small", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Small chip." }, { "name": "to", "value": { "kind": "expression", "type": "string|object" }, "description": "Router link associated to chip if needed." } ] }, { "name": "VaDateField", "description": "Show value as formatted date. Support any localized format, long, short, etc.\nUse `$d` VueI18n function under the hood.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "format", "value": { "kind": "expression", "type": "string" }, "description": "Name of date format to use. Must be predefined on your VueI18n plugin." } ] }, { "name": "VaEmailField", "description": "Show value as `mailto` link.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." } ] }, { "name": "VaFileField", "description": "Show a list of file links that point to original files.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "src", "value": { "kind": "expression", "type": "string" }, "description": "Source property of file object, link through original file." }, { "name": "title", "value": { "kind": "expression", "type": "string" }, "description": "Title attribute of file object, used for title and alt attributes." }, { "name": "fileName", "value": { "kind": "expression", "type": "string" }, "description": "Filename property of file object, shown as anchor text for files." }, { "name": "target", "value": { "kind": "expression", "type": "string" }, "description": "Target value for anchor, default to external." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mainly use for VaFileInput, allow files or image to be removed." }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "Name of property sent to API which contains ids of file to delete." }, { "name": "itemValue", "value": { "kind": "expression", "type": "string" }, "description": "Attribute where taking the id value for identify files to delete." } ] }, { "name": "VaImageField", "description": "Show list of images as gallery with preview support for thumbnails.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "src", "value": { "kind": "expression", "type": "string" }, "description": "Source property of file object, link through original file." }, { "name": "title", "value": { "kind": "expression", "type": "string" }, "description": "Title attribute of file object, used for title and alt attributes." }, { "name": "fileName", "value": { "kind": "expression", "type": "string" }, "description": "Filename property of file object, shown as anchor text for files." }, { "name": "target", "value": { "kind": "expression", "type": "string" }, "description": "Target value for anchor, default to external." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mainly use for VaFileInput, allow files or image to be removed." }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "Name of property sent to API which contains ids of file to delete." }, { "name": "itemValue", "value": { "kind": "expression", "type": "string" }, "description": "Attribute where taking the id value for identify files to delete." }, { "name": "contain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Constraint image to full width instead of cover.\nIdeal for logos." }, { "name": "height", "value": { "kind": "expression", "type": "string" }, "description": "Max height of image." }, { "name": "lg", "value": { "kind": "expression", "type": "string|number" }, "description": "Max column width for image gallery." } ] }, { "name": "VaNumberField", "description": "Show value as formatted number. Can be any localized currency, decimal number, or percent value.\nUse `$n` VueI18n function under the hood.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "format", "value": { "kind": "expression", "type": "string" }, "description": "Name of number format to use. Must be predefined on your VueI18n plugin." } ] }, { "name": "VaRatingField", "description": "Show value as rating stars. Value should be a valid integer or decimal if half increments enabled.\nIcons can be edited via $ratingFull, $ratingEmpty and $ratingHalf on Vuetify settings.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Plain color for active ratings" }, { "name": "backgroundColor", "value": { "kind": "expression", "type": "string" }, "description": "Stroke color for empty ratings." }, { "name": "length", "value": { "kind": "expression", "type": "number|string" }, "description": "Amount of ratings to show." }, { "name": "halfIncrements", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Allows the selection of half increments." } ] }, { "name": "VaReferenceArrayField", "description": "Display multiple reference links to another existing resource as material chip group.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "color", "value": { "kind": "expression", "type": "string|func" }, "description": "Color of chip, can be a function for dynamic color according to a certain value." }, { "name": "small", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Small chip." }, { "name": "to", "value": { "kind": "expression", "type": "string|object" }, "description": "Router link associated to chip if needed." }, { "name": "reference", "value": { "kind": "expression", "type": "string" }, "description": "Name of resource to link into." }, { "name": "action", "value": { "kind": "expression", "type": "string" }, "description": "Default CRUD page to link." }, { "name": "itemText", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Property used for stringify inner targeted resource.\nUse a function for further stringify customization.\nIf nothing set, use the global label property resource by default." }, { "name": "itemValue", "value": { "kind": "expression", "type": "string" }, "description": "Attribute where taking the id value for link building." }, { "name": "column", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Show list of chips as column." } ] }, { "name": "VaReferenceField", "description": "Display a reference link to another existing resource. Can auto fetch the the target resource from source ID if asked.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "color", "value": { "kind": "expression", "type": "string|func" }, "description": "Color of chip, can be a function for dynamic color according to a certain value." }, { "name": "small", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Small chip." }, { "name": "to", "value": { "kind": "expression", "type": "string|object" }, "description": "Router link associated to chip if needed." }, { "name": "reference", "value": { "kind": "expression", "type": "string" }, "description": "Name of resource to link into." }, { "name": "action", "value": { "kind": "expression", "type": "string" }, "description": "Default CRUD page to link." }, { "name": "itemText", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Property used for stringify inner targeted resource.\nUse a function for further stringify customization.\nIf nothing set, use the global label property resource by default." }, { "name": "itemValue", "value": { "kind": "expression", "type": "string" }, "description": "Attribute where taking the id value for link building." }, { "name": "chip", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Show link as a chip." }, { "name": "fetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Allow resource auto fetching from source." } ] }, { "name": "VaRichTextField", "description": "Show value on raw format that allows HTML tags.\nSource value must be trusted for prevent XSS attacks.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." } ] }, { "name": "VaSelectField", "description": "Show value as text selected from a predefined key-value choices.\nIf no choices, by default, takes localized enums with source as value from your VueI18n resources locales.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "itemText", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Attribute for showing text." }, { "name": "itemValue", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Attribute where taking the value from." }, { "name": "choices", "value": { "kind": "expression", "type": "array" }, "description": "List of choices for select.\nTakes localized enums from your VueI18n resources locales by default." }, { "name": "color", "value": { "kind": "expression", "type": "string|func" }, "description": "Color of chip, can be a function for dynamic color according to a certain value." }, { "name": "small", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Small chip." }, { "name": "to", "value": { "kind": "expression", "type": "string|object" }, "description": "Router link associated to chip if needed." }, { "name": "chip", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Show text inside material chip." } ] }, { "name": "VaTextField", "description": "Show value as simple text, render a simple span. HTML tags will be stripped.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "truncate", "value": { "kind": "expression", "type": "number" }, "description": "Truncate text" } ] }, { "name": "VaUrlField", "description": "Show value as simple anchor.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "target", "value": { "kind": "expression", "type": "string" }, "description": "Target value for anchor, default to external." } ] }, { "name": "VaArrayInput", "description": "Allow multiple embed inputs as array. See it as a repeater.\nSupport adding, removing, as well as moving via drag thanks to VueDraggable.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "v-model", "value": { "kind": "expression", "type": "array" }, "description": "List of object to edit." } ] }, { "name": "VaAutocompleteInput", "description": "Value editing from a searchable choices. Support multiple and references.\nAllows searching of linked resources from your API.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "v-model", "value": { "kind": "expression", "type": "string|number|array" }, "description": "Value to be selected, array if multiple." }, { "name": "multiple", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Allow input to accept multiple value as array." }, { "name": "filled", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Use full filled background color style." }, { "name": "chips", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Use chips for each item. Enabled if `multiple` by default." }, { "name": "smallChips", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Use small chips." }, { "name": "itemText", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Attribute for showing text." }, { "name": "itemValue", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Attribute where taking the value from." }, { "name": "choices", "value": { "kind": "expression", "type": "array" }, "description": "List of choices for select.\nTakes localized enums from your VueI18n resources locales by default." }, { "name": "filter", "value": { "kind": "expression", "type": "object" }, "description": "Internal active filter.\nSent to your data provider inside `filter` params." }, { "name": "fields", "value": { "kind": "expression", "type": "array" }, "description": "List of fields to select for API side. Support dot notation for nested fields.\nSent to your data provider inside `fields` params." }, { "name": "sortBy", "value": { "kind": "expression", "type": "array" }, "description": "List of sorted fields, can be multiple.\nSent to your data provider inside `sort` params." }, { "name": "sortDesc", "value": { "kind": "expression", "type": "array" }, "description": "List of sort state for each sorted fields, only `boolean`, `true` if sorted as `DESC`.\nSent to your data provider inside `sort` params." }, { "name": "include", "value": { "kind": "expression", "type": "array|object" }, "description": "Related resources to include within current resource for API side. Allow eager-loading on demand.\nSent to your data provider inside `include` params." }, { "name": "itemsPerPage", "value": { "kind": "expression", "type": "number" }, "description": "Maximum number of items to show in the list for each page.\nSent to your data provider inside `pagination.perPage` params." }, { "name": "disableItemsPerPage", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Disable items per page on query, forced on server side.\nNote at `itemsPerPage` is still necessary for proper client-side pager calculation." }, { "name": "reference", "value": { "kind": "expression", "type": "string" }, "description": "Name of resource to search into." }, { "name": "minChars", "value": { "kind": "expression", "type": "number" }, "description": "Minimum characters to tap before search query launch." }, { "name": "searchQuery", "value": { "kind": "expression", "type": "string" }, "description": "Name of request query for searching into your API." }, { "name": "taggable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Enable taggable mode. Transform autocomplete into combobox." } ] }, { "name": "VaBooleanInput", "description": "Edit value as boolean. Rendered as a switch.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Full item resource to be editable." }, { "name": "editable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this field as live-editable.\nIf enabled, the input will send directly a call to the API for live edit on change.\nIdeal for editable input inside VaDataTable, with combination of `editable` prop for each column." }, { "name": "v-model", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Boolean to be edited." } ] }, { "name": "VaDateInput", "description": "Use for date type value editing. Is composed of a readonly textfield associated to a vuetify datepicker.\nDo not support time, use classic VaTextInput in that case.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Full item resource to be editable." }, { "name": "editable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this field as live-editable.\nIf enabled, the input will send directly a call to the API for live edit on change.\nIdeal for editable input inside VaDataTable, with combination of `editable` prop for each column." }, { "name": "v-model", "value": { "kind": "expression", "type": "string" }, "description": "Date on ISO format to be edited." }, { "name": "filled", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Use full filled background color style." }, { "name": "format", "value": { "kind": "expression", "type": "string" }, "description": "Name of date format to use for textfield input.\nMust be predefined on your VueI18n plugin." } ] }, { "name": "VaFileInput", "description": "Allow row file uploads. Can be multiple.\nCurrent files will be shown as simple link or thumbnail image and can be deleted.\nUse VaFileField or VaImageField under the hood.\nNo Ajax support.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "v-model", "value": { "kind": "expression", "type": "string|array" }, "description": "Value to be edited. Array by default if multiple." }, { "name": "multiple", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Allow input to accept multiple value as array." }, { "name": "filled", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Use full filled background color style." }, { "name": "chips", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Use chips for each item. Enabled if `multiple` by default." }, { "name": "smallChips", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Use small chips." }, { "name": "preview", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Show file thumbnail image instead of simple link." }, { "name": "itemValue", "value": { "kind": "expression", "type": "string" }, "description": "Attribute where taking the id value for identify files to delete." }, { "name": "accept", "value": { "kind": "expression", "type": "string" }, "description": "Add HTML5 `accept` attribute for simple client-side validation." } ] }, { "name": "VaNumberInput", "description": "Optimized for number editing. Just a type number input with step, min and max attribute behavior.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Full item resource to be editable." }, { "name": "editable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this field as live-editable.\nIf enabled, the input will send directly a call to the API for live edit on change.\nIdeal for editable input inside VaDataTable, with combination of `editable` prop for each column." }, { "name": "v-model", "value": { "kind": "expression", "type": "number" }, "description": "Number to be edited." }, { "name": "filled", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Use full filled background color style." }, { "name": "step", "value": { "kind": "expression", "type": "number" }, "description": "The interval step." }, { "name": "min", "value": { "kind": "expression", "type": "number" }, "description": "The minimum accepted value." }, { "name": "max", "value": { "kind": "expression", "type": "number" }, "description": "The maximum accepted value." } ] }, { "name": "VaPasswordInput", "description": "Use it for password. No value accepted. Has show/hide behavior for current input.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "filled", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Use full filled background color style." } ] }, { "name": "VaRadioGroupInput", "description": "Value editing from a fixed choices. Support references.\nIf no choices, by default, takes localized enums with source as value from your VueI18n resources locales.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "itemText", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Attribute for showing text." }, { "name": "itemValue", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Attribute where taking the value from." }, { "name": "choices", "value": { "kind": "expression", "type": "array" }, "description": "List of choices for select.\nTakes localized enums from your VueI18n resources locales by default." }, { "name": "filter", "value": { "kind": "expression", "type": "object" }, "description": "Internal active filter.\nSent to your data provider inside `filter` params." }, { "name": "fields", "value": { "kind": "expression", "type": "array" }, "description": "List of fields to select for API side. Support dot notation for nested fields.\nSent to your data provider inside `fields` params." }, { "name": "sortBy", "value": { "kind": "expression", "type": "array" }, "description": "List of sorted fields, can be multiple.\nSent to your data provider inside `sort` params." }, { "name": "sortDesc", "value": { "kind": "expression", "type": "array" }, "description": "List of sort state for each sorted fields, only `boolean`, `true` if sorted as `DESC`.\nSent to your data provider inside `sort` params." }, { "name": "include", "value": { "kind": "expression", "type": "array|object" }, "description": "Related resources to include within current resource for API side. Allow eager-loading on demand.\nSent to your data provider inside `include` params." }, { "name": "itemsPerPage", "value": { "kind": "expression", "type": "number" }, "description": "Maximum number of items to show in the list for each page.\nSent to your data provider inside `pagination.perPage` params." }, { "name": "disableItemsPerPage", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Disable items per page on query, forced on server side.\nNote at `itemsPerPage` is still necessary for proper client-side pager calculation." }, { "name": "v-model", "value": { "kind": "expression", "type": "string|number|array" }, "description": "Value to be selected, array if multiple." }, { "name": "reference", "value": { "kind": "expression", "type": "string" }, "description": "Name of resource to search into." }, { "name": "column", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Show radios as a column." }, { "name": "row", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Show radios as a row." } ] }, { "name": "VaRatingInput", "description": "Edit number value as rating stars. Value should be a valid integer or decimal if half increments enabled.\nIcons can be edited via $ratingFull, $ratingEmpty and $ratingHalf on Vuetify settings.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "description": "Plain color for active ratings" }, { "name": "backgroundColor", "value": { "kind": "expression", "type": "string" }, "description": "Stroke color for empty ratings." }, { "name": "length", "value": { "kind": "expression", "type": "number|string" }, "description": "Amount of ratings to show." }, { "name": "halfIncrements", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Allows the selection of half increments." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Full item resource to be editable." }, { "name": "editable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this field as live-editable.\nIf enabled, the input will send directly a call to the API for live edit on change.\nIdeal for editable input inside VaDataTable, with combination of `editable` prop for each column." }, { "name": "v-model", "value": { "kind": "expression", "type": "number" }, "description": "Number to be edited." } ] }, { "name": "VaRichTextInput", "description": "Full Wysiwyg HTML editor by using TinyMCE 5.\nCan be bridged to any file browser as elFinder if you use PHP on the backend.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "v-model", "value": { "kind": "expression", "type": "string" }, "description": "HTML text to be edited." }, { "name": "height", "value": { "kind": "expression", "type": "number" }, "description": "Initial height of editor." }, { "name": "menubar", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Activate wysiwyg menu bar." }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Activate inline mode of wysiwyg." }, { "name": "plugins", "value": { "kind": "expression", "type": "array" }, "description": "Full available plugins for editing, see TinyMCE docs." }, { "name": "toolbar", "value": { "kind": "expression", "type": "string" }, "description": "Toolbar config, see TinyMCE docs." }, { "name": "init", "value": { "kind": "expression", "type": "object" }, "description": "The full TinyMCE object, check official docs." } ] }, { "name": "VaSelectInput", "description": "Value editing from a fixed choices. Support multiple and references.\nIf no choices, by default, takes localized enums with source as value from your VueI18n resources locales.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "v-model", "value": { "kind": "expression", "type": "string|number|array" }, "description": "Value to be selected, array if multiple." }, { "name": "multiple", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Allow input to accept multiple value as array." }, { "name": "filled", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Use full filled background color style." }, { "name": "chips", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Use chips for each item. Enabled if `multiple` by default." }, { "name": "smallChips", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Use small chips." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Full item resource to be editable." }, { "name": "editable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this field as live-editable.\nIf enabled, the input will send directly a call to the API for live edit on change.\nIdeal for editable input inside VaDataTable, with combination of `editable` prop for each column." }, { "name": "itemText", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Attribute for showing text." }, { "name": "itemValue", "value": { "kind": "expression", "type": "string|array|func" }, "description": "Attribute where taking the value from." }, { "name": "choices", "value": { "kind": "expression", "type": "array" }, "description": "List of choices for select.\nTakes localized enums from your VueI18n resources locales by default." }, { "name": "filter", "value": { "kind": "expression", "type": "object" }, "description": "Internal active filter.\nSent to your data provider inside `filter` params." }, { "name": "fields", "value": { "kind": "expression", "type": "array" }, "description": "List of fields to select for API side. Support dot notation for nested fields.\nSent to your data provider inside `fields` params." }, { "name": "sortBy", "value": { "kind": "expression", "type": "array" }, "description": "List of sorted fields, can be multiple.\nSent to your data provider inside `sort` params." }, { "name": "sortDesc", "value": { "kind": "expression", "type": "array" }, "description": "List of sort state for each sorted fields, only `boolean`, `true` if sorted as `DESC`.\nSent to your data provider inside `sort` params." }, { "name": "include", "value": { "kind": "expression", "type": "array|object" }, "description": "Related resources to include within current resource for API side. Allow eager-loading on demand.\nSent to your data provider inside `include` params." }, { "name": "itemsPerPage", "value": { "kind": "expression", "type": "number" }, "description": "Maximum number of items to show in the list for each page.\nSent to your data provider inside `pagination.perPage` params." }, { "name": "disableItemsPerPage", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Disable items per page on query, forced on server side.\nNote at `itemsPerPage` is still necessary for proper client-side pager calculation." }, { "name": "reference", "value": { "kind": "expression", "type": "string" }, "description": "Name of resource to search into." } ] }, { "name": "VaTextInput", "description": "Text editing for text value type via a basic text input.\nSupport textarea mode for long text via `multiline` prop.\nCan be use for any date, datetime or time editing, use type set on `date`, `datetime-local` or `time`.\nRender will depend of browser support.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "List of custom error validation messages to show as hint" }, { "name": "model", "value": { "kind": "expression", "type": "string" }, "description": "By default, the source will be the final name that will be sent to the API for create/update.\nThis prop allows you to override this default behavior." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Full item resource to be editable." }, { "name": "editable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this field as live-editable.\nIf enabled, the input will send directly a call to the API for live edit on change.\nIdeal for editable input inside VaDataTable, with combination of `editable` prop for each column." }, { "name": "v-model", "value": { "kind": "expression", "type": "string" }, "description": "Text to be edited." }, { "name": "type", "value": { "kind": "expression", "type": "string" }, "description": "Type of text input. All HTML type allowed." }, { "name": "multiline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Transform text input into textarea." }, { "name": "filled", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Use full filled background color style." } ] }, { "name": "VaAsideLayout", "description": "Component to use for showing information on aside from any components.\nUse Portal Vue plugin internally for integrate within VaAside.", "attributes": [ { "name": "title", "value": { "kind": "expression", "type": "string" }, "description": "Title of aside." } ] }, { "name": "VaCreateLayout", "description": "Page layout for resource creation.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "title", "value": { "kind": "expression", "type": "string" }, "description": "Optional H1 title of the page shown on the left of top header" } ] }, { "name": "VaEditLayout", "description": "Page layout for resource edition.\nContain specific related action as deleting, cloning, showing as well as translation action.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "title", "value": { "kind": "expression", "type": "string" }, "description": "Optional H1 title of the page shown on the left of top header" } ] }, { "name": "VaShowLayout", "description": "Page layout for resource detail showing. It's the better place for made heavy usage of any VA fields.\nContain specific related action as deleting, cloning, editing as well as translation action.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "title", "value": { "kind": "expression", "type": "string" }, "description": "Optional H1 title of the page shown on the left of top header" } ] }, { "name": "VaDataTable", "description": "Data table component, you will need data iterator as `VaList` in order to make it usable.\nThis component allows you to template all fields columns.", "attributes": [ { "name": "rowClick", "value": { "kind": "expression", "type": "string|boolean" }, "description": "Make each row clickable. Use predefined function as edit or show." }, { "name": "fields", "value": { "kind": "expression", "type": "array" }, "description": "List of columns for each property of resource data.\nEach column can be a simple string or a full object with advanced field properties.\nValid properties are `source`, `type`, `label`, `sortable`, `align`, `link`, `attributes`, `editable`." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduce height of each row." }, { "name": "multiSort", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Enable multi sort feature, enabled by default." }, { "name": "showExpand", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Enable row expand mode.\nUse it for quick detail view." }, { "name": "singleExpand", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Only one row can expanded at once" }, { "name": "disableSelect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable select feature." }, { "name": "disableSort", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable sorting." }, { "name": "disableShow", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable show action row." }, { "name": "disableEdit", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable show action row." }, { "name": "disableClone", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable clone action row." }, { "name": "disableDelete", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable delete action row." }, { "name": "disableActions", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable actions column." }, { "name": "disableCreateRedirect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable create redirection. Will force clone button to show." }, { "name": "disableShowRedirect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable show redirection. Will force show button to show." }, { "name": "disableEditRedirect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable edit redirection. Will force edit button to show." }, { "name": "association", "value": { "kind": "expression", "type": "object" }, "description": "Association infos object in case of this list is related to a current show or edit resource page.\nEnable the dissociation between resources directly by an additional dissociation action." }, { "name": "rowCreate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Allow new item row." }, { "name": "rowEdit", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Allow editable row." }, { "name": "createData", "value": { "kind": "expression", "type": "object" }, "description": "Additional form object data to merge with row-create form." }, { "name": "updateData", "value": { "kind": "expression", "type": "object" }, "description": "Additional form object data to merge with row-edit form." } ] }, { "name": "VaTreeview", "description": "Treeview component which support fully editable items with draggable feature and hierarchical data.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "value", "value": { "kind": "expression", "type": "array" }, "description": "All selected items via checkbox, can be use via v-model." }, { "name": "itemKey", "value": { "kind": "expression", "type": "string" }, "description": "Unique identifier for each node, `id` by default." }, { "name": "itemText", "value": { "kind": "expression", "type": "string" }, "description": "Label text for each node, `name` by default." }, { "name": "selectable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Enable checkbox selection." }, { "name": "openAll", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Open all nodes by default. Can't be used with `lazy`." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduce height of each node." }, { "name": "lazy", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Enable lazy items loading while node opening.\nUse `getNodes` data provider method instead of `getTree`." }, { "name": "editable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Enable full editable mode with drag & drop." }, { "name": "disableCreate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable new item creation form." }, { "name": "disableEdit", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable item edit button." }, { "name": "disableDelete", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable item deletion button." }, { "name": "disableInlineEdit", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable default inline edit form behavior.\nYou may use `item-edit` event in order to add your custom edit logic." }, { "name": "filter", "value": { "kind": "expression", "type": "object" }, "description": "Internal active filter.\nSent to your data provider inside `filter` params." }, { "name": "createData", "value": { "kind": "expression", "type": "object" }, "description": "Additional form object data to merge when new item created." }, { "name": "updateData", "value": { "kind": "expression", "type": "object" }, "description": "Additional form object data to merge when specific item updated." } ] }, { "name": "VaForm", "description": "Form component which handle resource saving by calling `create` or `update` data provider methods.\nIt's the better place for made heavy usage of any VA inputs.\nUse injection which allowing unique global v-model for all inputs.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "v-model", "value": { "kind": "expression", "type": "object" }, "description": "Current form model being edited. Represent the final data that will be send through your API." }, { "name": "id", "value": { "kind": "expression", "type": "string|number" }, "description": "Id of resource to be edit. If null, then create a new one." }, { "name": "item", "value": { "kind": "expression", "type": "object" }, "description": "Explicit item resource object where all properties must be injected into form model." }, { "name": "redirect", "value": { "kind": "expression", "type": "string" }, "description": "Default route resource action to redirect after saving." }, { "name": "disableRedirect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable default redirect behavior" } ] }, { "name": "VaList", "description": "List data iterator component, perfect for list CRUD page as well as any resource browsing standalone component.\nAllow resource paginating and filtering. Use current query string context for initial state by default.\nThe list layout on default slot is fully customizable and can be used for separate `VaDataTable` component.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "filter", "value": { "kind": "expression", "type": "object" }, "description": "Internal active filter.\nSent to your data provider inside `filter` params." }, { "name": "fields", "value": { "kind": "expression", "type": "array" }, "description": "List of fields to select for API side. Support dot notation for nested fields.\nSent to your data provider inside `fields` params." }, { "name": "sortBy", "value": { "kind": "expression", "type": "array" }, "description": "List of sorted fields, can be multiple.\nSent to your data provider inside `sort` params." }, { "name": "sortDesc", "value": { "kind": "expression", "type": "array" }, "description": "List of sort state for each sorted fields, only `boolean`, `true` if sorted as `DESC`.\nSent to your data provider inside `sort` params." }, { "name": "include", "value": { "kind": "expression", "type": "array|object" }, "description": "Related resources to include within current resource for API side. Allow eager-loading on demand.\nSent to your data provider inside `include` params." }, { "name": "itemsPerPage", "value": { "kind": "expression", "type": "number" }, "description": "Maximum number of items to show in the list for each page.\nSent to your data provider inside `pagination.perPage` params." }, { "name": "disableItemsPerPage", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Disable items per page on query, forced on server side.\nNote at `itemsPerPage` is still necessary for proper client-side pager calculation." }, { "name": "filters", "value": { "kind": "expression", "type": "array" }, "description": "Exposed filters, editable through advanced filter form, update URL query string if not disabled.\nSent to your data provider inside `filter` params.\nUse specific `alwaysOn` property for each filter you want to be visible and not removable.\nValid properties are `source`, `type`, `label`, `alwaysOn`, `attributes`." }, { "name": "itemsPerPageOptions", "value": { "kind": "expression", "type": "array" }, "description": "List of available selections of items per page." }, { "name": "disableQueryString", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable real time update of URL query string on any browsing action as pagination, sorting, filtering, etc." }, { "name": "hideDefaultFooter", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Hide default footer, notably default pagination." }, { "name": "disablePagination", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable pagination, will hide default footer." }, { "name": "hideHeader", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Hide all header toolbar, so neither filters nor any create or export actions." }, { "name": "disableCreate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Force disabling of create button, shown by default if create resource action available." }, { "name": "disableExport", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Disable the export button.\nThe export allows client-side CSV download and keep active filters while disabling pagination." }, { "name": "disableCreateRedirect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Disable create redirection. Will force create button to show." }, { "name": "disableGlobalSearch", "value": { "kind": "expression", "type": "boolean" }, "type": "boolean", "description": "Disable the global search." }, { "name": "globalSearchQuery", "value": { "kind": "expression", "type": "string" }, "description": "Key parameter of the global search query." }, { "name": "association", "value": { "kind": "expression", "type": "object" }, "description": "Association infos object in case of this list is related to a current show or edit resource page.\nEnable the association between resources directly by an autocomplete an associate action." } ] }, { "name": "VaShow", "description": "Show component injector which facilitates resource display by using VA component fields.\nInject item for each VA field.", "attributes": [ { "name": "item", "value": { "kind": "expression", "type": "object" }, "description": "Explicit item resource object where all properties must be injected into VA fields." } ] }, { "name": "VaField", "description": "Wrapper component for field which support label localization and supported VA field, mainly used for show page.\nUse default slot for custom needs or use `type` property for quick usage of valid existing field component.\nAll other attributes of this component will be merged into child slot.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "item", "value": { "kind": "expression", "type": "null" }, "description": "Override default item injected by `VaShow`." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "type", "value": { "kind": "expression", "type": "string" }, "description": "Type of field to use. Not used if you use default slot for advanced custom needs." } ] }, { "name": "VaInput", "description": "Dumb input wrapper for custom input components that don't manage natively error states.", "attributes": [ { "name": "resource", "value": { "kind": "expression", "type": "string" }, "description": "Name of the resource to use.\nRequired for good label localization and context action activators.\nDefault behavior is to fetch it from router context." }, { "name": "source", "value": { "kind": "expression", "type": "string" }, "description": "Property of resource for fetching the value to show.\nSupport dot notation for nested object." }, { "name": "parentSource", "value": { "kind": "expression", "type": "string" }, "description": "Specific case of parent resource for array input." }, { "name": "appendIcon", "value": { "kind": "expression", "type": "string" }, "description": "Appends an icon to the component. Must be a valid MDI." }, { "name": "hint", "value": { "kind": "expression", "type": "string" }, "description": "Hint text." }, { "name": "hideDetails", "value": { "kind": "expression", "type": "boolean|string" }, "description": "Hides hint and validation errors. When set to auto messages will be rendered only if there's a message (hint, error message, counter value etc) to display." }, { "name": "dense", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Reduces the input height." }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Add default required client side rule." }, { "name": "rules", "value": { "kind": "expression", "type": "array" }, "description": "Accepts an array of functions that take an input value as an argument and return either true / false or a string with an error message." }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "description": "Override default label behavior.\nDefault is to get the localized VueI18n label from both resource and property source." }, { "name": "labelKey", "value": { "kind": "expression", "type": "string" }, "description": "Override default source key as translated label." }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "description": "Placeholder if input support it." }, { "name": "clearable", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "type": "boolean", "description": "Mark this input as clearable." }, { "name": "index", "value": { "kind": "expression", "type": "number" }, "description": "Specific index of field in case of inside array of inputs, aka VaArrayInput.\nUse it with `parentSource` prop in order to update the value at a good place in the form model." }, { "name": "errorMessages", "value": { "kind": "expression", "type": "array" }, "description": "Puts the input in an error state and passes through custom error messages." } ] } ] } } }