vuetify-admin

{ "va-action-page": { "description": "Main CRUD action page layout used for Show, Create end Edit views components.", "attributes": [ "resource", "title" ] }, "va-app-bar": { "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": [ "title", "header-menu", "profile-menu", "disable-create", "disable-reload", "color", "dense", "dark" ] }, "va-aside": { "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": [ "width" ] }, "va-breadcrumbs": { "description": "Default admin component for breadcrumbs, will generate automatically hierarchical links from current route.\nSupport hierarchical CRUD structure.", "attributes": [] }, "va-footer": { "description": "Default customizable admin VFooter with possibility of corporate related links and infos.", "attributes": [ "menu" ] }, "va-layout": { "description": "Admin composable component layout with one slot for each region.", "attributes": [] }, "va-messages": { "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": [] }, "va-sidebar": { "description": "Default customizable admin VNavigationDrawer with full hierarchical menu and minimize variant.", "attributes": [ "menu", "mini-variant", "color", "dark", "value" ] }, "va-action-button": { "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": [ "icon", "label", "hide-label", "color", "text", "type", "to", "href", "target", "loading" ] }, "va-associate-button": { "description": "Action button for resource association. Used on lists with association enabled.\nDumb component, just a submit button.", "attributes": [ "resource", "item", "icon", "color" ] }, "va-bulk-action-button": { "description": "Generic customizable button for update bulk actions in VaList component.\nShown after items selections. Use `updateMany` data provider method under the hood.", "attributes": [ "icon", "label", "hide-label", "color", "text", "value", "action" ] }, "va-bulk-delete-button": { "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": [ "value" ] }, "va-clone-button": { "description": "Button for all clone resource action.\nRedirect to create page by default with target ID of original resource to clone.", "attributes": [ "resource", "item", "icon", "color", "disable-redirect" ] }, "va-create-button": { "description": "Button for all create resource action. Redirect to create page by default.", "attributes": [ "resource", "item", "icon", "color", "disable-redirect" ] }, "va-delete-button": { "description": "Button for all delete resource action. Comes with confirm dialog.\nAuto hide if no delete action available unless show prop is active.", "attributes": [ "resource", "item", "icon", "color", "redirect" ] }, "va-dissociate-button": { "description": "Action button for resource dissociation. Used on data tables with association enabled.\nComes with confirm dialog.", "attributes": [ "resource", "item", "icon", "color", "source", "source-id", "source-resource" ] }, "va-edit-button": { "description": "Button for all edit resource action. Redirect to edit page by default.", "attributes": [ "resource", "item", "icon", "color", "disable-redirect" ] }, "va-export-button": { "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": [ "resource", "item", "icon", "color", "options", "filter" ] }, "va-list-button": { "description": "Button for all list resource action. Redirect to list page by default.\nShown on internal CRUD page at top header.", "attributes": [ "resource", "item", "icon", "color" ] }, "va-locale-button": { "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": [ "resource", "item", "icon", "color" ] }, "va-save-button": { "description": "Default saving button that can be used for VaForm component.\nDumb component, just a submit button, VaForm do the real work.", "attributes": [ "resource", "item", "icon", "color", "text", "label", "redirect" ] }, "va-show-button": { "description": "Button for all show resource action. Redirect to show page by default.", "attributes": [ "resource", "item", "icon", "color", "disable-redirect" ] }, "va-array-field": { "description": "Show each single value of multiple array type value as material chip group.", "attributes": [ "resource", "source", "item", "color", "small", "to", "item-text", "select", "column" ] }, "va-boolean-field": { "description": "Show value as identifiable true/false icon.", "attributes": [ "resource", "source", "item", "label-true", "label-false", "icon-true", "icon-false" ] }, "va-chip-field": { "description": "Show value inside a material chip.", "attributes": [ "resource", "source", "item", "color", "small", "to" ] }, "va-date-field": { "description": "Show value as formatted date. Support any localized format, long, short, etc.\nUse `$d` VueI18n function under the hood.", "attributes": [ "resource", "source", "item", "format" ] }, "va-email-field": { "description": "Show value as `mailto` link.", "attributes": [ "resource", "source", "item" ] }, "va-file-field": { "description": "Show a list of file links that point to original files.", "attributes": [ "resource", "source", "item", "src", "title", "file-name", "target", "clearable", "model", "item-value" ] }, "va-image-field": { "description": "Show list of images as gallery with preview support for thumbnails.", "attributes": [ "resource", "source", "item", "src", "title", "file-name", "target", "clearable", "model", "item-value", "contain", "height", "lg" ] }, "va-number-field": { "description": "Show value as formatted number. Can be any localized currency, decimal number, or percent value.\nUse `$n` VueI18n function under the hood.", "attributes": [ "resource", "source", "item", "format" ] }, "va-rating-field": { "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": [ "resource", "source", "item", "color", "background-color", "length", "half-increments" ] }, "va-reference-array-field": { "description": "Display multiple reference links to another existing resource as material chip group.", "attributes": [ "resource", "source", "item", "color", "small", "to", "reference", "action", "item-text", "item-value", "column" ] }, "va-reference-field": { "description": "Display a reference link to another existing resource. Can auto fetch the the target resource from source ID if asked.", "attributes": [ "resource", "source", "item", "color", "small", "to", "reference", "action", "item-text", "item-value", "chip", "fetch" ] }, "va-rich-text-field": { "description": "Show value on raw format that allows HTML tags.\nSource value must be trusted for prevent XSS attacks.", "attributes": [ "resource", "source", "item" ] }, "va-select-field": { "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": [ "resource", "source", "item", "item-text", "item-value", "choices", "color", "small", "to", "chip" ] }, "va-text-field": { "description": "Show value as simple text, render a simple span. HTML tags will be stripped.", "attributes": [ "resource", "source", "item", "truncate" ] }, "va-url-field": { "description": "Show value as simple anchor.", "attributes": [ "resource", "source", "item", "target" ] }, "va-array-input": { "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": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "v-model" ] }, "va-autocomplete-input": { "description": "Value editing from a searchable choices. Support multiple and references.\nAllows searching of linked resources from your API.", "attributes": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "v-model", "multiple", "filled", "chips", "small-chips", "item-text", "item-value", "choices", "filter", "fields", "sort-by", "sort-desc", "include", "items-per-page", "disable-items-per-page", "reference", "min-chars", "search-query", "taggable" ] }, "va-boolean-input": { "description": "Edit value as boolean. Rendered as a switch.", "attributes": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "item", "editable", "v-model" ] }, "va-date-input": { "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": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "item", "editable", "v-model", "filled", "format" ] }, "va-file-input": { "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": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "v-model", "multiple", "filled", "chips", "small-chips", "preview", "item-value", "accept" ] }, "va-number-input": { "description": "Optimized for number editing. Just a type number input with step, min and max attribute behavior.", "attributes": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "item", "editable", "v-model", "filled", "step", "min", "max" ] }, "va-password-input": { "description": "Use it for password. No value accepted. Has show/hide behavior for current input.", "attributes": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "filled" ] }, "va-radio-group-input": { "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": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "item-text", "item-value", "choices", "filter", "fields", "sort-by", "sort-desc", "include", "items-per-page", "disable-items-per-page", "v-model", "reference", "column", "row" ] }, "va-rating-input": { "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": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "color", "background-color", "length", "half-increments", "item", "editable", "v-model" ] }, "va-rich-text-input": { "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": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "v-model", "height", "menubar", "inline", "plugins", "toolbar", "init" ] }, "va-select-input": { "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": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "v-model", "multiple", "filled", "chips", "small-chips", "item", "editable", "item-text", "item-value", "choices", "filter", "fields", "sort-by", "sort-desc", "include", "items-per-page", "disable-items-per-page", "reference" ] }, "va-text-input": { "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": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages", "model", "item", "editable", "v-model", "type", "multiline", "filled" ] }, "va-aside-layout": { "description": "Component to use for showing information on aside from any components.\nUse Portal Vue plugin internally for integrate within VaAside.", "attributes": [ "title" ] }, "va-create-layout": { "description": "Page layout for resource creation.", "attributes": [ "resource", "title" ] }, "va-edit-layout": { "description": "Page layout for resource edition.\nContain specific related action as deleting, cloning, showing as well as translation action.", "attributes": [ "resource", "title" ] }, "va-show-layout": { "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": [ "resource", "title" ] }, "va-data-table": { "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": [ "row-click", "fields", "dense", "multi-sort", "show-expand", "single-expand", "disable-select", "disable-sort", "disable-show", "disable-edit", "disable-clone", "disable-delete", "disable-actions", "disable-create-redirect", "disable-show-redirect", "disable-edit-redirect", "association", "row-create", "row-edit", "create-data", "update-data" ] }, "va-treeview": { "description": "Treeview component which support fully editable items with draggable feature and hierarchical data.", "attributes": [ "resource", "value", "item-key", "item-text", "selectable", "open-all", "dense", "lazy", "editable", "disable-create", "disable-edit", "disable-delete", "disable-inline-edit", "filter", "create-data", "update-data" ] }, "va-form": { "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": [ "resource", "v-model", "id", "item", "redirect", "disable-redirect" ] }, "va-list": { "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": [ "resource", "filter", "fields", "sort-by", "sort-desc", "include", "items-per-page", "disable-items-per-page", "filters", "items-per-page-options", "disable-query-string", "hide-default-footer", "disable-pagination", "hide-header", "disable-create", "disable-export", "disable-create-redirect", "disable-global-search", "global-search-query", "association" ] }, "va-show": { "description": "Show component injector which facilitates resource display by using VA component fields.\nInject item for each VA field.", "attributes": [ "item" ] }, "va-field": { "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": [ "resource", "source", "item", "label", "label-key", "type" ] }, "va-input": { "description": "Dumb input wrapper for custom input components that don't manage natively error states.", "attributes": [ "resource", "source", "parent-source", "append-icon", "hint", "hide-details", "dense", "required", "rules", "label", "label-key", "placeholder", "clearable", "index", "error-messages" ] } }