[ { "path": ".dockerignore", "content": ".git\n.vscode\n.devbots\n.github\nnode_modules\n" }, { "path": ".editorconfig", "content": "root = true\n\n[*]\ncharset = utf-8\nindent_style = space\nindent_size = 2\nend_of_line = lf\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n" }, { "path": ".eslintrc.cjs", "content": "module.exports = {\n root: true,\n parserOptions: {\n parser: '@typescript-eslint/parser',\n ecmaVersion: 2020,\n sourceType: 'module',\n projectService: true,\n tsconfigRootDir: __dirname,\n extraFileExtensions: ['.vue', '.json'],\n suppressDeprecatedPropertyWarnings: true,\n },\n extends: [\n 'standard',\n 'plugin:vue/recommended',\n // 'plugin:vuetify/base',\n 'plugin:sonarjs/recommended',\n ],\n env: {\n node: true,\n browser: true,\n es6: true,\n },\n plugins: [\n '@typescript-eslint',\n '@stylistic/ts',\n 'sonarjs',\n 'react',\n 'eslint-plugin-local-rules',\n ],\n rules: {\n 'no-var': 'error',\n // allow paren-less arrow functions\n 'arrow-parens': ['error', 'as-needed'],\n // set maximum line characters\n 'max-len': ['error', {\n code: 140,\n ignoreUrls: true,\n ignoreTemplateLiterals: true,\n ignoreTrailingComments: true,\n }],\n complexity: ['error', 32],\n quotes: ['error', 'single', {\n avoidEscape: true,\n allowTemplateLiterals: true,\n }],\n 'no-console': 'off',\n 'comma-dangle': ['error', {\n arrays: 'always-multiline',\n objects: 'always-multiline',\n imports: 'always-multiline',\n exports: 'always-multiline',\n functions: 'only-multiline',\n }],\n // allow debugger during development\n 'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',\n 'no-return-assign': 'off',\n 'no-unused-vars': 'error',\n 'no-empty': 'error',\n 'array-bracket-spacing': ['error', 'never'],\n 'object-curly-spacing': ['error', 'always'],\n 'space-before-function-paren': [\n 'error',\n {\n anonymous: 'always',\n named: 'always',\n asyncArrow: 'always',\n },\n ],\n 'no-return-await': 'warn',\n 'object-shorthand': ['error', 'always'],\n 'no-extra-semi': 'error',\n 'prefer-const': ['error', {\n destructuring: 'all',\n ignoreReadBeforeAssign: true,\n }],\n 'no-prototype-builtins': 'off',\n 'no-void': 'off',\n 'no-case-declarations': 'off',\n indent: ['error', 2, {\n ...require('eslint-config-standard').rules.indent[2],\n flatTernaryExpressions: true,\n offsetTernaryExpressions: false,\n }],\n 'sort-imports': ['warn', {\n ignoreDeclarationSort: true,\n ignoreCase: true,\n }],\n 'multiline-ternary': 'off',\n 'no-implicit-coercion': ['error', { boolean: false }],\n\n 'sonarjs/cognitive-complexity': 'off',\n 'sonarjs/no-duplicate-string': 'off',\n\n // Not in override, these apply to non-.vue files too\n 'vue/require-default-prop': 'off',\n 'vue/require-prop-types': 'off',\n 'vue/one-component-per-file': 'off',\n 'vue/custom-event-name-casing': ['error', 'camelCase', { ignores: ['/^[a-z]+(?:-[a-z]+)*:[a-z]+(?:-[a-z]+)*$/u'] }],\n 'vue/multi-word-component-names': 'off',\n\n 'vue/attributes-order': ['error', {\n order: [\n 'DEFINITION', 'LIST_RENDERING', 'CONDITIONALS', 'RENDER_MODIFIERS', 'UNIQUE', 'GLOBAL', 'SLOT',\n 'TWO_WAY_BINDING', 'ATTR_DYNAMIC', 'ATTR_STATIC', 'ATTR_SHORTHAND_BOOL', 'OTHER_DIRECTIVES', 'EVENTS', 'CONTENT',\n ],\n alphabetical: true,\n }],\n },\n overrides: [\n {\n files: '**/*.vue',\n rules: {\n indent: 'off',\n 'vue/script-indent': ['error', 2, {\n baseIndent: 1,\n switchCase: 1,\n ignores: [],\n }],\n 'vue/html-closing-bracket-newline': ['error', {\n singleline: 'never',\n multiline: 'always',\n }],\n 'vue/html-closing-bracket-spacing': 'error',\n 'vue/max-attributes-per-line': ['error', {\n singleline: 5,\n multiline: 1,\n }],\n 'vue/valid-v-on': 'off', // This rule doesn't allow empty event listeners\n 'vue/no-v-html': 'off',\n 'vue/singleline-html-element-content-newline': 'off',\n 'vue/multiline-html-element-content-newline': 'off',\n 'vue/valid-v-slot': ['error', { allowModifiers: true }],\n\n /* TODO: this really should be enabled,\n we just do it so much I didn't have time to fix them all */\n 'vue/no-v-text-v-html-on-component': 'off',\n },\n },\n {\n files: ['**/*.ts', '**/*.tsx'],\n parser: '@typescript-eslint/parser',\n rules: {\n // Can't overload function exports with this enabled\n 'import/export': 'off',\n\n // False positives on types\n 'no-undef': 'off',\n\n quotes: 'off',\n '@stylistic/ts/quotes': ['error', 'single', {\n avoidEscape: true,\n allowTemplateLiterals: true,\n }],\n\n indent: 'off',\n '@stylistic/ts/indent': ['error', 2, {\n ...require('eslint-config-standard').rules.indent[2],\n ignoredNodes: [...require('eslint-config-standard').rules.indent[2].ignoredNodes, 'TSTypeParameterInstantiation'],\n flatTernaryExpressions: true,\n offsetTernaryExpressions: false,\n }],\n\n 'func-call-spacing': 'off',\n '@stylistic/ts/func-call-spacing': require('eslint-config-standard').rules['func-call-spacing'],\n\n // Handled by tsc\n 'no-redeclare': 'off',\n\n 'no-use-before-define': 'off',\n '@typescript-eslint/no-use-before-define': ['error', 'nofunc'],\n\n 'no-useless-constructor': 'off',\n '@typescript-eslint/no-useless-constructor': ['error'],\n\n // Enabled in tsconfig\n 'no-unused-vars': 'off',\n\n '@stylistic/ts/member-delimiter-style': ['error', {\n multiline: {\n delimiter: 'none',\n },\n singleline: {\n delimiter: 'comma',\n },\n }],\n '@stylistic/ts/type-annotation-spacing': 'error',\n\n '@typescript-eslint/prefer-namespace-keyword': 'error',\n '@typescript-eslint/adjacent-overload-signatures': 'error',\n // '@typescript-eslint/ban-types': 'error',\n '@typescript-eslint/member-ordering': 'error',\n '@typescript-eslint/no-inferrable-types': 'error',\n '@typescript-eslint/unified-signatures': 'error',\n '@typescript-eslint/no-invalid-this': 'error',\n '@typescript-eslint/consistent-type-imports': ['error', {\n prefer: 'type-imports',\n fixStyle: 'separate-type-imports',\n }],\n 'import/consistent-type-specifier-style': ['error', 'prefer-top-level'],\n 'import/no-duplicates': ['error', { 'prefer-inline': false }],\n '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',\n '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',\n // '@typescript-eslint/no-unnecessary-condition': 'error',\n '@typescript-eslint/prefer-includes': 'error',\n // '@typescript-eslint/prefer-nullish-coalescing': 'warn',\n // '@typescript-eslint/prefer-optional-chain': 'warn',\n '@typescript-eslint/prefer-string-starts-ends-with': 'error',\n '@typescript-eslint/prefer-ts-expect-error': 'warn',\n '@typescript-eslint/restrict-plus-operands': 'error',\n '@typescript-eslint/no-wrapper-object-types': 'error',\n },\n },\n {\n files: '**/*.tsx',\n rules: {\n 'jsx-quotes': 'error',\n 'react/jsx-boolean-value': 'error',\n 'react/jsx-closing-bracket-location': ['error', 'line-aligned'],\n 'react/jsx-curly-brace-presence': 'error',\n\n // https://github.com/yannickcr/eslint-plugin-react/issues/2415\n // 'react/jsx-curly-spacing': ['error', { when: 'always', spacing: { objectLiterals: 'never' } }],\n 'local-rules/jsx-condition-key': 'error',\n 'local-rules/jsx-curly-spacing': ['error', {\n when: 'always',\n spacing: {\n objectLiterals: 'never',\n arrayLiterals: 'never',\n multilineClose: 'never',\n },\n children: true,\n }],\n 'local-rules/jsx-prop-casing': 'error',\n\n 'react/jsx-equals-spacing': 'error',\n 'react/jsx-first-prop-new-line': 'error',\n 'react/jsx-max-props-per-line': ['error', { when: 'multiline' }],\n 'react/jsx-no-comment-textnodes': 'error',\n 'react/jsx-tag-spacing': 'error',\n 'react/jsx-wrap-multilines': ['error', {\n declaration: 'parens-new-line',\n assignment: 'parens-new-line',\n return: 'parens-new-line',\n arrow: 'parens-new-line',\n condition: 'parens-new-line',\n logical: 'parens-new-line',\n }],\n },\n },\n {\n files: '**/*.d.ts',\n rules: {\n 'import/no-duplicates': 'off',\n },\n },\n {\n files: '**/*.json',\n parser: '@typescript-eslint/parser',\n extends: ['plugin:@typescript-eslint/disable-type-checked'],\n rules: {\n quotes: ['error', 'double'],\n 'comma-dangle': ['error', 'never'],\n 'quote-props': ['error', 'always'],\n 'max-len': 'off',\n 'no-unused-expressions': 'off',\n 'no-template-curly-in-string': 'off',\n },\n },\n ],\n}\n" }, { "path": ".gitattributes", "content": "* text=auto eol=lf\n" }, { "path": ".github/.git_commit_msg.txt", "content": "\n# ------------------------ >8 ------------------------\n# |<---- Using a Maximum Of 50 Characters ---->| Hard limit to 72 -->|\n# : \n#\n# \n#\n# fixes #\n#\n# ----------------------------------------------------\n#\n# can be\n# feat (new feature)\n# fix (bug fix)\n# docs (documentation only)\n# refactor (refactoring production code)\n# style (formatting, missing semicolons, etc. no code change)\n# test (adding or refactoring tests; no production code change)\n# chore (updating npm scripts etc. no production code change)\n# revert (revert a commit\n# must be the reverted commit's title\n# must contain \"This reverts commit .\")\n#\n# Remember to\n# Not capitalize the subject line\n# Use the imperative mood in the subject line\n# Do not end the subject line with a period\n# Separate subject from body with a blank line (comments don't count)\n# Use the body to explain what and why vs. how\n#\n# If you can't summarize your changes in a single line, they should\n# probably be split into multiple commits\n" }, { "path": ".github/CONTRIBUTING.md", "content": "# Vuetify Contributing Guide\n\nThank you for your interest in improving Vuetify! Please review these guidelines to ensure a smooth contribution process.\n\n## Important Information\n\n- Detailed instructions for [Contributing to Vuetify](https://vuetifyjs.com/getting-started/contributing/) are available in the documentation.\n- For general questions, join [our Discord Community](https://community.vuetifyjs.com/).\n\n## Reporting Issues\n\n- Issues **must** be created using or they will be closed immediately.\n- The issue list is **exclusively** for bug reports and feature requests.\n- Search for existing issues before submitting a new one.\n- Ensure the issue is reproducible with the [latest version](https://github.com/vuetifyjs/vuetify/releases/latest).\n- Provide a **minimal** and **concise** reproduction using [Vuetify Play](https://play.vuetifyjs.com/) or a public repository with:\n - An initial commit showing the working state.\n - A subsequent commit triggering the issue.\n- Include clear reproduction steps (actions another developer can follow after opening your link).\n- Avoid comments like \"+1\" or \"me too!\" without additional details—use the :+1: button instead.\n\n## Pull Requests\n\n- Work on a new branch in your fork (e.g., `fix/1234-some-issue`), not `dev` or `master`.\n- Submit bug fixes to the `master` branch; new features or breaking changes to the `dev` branch.\n- Use a descriptive title (max 64 characters) for the PR—it will become the commit message.\n- Include examples of the problem and proposed solution, ideally referencing an existing issue (e.g., `Fixes #1234`).\n- Follow [commit guidelines](#commit-guidelines) for all changes.\n\n## Local Development Setup\n\n1. **Prerequisites:**\n - Git (>v2.20)\n - Node.js (LTS)\n - [pnpm](https://pnpm.io/)\n - Additional tools may be needed for [node-gyp](https://github.com/nodejs/node-gyp#installation) on Windows.\n\n1. **Clone and Install:**\n\n ```bash\n git clone https://github.com/vuetifyjs/vuetify.git\n cd vuetify\n pnpm i\n pnpm build vuetify\n pnpm build api\n ```\n\n1. **Development:**\n - Run `pnpm dev` from the root to start a dev server at `localhost:8090` with `packages/vuetify/dev/Playground.vue`.\n - Test changes in `Playground.vue` and include its contents in your PR.\n - For documentation, run `pnpm dev docs` (after building Vuetify with `pnpm build:lib`) at `localhost:8095`.\n\n1. **Submitting Changes:**\n - Fork the repository and add your fork as a remote:\n\n ```bash\n git remote add fork https://github.com/YOUR_USERNAME/vuetify.git\n ```\n\n - Choose the correct base branch:\n - Bug fixes/Documentation: `master`\n - New features: `dev`\n - Push your branch and open a PR.\n\n## Commit Guidelines\n\nFollow the [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) standard:\n\n- Format: `(scope): ` (e.g., `fix(VSelect): resolve dropdown bug`) or `: ` (e.g., `docs: update contributing guide`).\n- Subject: Max 60 characters, imperative mood (e.g., \"fix\", not \"fixed\").\n- Body: Reference issues (e.g., `resolves #1234`), wrap at 72 characters, explain \"what\" and \"why\" (not \"how\").\n- Types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `revert`.\n" }, { "path": ".github/FUNDING.yml", "content": "# These are supported funding model platforms\n\ngithub: [johnleider, KaelWD, MajesticPotatoe]\nopen_collective: vuetify\nko_fi: # Replace with a single Ko-fi username\ntidelift: npm/vuetify\ncustom: # Replace with a single custom sponsorship URL\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\ncontact_links:\n - name: Vuetify Issue Creator\n url: https://issues.vuetifyjs.com\n about: Create Vuetify issues here.\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "\n\n## Description\n\n\n## Markup:\n\n\n\n```vue\n\n```\n" }, { "path": ".github/actions/download-locales/action.yml", "content": "name: Download translations\ndescription: Download translations from Crowdin\n\ninputs:\n crowdin-branch:\n description: 'Crowdin branch name'\n required: false\n default: 'v4'\n\nruns:\n using: composite\n steps:\n - id: get-date\n run: |\n echo \"date=$(/bin/date -u \"+%Y%m%d\")\" >> $GITHUB_OUTPUT\n shell: bash\n - uses: actions/cache@v4\n id: cache-crowdin\n with:\n key: crowdin-${{ inputs.crowdin-branch }}-${{ steps.get-date.outputs.date }}\n path: |-\n packages/api-generator/src/locale/**/*.json\n !packages/api-generator/src/locale/en/**/*.json\n packages/docs/src/pages/**/*.md\n !packages/docs/src/pages/en/**/*.md\n packages/docs/src/i18n/messages/*.json\n !packages/docs/src/i18n/messages/en.json\n - name: Download eo-UY\n if: ${{ steps.cache-crowdin.outputs.cache-hit != 'true' }}\n uses: crowdin/github-action@v2.7.1\n with:\n download_language: eo\n config: crowdin.yml\n upload_sources: false\n download_translations: true\n push_translations: false\n export_only_approved: false\n crowdin_branch_name: ${{ inputs.crowdin-branch }}\n - name: Download es-MX\n if: ${{ steps.cache-crowdin.outputs.cache-hit != 'true' }}\n uses: crowdin/github-action@v2.7.1\n with:\n download_language: es-MX\n config: crowdin.yml\n upload_sources: false\n download_translations: true\n push_translations: false\n export_only_approved: false\n crowdin_branch_name: ${{ inputs.crowdin-branch }}\n - name: Download ja-JP\n if: ${{ steps.cache-crowdin.outputs.cache-hit != 'true' }}\n uses: crowdin/github-action@v2.7.1\n with:\n download_language: ja\n config: crowdin.yml\n upload_sources: false\n download_translations: true\n push_translations: false\n export_only_approved: false\n crowdin_branch_name: ${{ inputs.crowdin-branch }}\n - name: Download zh-CN\n if: ${{ steps.cache-crowdin.outputs.cache-hit != 'true' }}\n uses: crowdin/github-action@v2.7.1\n with:\n download_language: zh-CN\n config: crowdin.yml\n upload_sources: false\n download_translations: true\n push_translations: false\n export_only_approved: false\n crowdin_branch_name: ${{ inputs.crowdin-branch }}\n" }, { "path": ".github/actions/nightly-release/action.yml", "content": "name: Nightly Release\ndescription: Automatically release nightly builds\n\ninputs:\n checkout-repo:\n description: 'Repository to checkout'\n required: true\n checkout-ref:\n description: 'Ref to checkout'\n required: true\n release-id:\n description: 'Release ID'\n required: true\n npm-tag:\n description: 'NPM tag'\n required: true\n\noutputs:\n full-version:\n description: 'Full version'\n value: ${{ steps.get-version.outputs.full-version }}\n\nruns:\n using: composite\n steps:\n - run: |\n git config --global user.email \"actions@github.com\"\n git config --global user.name \"GitHub Actions\"\n shell: bash\n - uses: actions/checkout@v4\n with:\n repository: ${{ inputs.checkout-repo }}\n ref: ${{ inputs.checkout-ref }}\n fetch-depth: 0\n - uses: vuetifyjs/setup-action@master\n - run: >-\n node -e \"\n const json = require('./lerna.json');\n delete json.command.publish.allowBranch;\n fs.writeFileSync('./lerna.json', JSON.stringify(json, null, 2))\"\n shell: bash\n - id: get-version\n run: echo \"full-version=$(node -e \"console.log(require('./lerna.json').version)\")-${{ inputs.release-id }}\" >> $GITHUB_OUTPUT\n shell: bash\n - run: pnpm lerna version ${{ steps.get-version.outputs.full-version }} --no-push --no-commit-hooks --force-publish --yes\n shell: bash\n - run: pnpm conventional-changelog -p vuetify --outfile ./packages/vuetify/CHANGELOG.md -r 2\n shell: bash\n - run: >-\n node -e \"fs.writeFileSync(\n './package.json',\n JSON.stringify({ ...require('./package.json'), name: '@vuetify/nightly' }, null, 2)\n )\"\n shell: bash\n working-directory: ./packages/vuetify\n - run: pnpm run --filter @vuetify/nightly build\n shell: bash\n - run: pnpm run --filter @vuetify/api-generator build\n shell: bash\n - run: npm install -g npm@latest\n shell: bash\n - name: NPM Release\n run: |\n npm publish ./packages/vuetify --tag ${{ inputs.npm-tag }} --access public\n shell: bash\n env:\n NPM_API_KEY: ${{ inputs.npm-token }}\n" }, { "path": ".github/issue-close-app.yml", "content": "comment: \"Please only create issues with the provided [issue creator](https://issues.vuetifyjs.com). In the boilerplate for creating an issue, it explains that any ticket made without this will be automatically closed. For general questions, please join [the Discord chat room](https://community.vuetifyjs.com). You can also check [reddit](https://www.reddit.com/r/vuetifyjs/) or [stackoverflow](https://stackoverflow.com/questions/tagged/vuetify.js). Thank you.\"\nissueConfigs:\n- content:\n - \"\"\n- content:\n - \"\"\nlabel: \"invalid\"\nexception:\n - \"johnleider\"\n - \"KaelWD\"\n - \"MajesticPotatoe\"\n" }, { "path": ".github/lock.yml", "content": "daysUntilLock: 365\nlockComment: false\n\npulls:\n daysUntilLock: 30\n exemptLabels: ['S: on hold', 'S: work in progress']\n" }, { "path": ".github/semantic.yml", "content": "titleOnly: true\n" }, { "path": ".github/sponsors.yml", "content": "- label: 'P: sponsor'\n members:\n\n- label: 'P: elite sponsor'\n members:\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\non: [push, pull_request]\nconcurrency:\n group: ci-${{ github.ref }}\n cancel-in-progress: true\n\nenv:\n CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}\n CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}\n\njobs:\n pre_job:\n runs-on: ubuntu-24.04\n outputs:\n should_skip: ${{ steps.skip_check.outputs.should_skip }}\n steps:\n - id: skip_check\n if: ${{ !startsWith(github.ref, 'refs/tags/v') && github.ref_name != 'master' }}\n uses: fkirc/skip-duplicate-actions@master\n with:\n skip_after_successful_duplicate: 'true'\n concurrent_skipping: same_content\n do_not_skip: '[\"pull_request\", \"workflow_dispatch\", \"schedule\"]'\n\n build-vuetify:\n name: Build vuetify\n needs: pre_job\n if: needs.pre_job.outputs.should_skip != 'true'\n runs-on: ubuntu-24.04\n steps:\n - uses: actions/checkout@v4\n - uses: vuetifyjs/setup-action@master\n - run: pnpm build vuetify\n - uses: actions/upload-artifact@v4\n with:\n name: vuetify-dist\n path: |\n packages/vuetify/dist\n packages/vuetify/lib\n\n lint:\n name: Lint\n needs: [pre_job, build-vuetify]\n if: needs.pre_job.outputs.should_skip != 'true'\n runs-on: ubuntu-24.04\n strategy:\n fail-fast: false\n matrix:\n scopes: ['--filter vuetify --filter @vuetify/api-generator', '--filter vuetifyjs.com']\n steps:\n - uses: actions/checkout@v4\n - uses: actions/download-artifact@v4\n with:\n name: vuetify-dist\n path: packages/vuetify\n - uses: vuetifyjs/setup-action@master\n - run: pnpm run $SCOPES lint\n env:\n SCOPES: ${{ matrix.scopes }}\n\n test:\n name: Test\n needs: pre_job\n if: needs.pre_job.outputs.should_skip != 'true'\n runs-on: ubuntu-24.04\n steps:\n - uses: actions/checkout@v4\n - uses: actions/cache@v4\n with:\n path: ~/.cache/ms-playwright\n key: ${{ runner.os }}-playwright-${{ hashFiles('./pnpm-lock.yaml') }}\n - uses: vuetifyjs/setup-action@master\n - run: pnpm exec playwright install chromium\n - run: pnpm run test\n working-directory: ./packages/vuetify\n - uses: actions/upload-artifact@v4\n if: failure()\n with:\n name: Test screenshots\n path: packages/vuetify/test/__screenshots__\n if-no-files-found: ignore\n overwrite: true\n\n deploy:\n needs: [lint, test, build-vuetify]\n runs-on: ubuntu-24.04\n if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository_owner == 'vuetifyjs'\n environment: production\n permissions:\n contents: write\n id-token: write\n steps:\n - uses: actions/checkout@v4\n with:\n fetch-depth: 0\n - uses: actions/download-artifact@v4\n with:\n name: vuetify-dist\n path: packages/vuetify\n - uses: vuetifyjs/setup-action@master\n - run: pnpm build api\n - run: npm install -g npm@latest\n - name: NPM Release\n run: |\n npm publish ./packages/vuetify --tag $(node ./scripts/parse-npm-tag.js $GITHUB_REF_NAME)\n - name: GitHub release\n id: create_release\n run: pnpm conventional-github-releaser -p vuetify\n env:\n DEBUG: '*'\n CONVENTIONAL_GITHUB_RELEASER_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n build-docs:\n name: Build docs\n needs: [pre_job, build-vuetify]\n if: >\n needs.pre_job.outputs.should_skip != 'true' &&\n github.event_name == 'push' &&\n github.repository_owner == 'vuetifyjs' &&\n contains(toJSON('[\"master\", \"dev\", \"next\"]'), github.ref_name)\n runs-on: ubuntu-24.04\n steps:\n - uses: actions/checkout@v4\n - uses: actions/download-artifact@v4\n with:\n name: vuetify-dist\n path: packages/vuetify\n - uses: vuetifyjs/setup-action@master\n - uses: ./.github/actions/download-locales\n - run: pnpm build api\n - run: pnpm build docs\n env:\n NODE_OPTIONS: --max-old-space-size=10240\n VITE_COSMIC_2_BUCKET_SLUG: ${{ secrets.COSMIC_2_BUCKET_SLUG }}\n VITE_COSMIC_2_BUCKET_READ_KEY: ${{ secrets.COSMIC_2_BUCKET_READ_KEY }}\n VITE_COSMIC_BUCKET_SLUG: ${{ secrets.COSMIC_BUCKET_SLUG }}\n VITE_COSMIC_BUCKET_READ_KEY: ${{ secrets.COSMIC_BUCKET_READ_KEY }}\n VITE_COSMIC_BUCKET_SLUG_STORE: ${{ secrets.COSMIC_BUCKET_SLUG_STORE }}\n VITE_COSMIC_BUCKET_READ_KEY_STORE: ${{ secrets.COSMIC_BUCKET_READ_KEY_STORE }}\n VITE_EMAILJS_PUBLIC_KEY: ${{ secrets.EMAILJS_PUBLIC_KEY }}\n VITE_EMAILJS_SERVICE_ID: ${{ secrets.EMAILJS_SERVICE_ID }}\n VITE_EMAILJS_TEMPLATE_ID: ${{ secrets.EMAILJS_TEMPLATE_ID }}\n VITE_API_SERVER_URL: ${{ secrets.API_SERVER_URL }}\n VITE_GITHUB_SHA: ${{ github.sha }}\n VITE_GITHUB_REF: ${{ github.ref_name }}\n - uses: actions/upload-artifact@v4\n with:\n name: docs-dist\n path: packages/docs/dist\n\n publish-docs:\n needs: [lint, test, build-docs]\n runs-on: ubuntu-24.04\n environment: ${{ github.ref_name }}\n steps:\n - uses: actions/checkout@v4\n - uses: actions/download-artifact@v4\n with:\n name: docs-dist\n path: packages/docs/dist\n - uses: vuetifyjs/coolify-action@master\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n imageName: docs\n coolifyWebhook: ${{ secrets.COOLIFY_WEBHOOK }}\n coolifySecret: ${{ secrets.COOLIFY_TOKEN }}\n" }, { "path": ".github/workflows/close-issue.yml", "content": "name: Close issues\non:\n push:\n branches:\n - dev\n - next\n - v3-stable\n - v2-stable\n - v2-dev\n\nenv:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\njobs:\n close:\n runs-on: ubuntu-24.04\n if: github.repository_owner == 'vuetifyjs'\n steps:\n - uses: vuetifyjs/close-action@master\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n" }, { "path": ".github/workflows/crowdin-uploads.yml", "content": "name: Crowdin Uploads\nconcurrency:\n group: crowdin-${{ github.ref }}\n cancel-in-progress: true\n\non:\n push:\n branches:\n - 'master'\n paths:\n - 'packages/api-generator/src/locale/en/**'\n - 'packages/docs/src/i18n/messages/en.json'\n - 'packages/docs/src/pages/en/**'\n - '.github/workflows/**'\n\nenv:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}\n CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}\n CROWDIN_BRANCH: v4\n\njobs:\n upload-to-crowdin:\n runs-on: ubuntu-24.04\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n - name: Upload\n uses: crowdin/github-action@v2.7.1\n with:\n config: crowdin.yml\n crowdin_branch_name: ${{ env.CROWDIN_BRANCH }}\n" }, { "path": ".github/workflows/nightly.yml", "content": "name: Nightly Release\non:\n schedule:\n - cron: '0 12 * * *' # 1200 UTC\n workflow_dispatch:\n inputs:\n pr:\n description: 'Pull Request number'\n required: false\n type: string\n\njobs:\n nightly-schedule:\n runs-on: ubuntu-24.04\n if: ${{ github.event_name == 'schedule' && github.repository_owner == 'vuetifyjs' }}\n environment: preview\n permissions:\n contents: read\n id-token: write\n strategy:\n max-parallel: 1\n fail-fast: false\n matrix:\n branch: [ 'master', 'dev', 'next', 'v3-stable', 'v2-stable', 'v2-dev' ]\n include:\n - branch: 'master'\n tag: 'latest'\n - branch: 'dev'\n tag: 'dev'\n - branch: 'next'\n tag: 'next'\n - branch: 'v3-stable'\n tag: 'v3-stable'\n - branch: 'v2-stable'\n tag: 'v2-stable'\n - branch: 'v2-dev'\n tag: 'v2-dev'\n steps:\n - uses: actions/checkout@v4\n with:\n ref: ${{ matrix.branch }}\n fetch-depth: 0\n - run: |\n last=$(git show -s --format=%ct HEAD)\n now=$(date +%s)\n diff=$(($now - $last))\n if [ $diff -gt 86400 ]; then\n echo \"Last commit was more than 24 hours ago, skipping release\"\n exit 1\n fi\n - run: echo \"RELEASE_ID=$(date +'%Y-%m-%d')\" >> $GITHUB_ENV\n - uses: ./.github/actions/nightly-release\n with:\n checkout-repo: ${{ github.repository }}\n checkout-ref: ${{ matrix.branch }}\n release-id: ${{ matrix.branch }}.${{ env.RELEASE_ID }}\n npm-tag: ${{ matrix.tag }}\n - uses: actions/checkout@v4\n\n nightly-pr:\n runs-on: ubuntu-24.04\n if: ${{ github.event_name == 'workflow_dispatch' && github.repository_owner == 'vuetifyjs' }}\n environment: preview\n permissions:\n contents: read\n id-token: write\n pull-requests: write\n steps:\n - uses: actions/checkout@v4\n - uses: actions/github-script@v7\n with:\n script: |\n const pr = await github.rest.pulls.get({\n owner: context.repo.owner,\n repo: context.repo.repo,\n pull_number: ${{ github.event.inputs.pr }}\n })\n core.exportVariable('CHECKOUT_REPO', pr.data.head.repo.full_name)\n core.exportVariable('CHECKOUT_REF', pr.data.head.ref)\n core.exportVariable('SHORT_SHA', pr.data.head.sha.slice(0, 7))\n - id: nightly-release\n uses: ./.github/actions/nightly-release\n with:\n checkout-repo: ${{ env.CHECKOUT_REPO }}\n checkout-ref: ${{ env.CHECKOUT_REF }}\n release-id: pr-${{ github.event.inputs.pr }}.${{ env.SHORT_SHA }}\n npm-tag: pr\n - uses: actions/github-script@v7\n with:\n script: |\n const fullVersion = process.env.FULL_VERSION\n const pr = await github.rest.issues.createComment({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: ${{ github.event.inputs.pr }},\n body: `:rocket: Nightly release published to [@vuetify/nightly@${fullVersion}](https://www.npmjs.com/package/@vuetify/nightly/v/${fullVersion}).`\n })\n env:\n FULL_VERSION: ${{ steps.nightly-release.outputs.full-version }}\n\n vizzly:\n name: Visual regression tests\n runs-on: ubuntu-24.04\n if: ${{ github.event_name == 'schedule' && github.repository_owner == 'vuetifyjs' }}\n steps:\n - uses: actions/checkout@v4\n with:\n ref: master\n fetch-depth: 0\n - run: |\n last=$(git show -s --format=%ct HEAD)\n now=$(date +%s)\n diff=$(($now - $last))\n if [ $diff -gt 86400 ]; then\n echo \"Last commit was more than 24 hours ago, skipping tests\"\n exit 1\n fi\n - uses: vuetifyjs/setup-action@master\n - run: pnpm exec playwright install chromium\n - run: pnpm vizzly run \"pnpm test:browser\"\n working-directory: ./packages/vuetify\n env:\n VIZZLY_TOKEN: ${{ secrets.VIZZLY_TOKEN }}\n TEST_TDD_ONLY: 1\n" }, { "path": ".github/workflows/stale.yml", "content": "name: 'Close stale issues'\non:\n workflow_dispatch:\n schedule:\n - cron: '08 11 * * *'\n\njobs:\n stale:\n runs-on: ubuntu-24.04\n steps:\n - uses: actions/stale@v9\n with:\n days-before-stale: 180\n days-before-close: 14\n only-labels: 'S: triage'\n stale-issue-label: 'S: stale'\n stale-pr-label: 'S: stale'\n exempt-all-milestones: true\n exempt-draft-pr: true\n" }, { "path": ".github/workflows/triage.yml", "content": "name: Issue triage\non:\n issues:\n types: [opened, labeled, unlabeled, closed]\n\njobs:\n triage:\n runs-on: ubuntu-24.04\n steps:\n - uses: actions/checkout@v4\n - uses: vuetifyjs/triage-action@master\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n triageLabel: 'S: triage'\n staleLabel: 'S: stale'\n sponsorsFile: '.github/sponsors.yml'\n duplicateLabel: 'duplicate'\n triagedLabels: |-\n T: documentation\n T: bug\n T: enhancement\n T: feature\n T: question\n Epic\n Task\n duplicate\n layer 8 issue\n invalid\n wontfix\n working as intended\n" }, { "path": ".gitignore", "content": ".DS_Store\nnode_modules/\n.env\n.knit\nknit.lock\n\n# IDE user config\n.vscode/\n.idea/\n.vs/\n\n# Logs\nyarn-error.log\nnpm-debug.log\nlerna-debug.log\n\n# Istanbul coverage\ncoverage/\n\n# cypress\ncypress/screenshots\ncypress/videos\n\n# vitest\n__screenshots__/\n\n.vercel\n.now\n" }, { "path": ".husky/commit-msg", "content": "node scripts/lint-commit-message.js $1\n" }, { "path": ".husky/pre-commit", "content": "node scripts/warn-npm-install.js\n" }, { "path": ".husky/prepare-commit-msg", "content": "node scripts/prepare-commit-message.js $1 $2\n" }, { "path": ".nvmrc", "content": "24.11.1\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@vuetifyjs.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]\n\n[homepage]: https://contributor-covenant.org\n[version]: https://contributor-covenant.org/version/1/4/\n" }, { "path": "Dockerfile", "content": "FROM caddy:2.10.2-alpine\nCOPY ./packages/docs/dist /srv\nCOPY ./packages/docs/build/Caddyfile /etc/caddy/Caddyfile\n" }, { "path": "SECURITY.md", "content": "# Security Disclosure Procedures\n\nThis document outlines security procedures and general policies for the Vuetify project.\n\n * [Reporting a Bug](#reporting-a-bug)\n * [Disclosure Policy](#disclosure-policy)\n * [Comments on this Policy](#comments-on-this-policy)\n\n## Reporting a Bug\n\nThe Vuetify team and community take all security bugs in Vuetify seriously. We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions.\n\nTo report a security issue, email [security@vuetifyjs.com](mailto:security@vuetifyjs.com?subject=SECURITY) and include the word **\"SECURITY\"** in the subject line.\n\nThe Vuetify team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.\n\nReport security bugs in third-party modules to the person or team maintaining the module. You can also report a vulnerability through the [Node Security Project](https://nodesecurity.io/report).\n\n## Disclosure Policy\n\nWhen the security team receives a security bug report, they will assign it to a\nprimary handler. This person will coordinate the fix and release process,\ninvolving the following steps:\n\n * Confirm the problem and determine the affected versions.\n * Audit code to find any potential similar problems.\n * Prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible to npm.\n\n## Comments on this Policy\n\nIf you have suggestions on how this process could be improved please submit a pull request using the [issue creator](https://issues.vuetifyjs.com).\n" }, { "path": "crowdin.yml", "content": "project_id_env: CROWDIN_PROJECT_ID\napi_token_env: CROWDIN_PERSONAL_TOKEN\nproject_identifier: vuetify\npreserve_hierarchy: true\nfiles:\n - source: packages/api-generator/src/locale/en/**/*.json\n translation: packages/api-generator/src/locale/%locale%/**/%original_file_name%\n - source: packages/docs/src/pages/en/**/*.md\n translation: packages/docs/src/pages/%locale%/**/%original_file_name%\n - source: packages/docs/src/i18n/messages/en.json\n translation: packages/docs/src/i18n/messages/%locale%.json\n" }, { "path": "docker-compose.yml", "content": "services:\n docs:\n image: caddy:alpine\n ports:\n - ${PORT:-8095}:80\n volumes:\n - ./packages/docs/dist:/srv\n - ./packages/docs/build/Caddyfile:/etc/caddy/Caddyfile\n" }, { "path": "eslint-local-rules.cjs", "content": "'use strict'\n\nconst path = require('node:path')\nconst glob = require('glob')\n\nmodule.exports = Object.fromEntries(\n glob.sync('./scripts/rules/*', { cwd: __dirname, dotRelative: true }).map(name => {\n const modulePath = path.resolve(__dirname, name)\n const module = require(modulePath)\n return [path.parse(name).name, module.default || module]\n })\n)\n" }, { "path": "jest.config.cjs", "content": "module.exports = {\n verbose: false,\n testEnvironment: 'jsdom',\n testEnvironmentOptions: {\n customExportConditions: ['node', 'node-addons'],\n },\n roots: [\n '/src',\n ],\n setupFilesAfterEnv: [\n '/test/index.ts',\n ],\n moduleFileExtensions: [\n 'tsx',\n 'ts',\n 'js',\n ],\n moduleDirectories: [\n 'node_modules',\n ],\n moduleNameMapper: {\n '^@/test$': '/test/index.js',\n '^@/test/(.*)$': '/test/$1',\n '^@/(.*)$': '/src/$1',\n '\\\\.(css|sass|scss)$': 'identity-obj-proxy',\n },\n transform: {\n '.*\\\\.(j|t)sx?$': 'babel-jest',\n },\n collectCoverageFrom: [\n 'src/**/*.{js,ts,tsx}',\n '!**/*.d.ts',\n ],\n transformIgnorePatterns: [\n 'node_modules/(?!vue-router)',\n ],\n snapshotSerializers: [\n 'jest-serializer-html',\n ],\n testMatch: [\n // Default\n '**/test/**/*.js',\n '**/__tests__/**/*.spec.js',\n '**/__tests__/**/*.spec.ts',\n '**/__tests__/**/*.spec.tsx',\n ],\n}\n" }, { "path": "lerna.json", "content": "{\n \"command\": {\n \"publish\": {\n \"allowBranch\": [\n \"master\",\n \"dev\",\n \"next\"\n ],\n \"message\": \"chore(release): publish %s\"\n },\n \"version\": {\n \"push\": true\n }\n },\n \"npmClient\": \"pnpm\",\n \"version\": \"4.0.3\"\n}\n" }, { "path": "package.json", "content": "{\n \"name\": \"@vuetify/vuetify-root\",\n \"type\": \"module\",\n \"private\": true,\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"git+https://github.com/vuetifyjs/vuetify.git\"\n },\n \"scripts\": {\n \"dev\": \"node scripts/dev.js\",\n \"build\": \"node scripts/build.js\",\n \"lint\": \"pnpm run -r --parallel --stream lint\",\n \"lint:fix\": \"pnpm run -r --parallel lint:fix\",\n \"version\": \"node scripts/confirm-npm-tag.js\",\n \"prepare\": \"husky; node scripts/post-install.js; $CI || pnpm exec playwright install chromium\",\n \"postversion\": \"node scripts/post-release-merge.js\",\n \"clean\": \"pnpm -r exec rm -r node_modules && rm -r node_modules\",\n \"changelog\": \"conventional-changelog -u -p vuetify\",\n \"all-checks\": \"pnpm run -r --stream build && pnpm run lint && pnpm run -r test\",\n \"vue-ecosystem-ci:build\": \"pnpm --filter vuetify run build\",\n \"vue-ecosystem-ci:test\": \"pnpm --filter vuetify run lint && pnpm --filter vuetify run test\"\n },\n \"engines\": {\n \"node\": \">=24.11.1\"\n },\n \"devDependencies\": {\n \"@babel/cli\": \"^7.28.3\",\n \"@babel/core\": \"^7.28.5\",\n \"@babel/preset-env\": \"^7.28.5\",\n \"@babel/preset-typescript\": \"^7.28.5\",\n \"@lerna-lite/cli\": \"^4.9.3\",\n \"@lerna-lite/version\": \"^4.9.3\",\n \"@mdi/font\": \"7.4.47\",\n \"@mdi/js\": \"7.4.47\",\n \"@mdi/svg\": \"7.4.47\",\n \"@octokit/core\": \"^6.1.5\",\n \"@rollup/plugin-terser\": \"^0.4.4\",\n \"@stylistic/eslint-plugin-ts\": \"^3.1.0\",\n \"@types/lodash-es\": \"^4.17.12\",\n \"@types/node\": \"24.10.1\",\n \"@types/yargs\": \"^17.0.35\",\n \"@typescript-eslint/eslint-plugin\": \"^8.32.0\",\n \"@typescript-eslint/parser\": \"^8.32.0\",\n \"@typescript/native-preview\": \"7.0.0-dev.20250912.1\",\n \"@unhead/vue\": \"^2.0.19\",\n \"@vitejs/plugin-vue\": \"^6.0.2\",\n \"@vue/compiler-sfc\": \"^3.5.25\",\n \"@vue/language-server\": \"^3.1.5\",\n \"@vue/runtime-core\": \"^3.5.25\",\n \"@vue/runtime-dom\": \"^3.5.25\",\n \"@vuetify/github-releaser\": \"^4.0.3\",\n \"@vueuse/head\": \"^1.3.1\",\n \"concurrently\": \"^9.2.1\",\n \"conventional-changelog-cli\": \"^5.0.0\",\n \"conventional-changelog-vuetify\": \"^2.0.2\",\n \"cross-spawn\": \"^7.0.6\",\n \"eslint\": \"^8.57.0\",\n \"eslint-config-standard\": \"^17.1.0\",\n \"eslint-formatter-codeframe\": \"^7.32.2\",\n \"eslint-plugin-import\": \"^2.32.0\",\n \"eslint-plugin-local-rules\": \"^2.0.1\",\n \"eslint-plugin-n\": \"^16.6.2\",\n \"eslint-plugin-promise\": \"^6.6.0\",\n \"eslint-plugin-react\": \"^7.37.5\",\n \"eslint-plugin-sonarjs\": \"^0.25.1\",\n \"eslint-plugin-vue\": \"^10.6.0\",\n \"eslint-plugin-vuetify\": \"^2.5.3\",\n \"glob\": \"^11.1.0\",\n \"husky\": \"^9.1.7\",\n \"inquirer\": \"^12.6.0\",\n \"lodash-es\": \"^4.17.21\",\n \"magic-string\": \"^0.30.21\",\n \"mkdirp\": \"^3.0.1\",\n \"moment\": \"^2.30.1\",\n \"rimraf\": \"^6.1.2\",\n \"rollup\": \"^4.53.3\",\n \"rollup-plugin-dts\": \"^6.2.3\",\n \"rollup-plugin-sass\": \"^1.15.3\",\n \"rollup-plugin-sourcemaps\": \"^0.6.3\",\n \"sass\": \"1.93.3\",\n \"sass-embedded\": \"1.93.3\",\n \"semver\": \"^7.7.3\",\n \"shelljs\": \"^0.10.0\",\n \"stringify-object\": \"^5.0.0\",\n \"typescript\": \"~5.8.3\",\n \"upath\": \"^2.0.1\",\n \"vite\": \"^7.2.4\",\n \"vite-plugin-inspect\": \"11.3.3\",\n \"vue\": \"^3.5.25\",\n \"vue-eslint-parser\": \"^10.2.0\",\n \"vue-tsc\": \"^3.1.5\",\n \"vuetify\": \"workspace:*\",\n \"yargs\": \"^17.7.2\"\n },\n \"packageManager\": \"pnpm@10.26.1\"\n}\n" }, { "path": "packages/README.md", "content": "

These are the packages for the Vuetify monorepo.

\n\n## Packages for the Vuetify\n\n1. **api-generator** - generates api for Vuetify docs and other resources.\n2. **docs** - Vuetify documentation\n3. **vuetify** - main source code for Vuetify\n" }, { "path": "packages/api-generator/.gitignore", "content": "/dist/\n/lib/\n/src/locale/*\n/templates/tmp/\n!/src/locale/en\n" }, { "path": "packages/api-generator/package.json", "content": "{\n \"name\": \"@vuetify/api-generator\",\n \"type\": \"module\",\n \"version\": \"4.0.3\",\n \"private\": true,\n \"description\": \"\",\n \"scripts\": {\n \"build\": \"node src/index.ts\",\n \"lint\": \"eslint --ext .ts,.json src -f codeframe --max-warnings 0\",\n \"lint:fix\": \"pnpm lint --fix\"\n },\n \"author\": \"\",\n \"license\": \"ISC\",\n \"dependencies\": {\n \"deepmerge\": \"^4.3.1\",\n \"piscina\": \"^4.9.2\",\n \"prettier\": \"^3.6.2\",\n \"ts-morph\": \"^25.0.1\",\n \"vue\": \"^3.5.25\",\n \"vuetify\": \"workspace:*\"\n },\n \"devDependencies\": {\n \"@types/stringify-object\": \"^4.0.5\",\n \"eslint\": \"^8.57.0\",\n \"stringify-object\": \"^5.0.0\"\n }\n}\n" }, { "path": "packages/api-generator/src/helpers/sass.ts", "content": "import fs from 'node:fs'\n\nfunction processVariableFile (filePath: string, tagUse: string | string[]) {\n if (fs.existsSync(filePath)) {\n const varFile = fs.readFileSync(filePath, 'utf8')\n const vars = varFile.replace(/\\/\\/.+[\\r\\n]+/g, '').split(/;[\\n]*/g)\n const varValues: Record = {}\n for (const [index, variable] of vars.entries()) {\n const varArr = variable.split(':')\n if (varArr.length >= 2 && varArr[0].startsWith('$')) {\n const varName = varArr.shift()!.trim()\n const varDefault = (vars[index + 1].startsWith('@'))\n ? vars[index + 1]\n : varArr.join(':')\n varValues[varName] = {\n default: varDefault.replace('!default', '').trim(),\n ...{ use: tagUse === 'all' || tagUse?.includes(varName) ? 'vuetify' : 'vuetify/settings' },\n }\n }\n }\n return varValues\n }\n\n return {}\n}\n\nexport const parseSassVariables = (componentName: string) => {\n const rootDir = './../vuetify/src/components'\n return processVariableFile(`${rootDir}/${componentName}/_variables.scss`, '')\n}\n\nexport function parseGlobalSassVariables () {\n return {\n ...processVariableFile(`./../vuetify/src/styles/settings/_variables.scss`, ['$reset', '$color-pack', '$utilities']),\n ...processVariableFile(`./../vuetify/src/styles/settings/_colors.scss`, 'all'),\n ...processVariableFile(`./../vuetify/src/styles/settings/_elevations.scss`, []),\n }\n}\n" }, { "path": "packages/api-generator/src/helpers/text.ts", "content": "import { capitalize } from 'lodash-es'\n\nexport { camelCase, capitalize } from 'lodash-es'\n\nexport const kebabCase = (str: string) => {\n let kebab = ''\n for (let i = 0; i < str.length; i++) {\n const charCode = str.charCodeAt(i)\n if (charCode >= 65 && charCode <= 90) {\n kebab += `${i > 0 ? '-' : ''}${str[i].toLowerCase()}`\n } else {\n kebab += str[i]\n }\n }\n return kebab\n}\n\nexport const pascalize = (str: string) => str.split('-').map(capitalize).join('')\n" }, { "path": "packages/api-generator/src/index.ts", "content": "import fs from 'node:fs/promises'\nimport path from 'upath'\nimport { components } from 'vuetify/dist/vuetify-labs.js'\nimport importMap from 'vuetify/dist/json/importMap.json' with { type: 'json' }\nimport importMapLabs from 'vuetify/dist/json/importMap-labs.json' with { type: 'json' }\nimport { kebabCase } from './helpers/text.ts'\nimport type { ComponentData, DirectiveData } from './types.ts'\nimport { generateComposableDataFromTypes, generateDirectiveDataFromTypes } from './types.ts'\nimport Piscina from 'piscina'\nimport { addDescriptions, addDirectiveDescriptions, addPropData, reportMissingDescriptions, sortByKey, stringifyProps } from './utils.ts'\nimport * as os from 'os'\nimport { mkdirp } from 'mkdirp'\nimport { createVeturApi } from './vetur.ts'\nimport { rimraf } from 'rimraf'\nimport { createWebTypesApi } from './web-types.ts'\nimport inspector from 'inspector'\nimport yargs from 'yargs'\nimport { parseGlobalSassVariables, parseSassVariables } from './helpers/sass.ts'\n\nconst yar = yargs(process.argv.slice(2))\n .option('components', {\n type: 'array',\n })\n .option('skip-directives', {\n type: 'boolean',\n })\n .option('skip-composables', {\n type: 'boolean',\n })\n\nconst reset = '\\x1b[0m'\nconst red = '\\x1b[31m'\nconst blue = '\\x1b[34m'\n\nconst componentsInfo: Record = {\n ...importMap.components,\n ...importMapLabs.components,\n}\n\ntype Truthy = Exclude;\nconst BooleanFilter = (x: T): x is Truthy => Boolean(x)\n\nfunction clamp (v: number, min: number, max: number) {\n return Math.max(min, Math.floor(Math.min(max, v)))\n}\n\nconst run = async () => {\n const argv = await yar.argv\n\n const locales = await fs.readdir('./src/locale', 'utf-8')\n\n // Components\n const pool = new Piscina({\n filename: path.resolve('./src/worker.ts'),\n niceIncrement: 10,\n maxThreads: inspector.url()\n ? 1\n : clamp(os.freemem() / (1.1 * 1024 ** 3), 1, os.cpus().length / 2),\n })\n\n const template = await fs.readFile('./templates/component.d.ts', 'utf-8')\n\n await rimraf(path.resolve('./dist'))\n await fs.mkdir(path.resolve('./dist'))\n await mkdirp('./templates/tmp')\n for (const component in components) {\n // await fs.writeFile(`./templates/tmp/${component}.d.ts`, template.replaceAll('__component__', component))\n await fs.writeFile(`./templates/tmp/${component}.d.ts`,\n template.replaceAll('__component__', component)\n .replaceAll('__name__', componentsInfo[component].from)\n )\n }\n\n const outPath = path.resolve('./dist/api')\n await mkdirp(outPath)\n\n const componentData = (await Promise.all(\n Object.entries(components).map(async ([componentName, componentInstance]) => {\n if (argv.components && !argv.components.includes(componentName)) return null\n\n const data = await pool.run(componentName)\n const componentProps = stringifyProps(componentInstance.props)\n const sources = addPropData(componentName, data, componentProps)\n await addDescriptions(componentName, data, locales, sources)\n const sass = sortByKey(parseSassVariables(componentName))\n\n const component = {\n displayName: componentName,\n fileName: componentName,\n pathName: kebabCase(componentName),\n ...data,\n sass,\n } satisfies ComponentData\n await fs.writeFile(path.resolve(outPath, `${component.fileName}.json`), JSON.stringify(component, null, 2))\n\n return component\n })\n )).filter(BooleanFilter)\n\n // globalSass\n const globalSass = {\n fileName: 'globals',\n displayName: 'globals',\n pathName: 'globals',\n sass: sortByKey(parseGlobalSassVariables()),\n }\n await fs.writeFile(path.resolve(outPath, `globals.json`), JSON.stringify(globalSass, null, 2))\n\n // Composables\n if (!argv.skipComposables) {\n const composables = await Promise.all((await generateComposableDataFromTypes()).map(async composable => {\n console.log(blue, composable.displayName, reset)\n await addDescriptions(composable.fileName, composable, locales)\n return composable\n }))\n\n for (const composable of composables) {\n await fs.writeFile(\n path.resolve(outPath, `${composable.fileName}.json`),\n JSON.stringify(composable, null, 2)\n )\n }\n }\n\n // Directives\n let directives: DirectiveData[] = []\n if (!argv.skipDirectives) {\n directives = await Promise.all((await generateDirectiveDataFromTypes()).map(async data => {\n console.log(blue, data.fileName, reset)\n await addDirectiveDescriptions(data.fileName, data, locales)\n\n return data\n }))\n\n for (const directive of directives) {\n await fs.writeFile(\n path.resolve(outPath, `${directive.fileName}.json`),\n JSON.stringify(directive, null, 2)\n )\n }\n }\n\n reportMissingDescriptions()\n createVeturApi(componentData)\n createWebTypesApi(componentData, directives)\n await fs.mkdir(path.resolve('../vuetify/dist/json'), { recursive: true })\n await fs.copyFile(path.resolve('./dist/tags.json'), path.resolve('../vuetify/dist/json/tags.json'))\n await fs.copyFile(path.resolve('./dist/attributes.json'), path.resolve('../vuetify/dist/json/attributes.json'))\n await fs.copyFile(path.resolve('./dist/web-types.json'), path.resolve('../vuetify/dist/json/web-types.json'))\n rimraf.sync(path.resolve('./templates/tmp'))\n}\n\nrun()\n" }, { "path": "packages/api-generator/src/locale/en/$vuetify.json", "content": "{\n \"functions\": {\n \"goTo\": \"Scroll to target location, using provided options.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/DataIterator-items.json", "content": "{\n \"props\": {\n \"itemSelectable\": \"Property on supplied `items` that contains the boolean value indicating if the item is selectable.\",\n \"itemValue\": \"Property on supplied `items` that contains its value.\",\n \"returnObject\": \"Changes the selection behavior to return the object directly rather than the value specified with **item-value**.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/DataTable-expand.json", "content": "{\n \"props\": {\n \"expanded\": \"Array of expanded items. Can be bound to external variable using **v-model:expanded**.\",\n \"expandOnClick\": \"Expands item when the row is clicked.\",\n \"showExpand\": \"Shows the expand icon.\"\n },\n \"events\": {\n \"update:expanded\": \"Emits when the **expanded** items are updated.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/DataTable-group.json", "content": "{\n \"props\": {\n \"groupBy\": \"Defines the grouping of the table items.\",\n \"pageBy\": \"Controls how pagination counts items.\\n- **item** paginates by individual items,\\n- **auto** paginates by top-level groups and falls back to regular items if **group-by** is empty,\\n- **any** paginates by both items and groups combined\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/DataTable-header.json", "content": "{\n \"props\": {\n \"headers\": \"An array of objects that each describe a header column.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/DataTable-items.json", "content": "{\n \"props\": {\n \"itemSelectable\": \"Property on supplied `items` that indicates whether the item is selectable.\",\n \"itemValue\": \"Property on supplied `items` that contains its value.\",\n \"returnObject\": \"Changes the selection behavior to return the object directly rather than the value specified with **item-value**.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/DataTable-paginate.json", "content": "{\n \"props\": {\n \"itemsPerPage\": \"The number of items to display on each page.\",\n \"page\": \"The current displayed page number (1-indexed).\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/DataTable-select.json", "content": "{\n \"props\": {\n \"selectStrategy\": \"Defines the strategy of selecting items in the list. Possible values are: 'single' (only one item can be selected at a time), 'page' ('Select all' button will select only items on the current page), 'all' ('Select all' button will select all items in the list).\",\n \"showSelect\": \"Shows the column with checkboxes for selecting items in the list.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/DataTable-sort.json", "content": "{\n \"props\": {\n \"customKeySort\": \"Function used on specific keys within the item object. `customSort` is skipped for columns with `customKeySort` specified.\",\n \"disableSort\": \"Toggles rendering of sort button.\",\n \"initialSortOrder\": \"Specifies the initial sort order when an unsorted column is clicked.\",\n \"multiSort\": \"Let user sort by multiple properties/columns.\\n\\n- **key**: (optional) when set to `ctrl`, user is required to hold a keyboard key (Ctrl on PC and Command on Mac)\\n- **mode**: when user selects a new column to sort by, it will be set first (`prepend`) or last (`append`) in the sort priority. Defaults to `append`\\n- **modifier**: (optional) allows user to use both multi-sort modes (`append` and `prepend`) simultaneously\",\n \"mustSort\": \"Forces sorting on the column(s).\",\n \"sortBy\": \"Array of column keys and sort orders that determines the sort order of the table.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/DataTable.json", "content": "{\n \"props\": {\n \"hideDefaultBody\": \"Hides the default body.\",\n \"hideDefaultHeader\": \"Hides the default header.\",\n \"hideDefaultFooter\": \"Hides the default footer.\",\n \"search\": \"Text input used to filter items.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/Select.json", "content": "{\n \"props\": {\n \"closeText\": \"Text set to the inputs `aria-label` and `title` when input menu is closed.\",\n \"chips\": \"Changes display of selections to chips.\",\n \"closableChips\": \"Enables the [closable](/api/v-chip/#props-closable) prop on all [v-chip](/components/chips/) components.\",\n \"hideSelected\": \"Do not display in the select menu items that are already selected.\",\n \"itemColor\": \"Sets color of selected items.\",\n \"listProps\": \"Pass props through to the `v-list` component. Accepts an object with anything from [v-list](/api/v-list/#props) props, camelCase keys are recommended.\",\n \"menuElevation\": \"Sets the elevation of the dropdown menu.\",\n \"multiple\": \"Changes select to multiple. Accepts array for value.\",\n \"noAutoScroll\": \"Prevents the select menu to scroll to the selected item automatically.\",\n \"openOnClear\": \"Open's the menu whenever the clear icon is clicked.\",\n \"openText\": \"Text set to the inputs **aria-label** and **title** when input menu is open.\"\n },\n \"slots\": {\n \"menu-header\": \"Defines a header above the items list.\",\n \"menu-footer\": \"Defines a footer below the items list.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/SelectionControlGroup.json", "content": "{\n \"props\": {\n \"defaultsTarget\": \"The target component to provide defaults values for.\",\n \"error\": \"Puts the input in a manual error state.\",\n \"falseIcon\": \"The icon used when inactive.\",\n \"id\": \"Sets the DOM id on the component.\",\n \"inline\": \"Puts children inputs into a row.\",\n \"multiple\": \"Changes select to multiple. Accepts array for value.\",\n \"readonly\": \"Puts input in readonly state.\",\n \"trueIcon\": \"The icon used when active.\",\n \"type\": \"Provides the default type for children selection controls.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/Slider.json", "content": "{\n \"props\": {\n \"max\": \"Sets the maximum allowed value.\",\n \"min\": \"Sets the minimum allowed value.\",\n \"noKeyboard\": \"**FOR INTERNAL USE ONLY** Ignore keyboard events.\",\n \"reverse\": \"Reverses the slider direction.\",\n \"showTicks\": \"Show track ticks. If `true` it shows ticks when using slider. If set to `'always'` it always shows ticks.\",\n \"step\": \"If greater than 0, sets step interval for ticks.\",\n \"thumbColor\": \"Sets the thumb and thumb label color.\",\n \"thumbLabel\": \"Show thumb label. If `true` it shows label when using slider. If set to `'always'` it always shows label. Use `'hover'` to show label when hovering over the thumb.\",\n \"thumbSize\": \"Controls the size of the thumb label.\",\n \"ticks\": \"Show track ticks. If `true` it shows ticks when using slider. If set to `'always'` it always shows ticks.\",\n \"tickSize\": \"Controls the size of **ticks**\",\n \"trackColor\": \"Sets the track's color\",\n \"trackFillColor\": \"Sets the track's fill color\",\n \"trackSize\": \"Sets the track's size (height).\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/Stepper.json", "content": "{\n \"props\": {\n \"altLabels\": \"Places the labels beneath the step.\",\n \"editable\": \"Marks step as editable.\",\n \"hideActions\": \"Hide actions bar (prev and next buttons).\",\n \"itemProps\": \"Props object that will be applied to each item component. `true` will treat the original object as raw props and pass it directly to the component.\",\n \"itemTitle\": \"Property on supplied `items` that contains its title.\",\n \"itemValue\": \"Property on supplied `items` that contains its value.\",\n \"mobile\": \"Forces the stepper into a mobile state, removing labels from stepper items.\",\n \"nextText\": \"The text used for the Next button.\",\n \"prevText\": \"The text used for the Prev button.\",\n \"nonLinear\": \"Allow user to jump to any step.\"\n },\n \"slots\": {\n \"[`header-item.${string}`]\": \"Slot for customizing header items when using the [items](/api/v-stepper/#props-items) prop.\",\n \"[`item.${string}`]\": \"Slot for customizing the content for each step.\",\n \"actions\": \"Slot for customizing [v-stepper-actions](/api/v-stepper-actions/).\",\n \"header\": \"Slot for customizing the header.\",\n \"header-item\": \"Slot for customizing all header items.\",\n \"icon\": \"Slot for customizing all stepper item icons.\",\n \"next\": \"Slot for customizing the next step functionality\",\n \"prev\": \"Slot for customizing the prev step functionality\"\n },\n \"exposed\": {\n \"next\": \"Move to the next step.\",\n \"prev\": \"Move to the prev step.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/StepperItem.json", "content": "{\n \"props\": {\n \"complete\": \"Marks step as complete.\",\n \"completeIcon\": \"Icon to display when step is marked as completed.\",\n \"editable\": \"Marks step as editable.\",\n \"editIcon\": \"Icon to display when step is editable.\",\n \"errorIcon\": \"Icon to display when step has an error.\",\n \"error\": \"Puts the stepper item in a manual error state.\",\n \"rules\": \"Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string`.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VAlert.json", "content": "{\n \"props\": {\n \"border\": \"Adds a colored border to the component.\",\n \"borderColor\": \"Specifies the color of the border. Only used in combination with **border** prop. Accepts any color value.\",\n \"closable\": \"Adds a close icon that can hide the alert.\",\n \"closeIcon\": \"Change the default icon used for **closable** alerts.\",\n \"closeLabel\": \"Text used for *aria-label* on **closable** alerts. Can also be customized globally in [Internationalization](/customization/internationalization).\",\n \"height\": \"Sets the height for the component.\",\n \"maxHeight\": \"Sets the maximum height for the component.\",\n \"maxWidth\": \"Sets the maximum width for the component.\",\n \"minHeight\": \"Sets the minimum height for the component.\",\n \"minWidth\": \"Sets the minimum width for the component.\",\n \"modelValue\": \"Controls whether the component is visible or hidden.\",\n \"prominent\": \"Displays a larger vertically centered icon to draw more attention.\",\n \"tile\": \"Removes the component's border-radius.\",\n \"type\": \"Create a specialized alert that uses a contextual color and has a pre-defined icon.\",\n \"width\": \"Sets the width for the component.\"\n },\n \"slots\": {\n \"append\": \"Slot for icon at end of alert.\",\n \"close\": \"Slot for icon used in **dismissible** prop.\",\n \"prepend\": \"Slot for icon at beginning of alert.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VApp.json", "content": "{\n \"exposed\": {\n \"theme\": \"The instance of the injected active theme.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VAppBar.json", "content": "{\n \"props\": {\n \"collapse\": \"Morphs the component into a collapsed state, reducing its maximum width.\",\n \"extensionHeight\": \"Designate an explicit height for the `extension` slot.\",\n \"flat\": \"Removes the component's **box-shadow**.\",\n \"floating\": \"Applies **display: inline-flex** to the component.\",\n \"location\": \"Aligns the component towards the top or bottom.\",\n \"scrollBehavior\": \"Specify an action to take when the scroll position of **scroll-target** reaches **scroll-threshold**. Accepts any combination of hide, inverted, collapse, elevate, and fade-image. Multiple values can be used, separated by a space.\",\n \"scrollTarget\": \"The element to target for scrolling events. Uses `window` by default.\",\n \"scrollThreshold\": \"The amount of scroll distance down before **scroll-behavior** activates.\"\n },\n \"slots\": {\n \"extension\": \"Slot positioned directly under the main content of the toolbar. Height of this slot can be set explicitly with the **extension-height** prop.\",\n \"image\": \"Expects the [`v-img`](/components/images/) component.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VAutocomplete.json", "content": "{\n \"props\": {\n \"autoSelectFirst\": \"When searching, will always highlight the first option and select it on blur. `exact` will only highlight and select exact matches.\",\n \"clearOnSelect\": \"Reset the search text when a selection is made while using the **multiple** prop.\",\n \"itemChildren\": \"This property currently has **no effect**.\",\n \"items\": \"Can be an array of objects or strings. By default objects should have **title** and **value** properties, and can optionally have a **props** property containing any [VListItem props](/api/v-list-item/#props). Keys to use for these can be changed with the **item-title**, **item-value**, and **item-props** props.\",\n \"noFilter\": \"Do not apply filtering when searching. Useful when data is being filtered server side.\"\n },\n \"slots\": {\n \"item\": \"Define a custom item appearance. The root element of this slot must be a **v-list-item** with `v-bind=\\\"props\\\"` applied. `props` includes everything required for the default select list behaviour - including title, value, click handlers, virtual scrolling, and anything else that has been added with `item-props`.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VAvatar.json", "content": "{\n \"props\": {\n \"badge\": \"Wraps the avatar in a [VBadge](/api/v-badge/). When set to `true`, displays a dot badge. Accepts an object of VBadge props for further customization.\"\n },\n \"slots\": {\n \"badge\": \"Slot for custom badge content. When used, the badge **dot** mode is disabled.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VAvatarGroup.json", "content": "{\n \"props\": {\n \"border\": \"Applies border styles to the child [v-avatar](/components/avatars) components.\",\n \"gap\": \"Sets the overlap gap between avatars. Negative values cause avatars to overlap.\",\n \"hoverable\": \"Enables a hover animation on child avatars.\",\n \"itemProps\": \"Props object that will be applied to each item component. `true` will treat the original object as raw props and pass it directly to the component.\",\n \"limit\": \"The total number of avatars to display, including the overflow indicator. E.g. a limit of `3` with 5 items renders 2 avatars and a `+3` overflow indicator.\",\n \"overflowText\": \"Custom text to display in the overflow avatar. Defaults to `+N` where N is the number of hidden items.\",\n \"reverse\": \"Reverses the stacking order of the avatars.\",\n \"size\": \"Sets the size of all child avatars.\",\n \"vertical\": \"Stacks avatars vertically instead of horizontally.\"\n },\n \"slots\": {\n \"prepend\": \"Custom content to be displayed before the avatar list.\",\n \"append\": \"Custom content to be displayed after the avatar list.\",\n \"item\": \"Customize each avatar item. Receives `props` and `index`.\",\n \"overflow\": \"Customize the overflow indicator. Receives the count of hidden items.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VBadge.json", "content": "{\n \"props\": {\n \"bordered\": \"Applies a **2px** by default and **1.5px** border around the badge when using the **dot** property.\",\n \"content\": \"Text content to show in the badge.\",\n \"dot\": \"Reduce the size of the badge and hide its contents.\",\n \"dotSize\": \"Sets the size of the **dot** variant (includes border when using with **bordered**)\",\n \"floating\": \"Move the badge further away from the slotted content. Equivalent to an 8px offset.\",\n \"inline\": \"Display as an inline block instead of absolute position. **location**, **floating**, and **offset** will have no effect.\",\n \"label\": \"The **aria-label** used for the badge.\",\n \"max\": \"Sets the maximum number allowed when using the **content** prop with a `number` like value. If the content number exceeds the maximum value, a `+` suffix is added.\",\n \"offsetX\": \"Offset the badge on the x-axis.\",\n \"offsetY\": \"Offset the badge on the y-axis.\",\n \"modelValue\": \"Controls whether the component is visible or hidden.\"\n },\n \"slots\": {\n \"badge\": \"The slot used for the badge's content.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VBanner.json", "content": "{\n \"props\": {\n \"avatar\": \"Designates a specific src image to pass to the thumbnail.\",\n \"lines\": \"The amount of visible lines of text before it truncates.\",\n \"mobile\": \"Applies the mobile banner styles.\",\n \"sticky\": \"Applies `position: sticky` to the component with `top: 0`. You can find more information on the [MDN documentation for sticky position](https://developer.mozilla.org/en-US/docs/Web/CSS/position).\",\n \"stacked\": \"Forces the banner actions onto a new line. This is not applicable when the banner has `lines=\\\"one\\\"`.\"\n },\n \"slots\": {\n \"actions\": \"The slot used for the action's content such as a [v-btn](/components/buttons).\",\n \"prepend\": \"Slot for icon at beginning of banner.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VBottomNavigation.json", "content": "{\n \"props\": {\n \"grow\": \"Force all [v-btn](/components/buttons) children to take up all available horizontal space.\",\n \"mode\": \"Changes the orientation and active state styling of the component.\"\n },\n \"events\": {\n \"update:active\": \"Event that is emitted when the active state changes.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VBottomSheet.json", "content": "{\n \"props\": {\n \"inset\": \"Reduces the sheet content maximum width to 70%.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VBreadcrumbs.json", "content": "{\n \"props\": {\n \"divider\": \"Specifies the dividing character between items.\"\n },\n \"slots\": {\n \"divider\": \"The slot used for dividers.\",\n \"prepend\": \"The slot used for prepend content.\",\n \"title\": \"The slot used to display the title of each breadcrumb.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VBreadcrumbsDivider.json", "content": "{\n \"props\": {\n \"divider\": \"Specifies the dividing character between items.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VBtn.json", "content": "{\n \"props\": {\n \"block\": \"Expands the button to 100% of available space.\",\n \"flat\": \"Removes the button box shadow. This is different than using the 'flat' variant.\",\n \"icon\": \"Apply a specific icon using the [v-icon](/components/icons/) component. The button will become _round_.\",\n \"readonly\": \"Puts the button in a readonly state. Cannot be clicked or navigated to by keyboard.\",\n \"stacked\": \"Displays the button as a flex-column.\",\n \"spaced\": \"Extends content to the edges to move main content from prepend and append slots.\",\n \"slim\": \"Reduces padding to 0 8px.\"\n },\n \"exposed\": {\n \"group\": \"Internal representation when used in VBtnToggle.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VBtnGroup.json", "content": "{\n \"props\": {\n \"direction\": \"Control how children components are arranged - in a row or column.\",\n \"divided\": \"Add dividers between children [v-btn](/components/buttons) components.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VBtnToggle.json", "content": "{\n \"props\": {\n \"rounded\": \"Round edge buttons.\",\n \"tile\": \"Removes the component's border-radius.\"\n },\n \"exposed\": {\n \"next\": \"Activates the next button.\",\n \"prev\": \"Activates the previous button.\",\n \"select\": \"Selects a button by index, the second parameter is a boolean to indicate if the button should be selected or not.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VCalendar.json", "content": "{\n \"props\": {\n \"categories\": \"Specifies what categories to display in the `category` view. This controls the order of the categories as well. If the calendar uses events any categories specified in those events not specified in this value are dynamically rendered in the view unless `category-hide-dynamic` is true.\",\n \"categoryHideDynamic\": \"Sets whether categories specified in an event should be hidden if it's not defined in `categories`.\",\n \"categoryShowAll\": \"Set whether the `category` view should show all defined `categories` even if there are no events for a category.\",\n \"categoryForInvalid\": \"The category to place events in that have invalid categories. A category is invalid when it is not a string. By default events without a category are not displayed until this value is specified.\",\n \"categoryDays\": \"The number of days to render in the `category` view.\",\n \"categoryText\": \"If categories is a list of objects, you can use this to determine what property to print out as the category text on the calendar. You can provide a function to do some logic or just define the prop name. It's similar to item-text on v-select\",\n \"dayFormat\": \"Formats day of the month string that appears in a day to a specified locale\",\n \"end\": \"The ending date on the calendar (inclusive) in the format of `YYYY-MM-DD`. This may be ignored depending on the `type` of the calendar.\",\n \"eventCategory\": \"Set property of *event*'s category. Instead of a property a function can be given which takes an event and returns the category.\",\n \"eventColor\": \"A background color for all events or a function which accepts an event object passed to the calendar to return a color.\",\n \"eventEnd\": \"Set property of *event*'s end timestamp.\",\n \"eventHeight\": \"The height of an event in pixels in the `month` view and at the top of the `day` views.\",\n \"eventMarginBottom\": \"Margin bottom for event\",\n \"eventMore\": \"Whether the more 'button' is displayed on a calendar with too many events in a given day. It will say something like '5 more' and when clicked generates a `click:more` event.\",\n \"eventMoreText\": \"The text to display in the more 'button' given the number of hidden events.\",\n \"eventName\": \"Set property of *event*'s displayed name, or a function which accepts an event object passed to the calendar as the first argument and a flag signalling whether the name is for a timed event (true) or an event over a day.\",\n \"eventOverlapMode\": \"One of `stack`, `column`, or a custom render function\",\n \"eventOverlapThreshold\": \"A value in minutes that's used to determine whether two timed events should be placed in column beside each other or should be treated as slightly overlapping events.\",\n \"eventRipple\": \"Applies the `v-ripple` directive.\",\n \"events\": \"An array of event objects with a property for a start timestamp and optionally a name and end timestamp. If an end timestamp is not given, the value of start will be used. If no name is given, you must provide an implementation for the `event` slot.\",\n \"eventStart\": \"Set property of *event*'s start timestamp.\",\n \"eventTextColor\": \"A text color for all events or a function which accepts an event object passed to the calendar to return a color.\",\n \"eventTimed\": \"If Dates or milliseconds are used as the start or end timestamp of an event, this prop can be a string to a property on the event that is truthy if the event is a timed event or a function which takes the event and returns a truthy value if the event is a timed event.\",\n \"firstInterval\": \"The first interval to display in the `day` view. If `intervalMinutes` is set to 60 and this is set to 9 the first time in the view is 9am.\",\n \"firstTime\": \"The first time to display in the `day` view. If specified, this overwrites any `firstInterval` value specified. This can be the number of minutes since midnight, a string in the format of `HH:mm`, or an object with number properties hour and minute.\",\n \"hideHeader\": \"If the header at the top of the `day` view should be visible.\",\n \"intervalCount\": \"The number of intervals to display in the `day` view.\",\n \"intervalFormat\": \"Formats time of day string that appears in the interval gutter of the `day` and `week` view to specified locale\",\n \"intervalHeight\": \"The height of an interval in pixels in the `day` view.\",\n \"intervalWidth\": \"The width of the interval gutter on the left side in the `day` view.\",\n \"intervalMinutes\": \"The number of minutes the intervals are in the `day` view. A common interval is 60 minutes so the intervals are an hour.\",\n \"intervalStyle\": \"Returns CSS styling to apply to the interval.\",\n \"locale\": \"The locale of the calendar.\",\n \"maxDays\": \"The maximum number of days to display in the custom calendar if an `end` day is not set.\",\n \"minWeeks\": \"The minimum number of weeks to display in the `month` or `week` view.\",\n \"monthFormat\": \"Formats month string that appears in a day to specified locale\",\n \"now\": \"Override the day & time which is considered now. This is in the format of `YYYY-MM-DD hh:mm:ss`. The calendar is styled according to now.\",\n \"shortIntervals\": \"If true, the intervals in the `day` view will be 9 AM as opposed to 09:00 AM\",\n \"shortMonths\": \"Whether the short versions of a month should be used (Jan vs January).\",\n \"shortWeekdays\": \"Whether the short versions of a weekday should be used (Mon vs Monday).\",\n \"showIntervalLabel\": \"Checks if a given day and time should be displayed in the interval gutter of the `day` view.\",\n \"showMonthOnFirst\": \"Whether the name of the month should be displayed on the first day of the month.\",\n \"showWeek\": \"Whether week numbers should be displayed when using the `month` view.\",\n \"start\": \"The starting date on the calendar (inclusive) in the format of `YYYY-MM-DD`. This may be ignored depending on the `type` of the calendar.\",\n \"type\": \"A string which is one of `month`, `week`, `day`, `4day`, `custom-weekly`, `custom-daily`, and `category`. The custom types look at the `start` and `end` dates passed to the component as opposed to the `value`.\",\n \"v-model\": \"Sets the `value` property but also updates it when the link of a day is clicked.\",\n \"value\": \"A date in the format of `YYYY-MM-DD` which determines what span of time for the calendar.\",\n \"weekdayFormat\": \"Formats day of the week string that appears in the header to specified locale\"\n },\n \"slots\": {\n \"category\": \"The content placed in a category header for the `category` type. The category variable is null for events with invalid (non-string) categories.\",\n \"day-body\": \"The content that is placed in a `day` view in the scrollable interval container. The day & time object is passed through this slots scope.\",\n \"day-header\": \"The content that is placed in a `day` view in the top container. The day & time object is passed through this slots scope.\",\n \"day-label\": \"The content that is placed in the day of the month space in the `custom-weekly` or `month` view. The day & time object is passed through this slots scope.\",\n \"day-label-header\": \"The content that is placed in the day of the month space in the `week`, `day`, `4day`, or `custom-daily` view. The day & time object is passed through this slots scope.\",\n \"day-month\": \"The content that is placed in the month space in the `week` or `month` view. The day & time object is passed through this slots scope.\",\n \"day\": \"The content that is placed in a `week` or `month` view. The day & time object is passed through this slots scope.\",\n \"event\": \"The content placed in an event. This ignores the `event-name` prop.\",\n \"interval\": \"The content that is placed in the interval space in the `day` view. The day & time object is passed through this slots scope.\",\n \"interval-header\": \"The content that is placed in the interval space in the top left of the `day` view.\"\n },\n \"events\": {\n \"[`${string}:date`]\": \"Any event on the day of the month link. The second argument is the day & time object.\",\n \"[`${string}:dayCategory`]\": \"Any event on a day in the `category` view. The second argument is the day object.\",\n \"[`${string}:day`]\": \"Any event on a day. The second argument is the day object.\",\n \"[`${string}:event`]\": \"Any event on a specific event. The second argument is the day & time object.\",\n \"[`${string}:interval`]\": \"Any event at a specific interval label in the `day` view. The second argument is the day & time object.\",\n \"[`${string}:more`]\": \"Any event on the `X more` button on views with too many events in a day. The second argument is the day & time object.\",\n \"[`${string}:timeCategory`]\": \"Any event at a specific time in the `category` view. The second argument is the day & time object.\",\n \"[`${string}:time`]\": \"Any event at a specific time in the `day` view. The second argument is the day & time object.\",\n \"change\": \"The range of days displayed on the calendar changed. This is triggered on initialization. The event passed is an object with start and end date objects.\",\n \"moved\": \"One of the functions `next`, `prev`, and `move` was called. The event passed is the day object calculated for the movement.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VCard.json", "content": "{\n \"props\": {\n \"flat\": \"Removes the card's elevation.\",\n \"hover\": \"Applies **3dp** (level 2) of elevation when hovered (default 1dp). You can find more information on the [elevation page](/styles/elevation).\",\n \"image\": \"Apply a specific background image to the component.\",\n \"prependIcon\": \"Prepends a [v-icon](/components/icons/) component to the header.\"\n },\n \"slots\": {\n \"actions\": \"The slot used for the card actions; located at the bottom of the card.\",\n \"image\": \"The slot used for the card image. This is used with the [image](#props-image) prop.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VCarousel.json", "content": "{\n \"props\": {\n \"color\": \"Applies a color to the navigation dots - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors).\",\n \"continuous\": \"Determines whether carousel is continuous.\",\n \"cycle\": \"Determines if the carousel should cycle through images.\",\n \"delimiterIcon\": \"Sets icon for carousel delimiter.\",\n \"hideDelimiters\": \"Hides the carousel's bottom delimiters.\",\n \"hideDelimiterBackground\": \"Hides the bottom delimiter background.\",\n \"interval\": \"The duration between image cycles. Requires the **cycle** prop.\",\n \"nextIcon\": \"The displayed icon for forcing pagination to the next item.\",\n \"prevIcon\": \"The displayed icon for forcing pagination to the previous item.\",\n \"progress\": \"Displays a carousel progress bar. Requires the **cycle** prop and **interval**.\",\n \"showArrows\": \"Displays arrows for next/previous navigation.\",\n \"verticalArrows\": \"Displays the navigation arrows vertically instead of horizontally.\",\n \"verticalDelimiters\": \"Displays carousel delimiters vertically.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VCheckbox.json", "content": "{\n \"props\": {\n \"falseIcon\": \"The icon used when inactive.\",\n \"indeterminate\": \"Sets an indeterminate state for the checkbox.\",\n \"indeterminateIcon\": \"The icon used when in an indeterminate state.\",\n \"multiple\": \"Changes expected model to an array.\",\n \"trueIcon\": \"The icon used when active.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VCheckboxBtn.json", "content": "{\n \"props\": {\n \"indeterminate\": \"Puts the control in an indeterminate state. Used with the [indeterminate-icon](#props-indeterminate-icon) property.\",\n \"indeterminateIcon\": \"Icon used when the component is in an indeterminate state.\"\n },\n \"events\": {\n \"update:indeterminate\": \"Event that is emitted when the component's indeterminate state changes.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VChip.json", "content": "{\n \"props\": {\n \"closable\": \"Adds remove button and then a chip can be closed.\",\n \"closeIcon\": \"Change the default icon used for **close** chips.\",\n \"closeLabel\": \"Text used for *aria-label* on the close button in **close** chips. Can also be customized globally in [Internationalization](/customization/internationalization).\",\n \"draggable\": \"Makes the chip draggable.\",\n \"filter\": \"Displays a selection icon when selected.\",\n \"filterIcon\": \"Change the default icon used for **filter** chips.\",\n \"label\": \"Applies a medium size border radius.\",\n \"pill\": \"Remove `v-avatar` padding.\",\n \"size\": \"Sets the height, padding and the font size of the component. Accepts only predefined options: **x-small**, **small**, **default**, **large**, and **x-large**.\",\n \"value\": \"The value used when a child of a [v-chip-group](/components/chip-groups).\"\n },\n \"events\": {\n \"click\": \"Emitted when component is clicked, toggles chip if contained in a chip group - Will trigger component to ripple when clicked unless the `.native` modifier is used.\"\n },\n \"slots\": {\n \"close\": \"Slot for icon used in **close** prop.\",\n \"filter\": \"Slot for icon used in **filter** prop.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VChipGroup.json", "content": "{\n \"props\": {\n \"baseColor\": \"Sets the color of component when not focused. Recommended with `color` or `filter` to properly highlight selected items.\",\n \"centerActive\": \"Forces the selected chip to be centered.\",\n \"column\": \"Remove horizontal pagination and wrap items as needed.\",\n \"filter\": \"Applies an checkmark icon in front of every chip for using it like a filter.\",\n \"nextIcon\": \"Specify the icon to use for the next icon.\",\n \"prevIcon\": \"Specify the icon to use for the prev icon.\",\n \"showArrows\": \"Force the display of the pagination arrows.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VCol.json", "content": "{\n \"props\": {\n \"alignSelf\": \"Deprecated, use **align-self-\\\\*** class. Available options are: **start**, **center**, **end**, **auto**, **baseline** and **stretch**.\",\n \"cols\": \"Sets the default number of columns the component extends. Available options are: **1 -> 12** and **auto**. It accepts `{n}/{size}` syntax (e.g. 1/5 or 3/24) that overrides grid columns count for size calculation.\",\n \"lg\": \"Changes the number of columns on large and greater breakpoints.\",\n \"md\": \"Changes the number of columns on medium and greater breakpoints.\",\n \"offset\": \"Sets the default offset for the column. Similarly to **cols**, accepts `{n}/{size}` syntax (e.g. 1/5 or 3/24).\",\n \"offsetLg\": \"Changes the offset of the component on large and greater breakpoints.\",\n \"offsetMd\": \"Changes the offset of the component on medium and greater breakpoints.\",\n \"offsetSm\": \"Changes the offset of the component on small and greater breakpoints.\",\n \"offsetXl\": \"Changes the offset of the component on extra large and greater breakpoints.\",\n \"offsetXxl\": \"Changes the offset of the component on extra extra large and greater breakpoints.\",\n \"order\": \"Deprecated, use **order-\\\\*** class\",\n \"orderLg\": \"Deprecated, use **order-lg-\\\\*** class\",\n \"orderMd\": \"Deprecated, use **order-md-\\\\*** class\",\n \"orderSm\": \"Deprecated, use **order-sm-\\\\*** class\",\n \"orderXl\": \"Deprecated, use **order-xl-\\\\*** class\",\n \"orderXxl\": \"Deprecated, use **order-xxl-\\\\*** class\",\n \"sm\": \"Changes the number of columns on small and greater breakpoints.\",\n \"xl\": \"Changes the number of columns on extra large and greater breakpoints.\",\n \"xxl\": \"Changes the number of columns on extra extra large and greater breakpoints.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VColorInput.json", "content": "{\n \"props\": {\n \"hidePip\": \"Hide pip icon\",\n \"colorPip\": \"Synchronize pip color with current value\",\n \"pipIcon\": \"The icon used for pip\",\n \"pipLocation\": \"Move pip icon to a different slot\",\n \"pipVariant\": \"Variant of the pip control\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VColorPicker.json", "content": "{\n \"props\": {\n \"canvasHeight\": \"Height of canvas.\",\n \"dotSize\": \"Changes the size of the selection dot on the canvas.\",\n \"eyeDropperIcon\": \"Icon used to trigger EyeDropper API.\",\n \"hideCanvas\": \"Hides canvas.\",\n \"hideEyeDropper\": \"Hides eyedropper icon.\",\n \"hideSliders\": \"Hides sliders.\",\n \"hideInputs\": \"Hides inputs.\",\n \"mode\": \"The current selected input type. Syncable with `v-model:mode`.\",\n \"modes\": \"Sets available input types.\",\n \"readonly\": \"Puts the color picker in a readonly state.\",\n \"showSwatches\": \"Displays color swatches.\",\n \"swatches\": \"Sets the available color swatches to select from. 2D array of rows and columns, accepts any color format the picker does.\",\n \"swatchesMaxHeight\": \"Sets the maximum height of the swatches section.\",\n \"width\": \"Sets the width of the color picker.\"\n },\n \"events\": {\n \"update:mode\": \"Selected mode.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VCombobox.json", "content": "{\n \"props\": {\n \"alwaysFilter\": \"When enabled, dropdown list will always show items matching non-empty value within the field. Recommended when the list is meant to show suggestions rather than options to choose from. For optimal UX, should be combined with `:menu-icon=\\\"false\\\"` and `hide-selected`.\",\n \"autoSelectFirst\": \"When searching, will always highlight the first option and select it on blur. `exact` will only highlight and select exact matches.\",\n \"clearOnSelect\": \"Reset the search text when a selection is made while using the **multiple** prop.\",\n \"itemChildren\": \"This property currently has **no effect**.\",\n \"delimiters\": \"Accepts an array of strings that will trigger a new tag when typing. Does not replace the normal Tab and Enter keys.\",\n \"items\": \"Can be an array of objects or strings. By default objects should have **title** and **value** properties, and can optionally have a **props** property containing any [VListItem props](/api/v-list-item/#props). Keys to use for these can be changed with the **item-title**, **item-value**, and **item-props** props.\"\n },\n \"slots\": {\n \"item\": \"Define a custom item appearance. The root element of this slot must be a **v-list-item** with `v-bind=\\\"props\\\"` applied. `props` includes everything required for the default select list behaviour - including title, value, click handlers, virtual scrolling, and anything else that has been added with `item-props`.\"\n },\n \"exposed\": {\n \"selectionIndex\": \"The index of the currently selected item.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VCommandPalette.json", "content": "{\n \"props\": {\n \"closeOnSelect\": \"Controls whether the palette closes automatically after selecting an actionable item. Set to **false** to keep it open for external drill-in and nested navigation flows.\",\n \"hotkey\": \"Global keyboard shortcut to toggle the palette. Accepts hotkey strings like `'ctrl+shift+p'` or `'meta+j'`. The shortcut is automatically registered on mount and cleaned up on unmount.\",\n \"inputIcon\": \"Icon to display at the start of the search input field.\",\n \"items\": \"Array of command palette items. Objects should have **title** and optionally **subtitle**, **prependIcon**, **appendIcon**, **prependAvatar**, **appendAvatar**, **hotkey**, **onClick**, **to**, **href**, and **value** properties. Use `type: 'subheader'` with a **title** for section headers, or `type: 'divider'` for visual separators between groups.\",\n \"listProps\": \"Pass props through to the `v-list` component. Accepts an object with anything from [v-list](/api/v-list/#props) props, camelCase keys are recommended.\",\n \"modelValue\": \"Controls the visibility of the command palette dialog. Use `v-model` for two-way binding.\",\n \"noDataText\": \"Text displayed when no items match the current search query.\",\n \"placeholder\": \"Placeholder text displayed in the search input.\",\n \"search\": \"The current search query. Use `v-model:search` to control or monitor the search input value.\"\n },\n \"events\": {\n \"before-select\": \"Emitted before the default auto-close behavior for actionable item selection. The payload includes the selected item, the triggering event, and a **preventDefault** callback. Call **preventDefault()** to keep the palette open.\",\n \"click:item\": \"Emitted when an item is clicked or activated via Enter key. The payload includes the selected item object and the triggering event (MouseEvent or KeyboardEvent).\",\n \"update:modelValue\": \"Emitted when the dialog visibility changes.\",\n \"update:search\": \"Emitted when the search query changes.\"\n },\n \"slots\": {\n \"prepend\": \"Content to render above the search input, inside the command palette card. Useful for headers, breadcrumbs, or instructions.\",\n \"input\": \"Custom search input field. Replaces the default **v-text-field**. Useful for providing a completely custom search implementation.\",\n \"input.append-inner\": \"Content appended inside the search input field. Useful for adding icons or buttons within the input.\",\n \"append\": \"Content to render below the items list, inside the command palette card. Useful for footers, keyboard shortcut hints, or additional actions.\",\n \"no-data\": \"Custom content to display when no items match the search query. Replaces the default no-data message.\",\n \"list.prepend\": \"Content to prepend to the list component.\",\n \"list.subheader\": \"Slot for customizing the rendering of subheader items in the list.\",\n \"item.prepend\": \"Content to display before each item's title.\",\n \"item.title\": \"Slot for customizing the title of each item.\",\n \"item.append\": \"Content to display after each item's title, replaces hotkey (if provided).\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VCommandPaletteItem.json", "content": "{\n \"props\": {\n \"item\": \"The command palette item data object.\",\n \"index\": \"The index of the item within the command palette list.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VConfirmEdit.json", "content": "{\n \"props\": {\n \"modelValue\": \"Represents the committed v-model value\",\n \"cancelText\": \"Text for the cancel button\",\n \"okText\": \"Text for the ok button\",\n \"hideActions\": \"Prevent showing the default actions buttons. Does not affect ``\",\n \"disabled\": \"Control the disabled state of action buttons. If not provided, internal logic will be used to determine the disabled state.\"\n },\n \"events\": {\n \"save\": \"The event emitted when the user clicks the Save button\",\n \"cancel\": \"The event emitted when the user clicks the Cancel button\"\n },\n \"exposed\": {\n \"save\": \"Manually commit the change\",\n \"cancel\": \"Manually cancel the change\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VContainer.json", "content": "{\n \"props\": {\n \"fluid\": \"Removes viewport maximum-width size breakpoints.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VCounter.json", "content": "{\n \"props\": {\n \"active\": \"Determines whether the counter is visible or not.\",\n \"max\": \"Sets the maximum allowed value.\",\n \"value\": \"Sets the current counter value.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDataIterator.json", "content": "{\n \"props\": {\n \"customFilter\": \"Function to filter items.\",\n \"expanded\": \"Array of expanded items. Can be bound to external variable using **v-model:expanded**.\",\n \"groupBy\": \"Configures attributes (and sort order) to group items together.\",\n \"initialSortOrder\": \"Specifies the initial sort order when an **toggleSort** is called for unsorted property.\",\n \"itemsPerPage\": \"Changes how many items per page should be visible. Can be bound to external variable using **v-model:itemsPerPage**.. Setting this prop to `-1` will display all items on the page.\",\n \"itemsLength\": \"The total number of items. Useful when using server-side pagination to correctly compute page counts.\",\n \"loading\": \"If `true` and no items are provided, then a loading text will be shown.\",\n \"search\": \"Text input used to filter items.\"\n },\n \"slots\": {\n \"default\": \"The default slot. Use this to render your items.\",\n \"footer\": \"Defines a footer below the items.\",\n \"header\": \"Defines a header above the items.\",\n \"no-data\": \"Defines content for when no items are provided.\"\n },\n \"events\": {\n \"update:currentItems\": \"Emits with the items currently being displayed.\",\n \"update:expanded\": \"Emits when the **expanded** items are updated.\",\n \"update:groupBy\": \"Emits when the **group-by** prop is updated.\",\n \"update:itemsPerPage\": \"Emits when the **items-per-page** prop is updated.\",\n \"update:options\": \"Emits when pagination related properties (page, itemsPerPage, sortBy, groupBy, search) is updated.\",\n \"update:page\": \"Emits when the **page** prop is updated.\",\n \"update:sortBy\": \"Emits when the **sortBy** prop is updated.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDataTable.json", "content": "{\n \"props\": {\n \"collapseIcon\": \"Icon to display when the expandable row is expanded.\",\n \"customFilter\": \"Function to filter items.\",\n \"density\": \"Adjusts the vertical height of the table rows.\",\n \"expandIcon\": \"Icon to display when the expandable row is collapsed.\",\n \"fixedHeader\": \"Fixed header to top of table.\",\n \"groupBy\": \"Configures attributes (and sort order) to group items together. Can be customized further with `group-header` and `group-summary` slots.\",\n \"groupCollapseIcon\": \"Icon to display when the row group is expanded.\",\n \"groupExpandIcon\": \"Icon to display when the row group is collapsed.\",\n \"headerProps\": \"Pass props to the default header. See [`v-data-table-headers` API](/api/v-data-table-headers) for more information.\",\n \"headers\": \"An array of objects that each describe a header column.\",\n \"height\": \"Set an explicit height of table.\",\n \"hover\": \"Adds a hover effects to a table rows.\",\n \"itemsPerPage\": \"Changes how many items per page should be visible. Can be bound to external variable using **v-model:itemsPerPage**.. Setting this prop to `-1` will display all items on the page.\",\n \"page\": \"The current displayed page number (1-indexed).\",\n \"showSelect\": \"Shows the select checkboxes in both the header and rows (if using default rows).\",\n \"showExpand\": \"Shows the expand toggle in default rows.\",\n \"sortBy\": \"Changes which item property (or properties) should be used for sort order. Can be bound to external variable using **v-model:sortBy**..\"\n },\n \"slots\": {\n \"[`header.${string}`]\": \"Slot for custom rendering of a header cell.\",\n \"[`item.${string}`]\": \"Slot for custom rendering of a row cell.\",\n \"header.data-table-expand\": \"Slot to replace the default `v-icon` used when expanding header.\",\n \"body\": \"Slot to replace the default table ``.\",\n \"body.append\": \"Appends elements to the end of the default table ``.\",\n \"body.prepend\": \"Prepends elements to the start of the default table ``.\",\n \"bottom\": \"Slot for custom rendering of a data table footer.\",\n \"colgroup\": \"Slot to replace the default rendering of the `` element.\",\n \"footer.prepend\": \"Adds content to the empty space in the footer.\",\n \"group-header\": \"Slot for custom rendering of a group header.\",\n \"group-summary\": \"Slot for custom rendering of a group summary.\",\n \"header.\": \"Slot to customize a specific header column.\",\n \"header.data-table-select\": \"Slot to replace the default `v-checkbox-btn` in header.\",\n \"headers\": \"An array of objects that each describe a header column.\",\n \"item\": \"Slot to replace the default rendering of a row.\",\n \"item.data-table-select\": \"Slot to replace the default `v-checkbox-btn` used when selecting rows.\",\n \"item.data-table-expand\": \"Slot to replace the default `v-icon` used when expanding rows.\",\n \"item.\": \"Slot to customize a specific column.\",\n \"loading\": \"Defines content for when `loading` is true and no items are provided.\",\n \"tbody\": \"Slot to replace the default table ``.\",\n \"thead\": \"Slot to replace the default table ``.\",\n \"tfoot\": \"Slot to replace the default table ``.\",\n \"no-data\": \"Defines content for when no items are provided.\",\n \"top\": \"Slot to add content above the table.\"\n },\n \"events\": {\n \"click:row\": \"Emits when a table row is clicked. This event provides 2 arguments: the first is the native click event, and the second is an object containing the corresponding item for that row. **NOTE:** will not emit when table rows are defined through a slot such as `item` or `body`.\",\n \"contextmenu:row\": \"Emits when a table row is right-clicked. The item for the row is included. **NOTE:** will not emit when table rows are defined through a slot such as `item` or `body`.\",\n \"dblclick:row\": \"Emits when a table row is double-clicked. The item for the row is included. **NOTE:** will not emit when table rows are defined through a slot such as `item` or `body`.\",\n \"update:currentItems\": \"Emits with the items currently being displayed.\",\n \"update:groupBy\": \"Emits when the **group-by** prop is updated.\",\n \"update:itemsPerPage\": \"Emits when the **items-per-page** prop is updated.\",\n \"update:modelValue\": \"Emits when the component's model changes.\",\n \"update:options\": \"Emits when pagination related properties (page, itemsPerPage, sortBy, groupBy, search) is updated.\",\n \"update:page\": \"Emits when the **page** prop is updated.\",\n \"update:sortBy\": \"Emits when the **sortBy** prop is updated.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDataTableFooter.json", "content": "{\n \"props\": {\n \"firstIcon\": \"First icon.\",\n \"firstPageLabel\": \"Label for first page.\",\n \"itemsPerPageOptions\": \"Array of options to show in the items-per-page dropdown.\",\n \"itemsPerPageText\": \"Text for items-per-page dropdown.\",\n \"lastIcon\": \"Last icon.\",\n \"lastPageLabel\": \"Label for last page.\",\n \"nextIcon\": \"Next icon.\",\n \"nextPageLabel\": \"Label for next page.\",\n \"pageText\": \"Label for page number.\",\n \"prevIcon\": \"Previous icon.\",\n \"prevPageLabel\": \"Label for previous page.\",\n \"showCurrentPage\": \"Show current page number between prev/next icons.\"\n },\n \"slots\": {\n \"prepend\": \"Extra content placed before the default pagination.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDataTableHeaders.json", "content": "{\n \"props\": {\n \"color\": \"Applies a color to checkboxes, page size dropdown and sort badges in the table header.\",\n \"sortIcon\": \"Icon used for unsorted columns. By default it uses either **sortAscIcon** or **sortDescIcon** depending on **initialSortOrder**, but can be customized to show a neutral icon instead.\",\n \"sortAscIcon\": \"Icon used for ascending sort button.\",\n \"sortDescIcon\": \"Icon used for descending sort button.\",\n \"sticky\": \"Deprecated, use `fixed-header` instead.\",\n \"fixedHeader\": \"Sticks the header to the top of the table.\",\n \"headerProps\": \"Additional props to be be passed to the default header\"\n },\n \"slots\": {\n \"[`column.${string}`]\": \"Slot for custom rendering of a column.\",\n \"[`header.${string}`]\": \"Slot for custom rendering of a header cell.\",\n \"header.data-table-expand\": \"Slot for the expand button in the header.\",\n \"header.data-table-select\": \"Slot for the select-all checkbox in the header.\",\n \"headers\": \"Slot to replace the default rendering of the `` element.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDataTableRow.json", "content": "{\n \"props\": {\n \"cellProps\": \"Props to be applied to the cell.\",\n \"collapseIcon\": \"Icon to display when the expandable row is expanded.\",\n \"expandIcon\": \"Icon to display when the expandable row is collapsed.\",\n \"index\": \"Row index.\",\n \"item\": \"Data (key, index and column values) of the displayed item.\"\n },\n \"events\": {\n \"contextmenu\": \"The event emitted when the user clicks the context menu button.\",\n \"dblclick\": \"The event emitted when the user double clicks the row.\",\n \"[`item.${string}`]\": \"The event emitted when the user clicks the item.\"\n },\n \"slots\": {\n \"[`header.${string}`]\": \"Slot for custom rendering of a header cell.\",\n \"[`item.${string}`]\": \"Slot for custom rendering of a row cell.\",\n \"header.data-table-expand\": \"Slot to replace the default `v-icon` used when expanding header.\",\n \"header.data-table-select\": \"Slot to replace the default `v-checkbox-btn` in header.\",\n \"item.data-table-expand\": \"Slot for the expand button in the row.\",\n \"item.data-table-select\": \"Slot for the select checkbox in the row.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDataTableRows.json", "content": "{\n \"props\": {\n \"cellProps\": \"An object of additional props to be passed to each `` in the table body. Also accepts a function that will be called for each cell. If the same prop is defined both here and in `cellProps` in a headers object, the value from the headers object will be used.\",\n \"loading\": \"Displays `loading` slot if set to `true`\",\n \"loadingText\": \"Text shown when the data is loading.\",\n \"rowProps\": \"An object of additional props to be passed to each `` in the table body. Also accepts a function that will be called for each row.\"\n },\n \"slots\": {\n \"[`header.${string}`]\": \"Slot for custom rendering of a header cell.\",\n \"header.data-table-expand\": \"Slot to replace the default `v-icon` used when expanding header.\",\n \"header.data-table-select\": \"Slot to replace the default `v-checkbox-btn` in header.\",\n \"[`item.${string}`]\": \"Slot for custom rendering of a column.\",\n \"data-table-group\": \"Slot for custom rendering of a group.\",\n \"data-table-select\": \"Slot for custom rendering of a header cell with the select checkbox.\",\n \"expanded-row\": \"Slot for custom rendering of an expanded row.\",\n \"group-header\": \"Slot for custom rendering of a group header.\",\n \"group-summary\": \"Slot for custom rendering of a group summary.\",\n \"item.data-table-expand\": \"Slot for custom rendering of a row cell with the expand icon.\",\n \"item.data-table-select\": \"Slot for custom rendering of a row cell with the select checkbox.\",\n \"loading\": \"Slot for custom rendering of the loading state.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDataTableServer.json", "content": "{\n \"props\": {\n \"itemsLength\": \"Number of all items.\",\n \"headerProps\": \"Pass props to the default header. See [`v-data-table-server` API](/api/v-data-table-server) for more information.\"\n },\n \"slots\": {\n \"[`header.${string}`]\": \"Slot for a specific header. See [`v-data-table-server` API](/api/v-data-table-server) for more information.\",\n \"[`column.${string}`]\": \"Slot for custom rendering of a column.\",\n \"[`item.${string}`]\": \"Slot for custom rendering of a row cell.\",\n \"body\": \"Slot to replace the default rendering of the `` element.\",\n \"body.append\": \"Adds content to the empty space in the body.\",\n \"body.prepend\": \"Adds content to the empty space in the body.\",\n \"header.data-table-expand\": \"Slot for the expand button in the header.\",\n \"header.data-table-select\": \"Slot for the select-all checkbox in the header.\",\n \"bottom\": \"Slot to add content below the table.\",\n \"colgroup\": \"Slot to replace the default rendering of the `` element.\",\n \"data-table-select\": \"Slot for custom rendering of a header cell with the select checkbox.\",\n \"expanded-row\": \"Slot for custom rendering of an expanded row.\",\n \"footer.prepend\": \"Adds content to the empty space in the footer.\",\n \"group-header\": \"Slot for custom rendering of a group header.\",\n \"group-summary\": \"Slot for custom rendering of a group summary.\",\n \"headers\": \"Slot to replace the default rendering of the `` element.\",\n \"item\": \"Slot to replace the default rendering of a row.\",\n \"item.data-table-expand\": \"Slot to replace the default `v-icon` used when expanding rows.\",\n \"item.data-table-select\": \"Slot to replace the default checkbox used when selecting rows.\",\n \"loading\": \"Defines content for when `loading` is true and no items are provided.\",\n \"tbody\": \"Slot to replace the default rendering of the `` element.\",\n \"tfoot\": \"Slot to replace the default rendering of the `` element.\",\n \"thead\": \"Slot to replace the default rendering of the `` element.\",\n \"top\": \"Slot to add content above the table.\"\n },\n \"events\": {\n \"click:row\": \"Emits when a table row is clicked. This event provides 2 arguments: the first is the native click event, and the second is an object containing the corresponding item for that row. **NOTE:** will not emit when table rows are defined through a slot such as `item` or `body`.\",\n \"update:expanded\": \"Emits when the **expanded** prop is updated.\",\n \"update:groupBy\": \"Emits when the **group-by** prop is updated.\",\n \"update:itemsPerPage\": \"Emits when the **items-per-page** prop is updated.\",\n \"update:modelValue\": \"Emits when the component's model changes.\",\n \"update:options\": \"Emits when pagination related properties (page, itemsPerPage, sortBy, groupBy, search) is updated.\",\n \"update:page\": \"Emits when the **page** prop is updated.\",\n \"update:sortBy\": \"Emits when the **sortBy** prop is updated.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDataTableVirtual.json", "content": "{\n \"props\": {\n \"headerProps\": \"Pass props to the default header.\",\n \"itemKey\": \"The property on each item that is used as a unique key.\"\n },\n \"slots\": {\n \"[`header.${string}`]\": \"Slot for a specific header. See [`v-data-table-virtual` API](/api/v-data-table-virtual) for more information.\",\n \"[`column.${string}`]\": \"Slot for custom rendering of a column.\",\n \"[`item.${string}`]\": \"Slot for custom rendering of a row cell.\",\n \"header.data-table-expand\": \"Slot for the expand button in the header.\",\n \"header.data-table-select\": \"Slot for the select-all checkbox in the header.\",\n \"body.append\": \"Slot to add content below the table.\",\n \"body.prepend\": \"Slot to add content above the table.\",\n \"bottom\": \"Slot to add content below the table.\",\n \"colgroup\": \"Slot to replace the default rendering of the `` element.\",\n \"data-table-group\": \"Slot for custom rendering of a group.\",\n \"data-table-select\": \"Slot for custom rendering of a header cell with the select checkbox.\",\n \"expanded-row\": \"Slot for custom rendering of an expanded row.\",\n \"group-header\": \"Slot for custom rendering of a group header.\",\n \"group-summary\": \"Slot for custom rendering of a group summary.\",\n \"headers\": \"Slot to replace the default rendering of the `` element.\",\n \"item\": \"Slot to replace the default rendering of a row.\",\n \"item.data-table-expand\": \"Slot to replace the default `v-icon` used when expanding rows.\",\n \"item.data-table-select\": \"Slot to replace the default checkbox used when selecting rows.\",\n \"loading\": \"Defines content for when `loading` is true and no items are provided.\",\n \"tbody\": \"Slot to replace the default table ``.\",\n \"thead\": \"Slot to replace the default table ``.\",\n \"tfoot\": \"Slot to replace the default table ``.\",\n \"top\": \"Slot to add content above the table\"\n },\n \"events\": {\n \"click:row\": \"Emits when a table row is clicked. This event provides 2 arguments: the first is the native click event, and the second is an object containing the corresponding item for that row. **NOTE:** will not emit when table rows are defined through a slot such as `item` or `body`.\",\n \"update:expanded\": \"Emits when the **expanded** prop is updated.\",\n \"update:groupBy\": \"Emits when the **group-by** prop is updated.\",\n \"update:modelValue\": \"Emits when the component's model changes.\",\n \"update:options\": \"Emits when pagination related properties (page, itemsPerPage, sortBy, groupBy, search) is updated.\",\n \"update:sortBy\": \"Emits when the **sortBy** prop is updated.\"\n },\n \"exposed\": {\n \"calculateVisibleItems\": \"Trigger updating the currently rendered items based on scroll position.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDateInput.json", "content": "{\n \"props\": {\n \"hideActions\": \"Hide the Cancel and OK buttons, and automatically update the value when a date is selected.\",\n \"displayFormat\": \"The format of the date that is displayed in the input. Can use any format [here](/features/dates/#format-options) or a custom function.\",\n \"inputFormat\": \"Format for manual date input. Use yyyy, mm, dd with separators '.', '-', '/' (e.g. 'yyyy-mm-dd', 'dd/mm/yyyy').\",\n \"location\": \"Specifies the date picker's location. Can combine by using a space separated string.\",\n \"updateOn\": \"Specifies when the text input should update the model value. If empty, the text field will go into read-only state.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDatePicker.json", "content": "{\n \"props\": {\n \"allowedDates\": \"Restricts which dates can be selected.\",\n \"eventColor\": \"Sets the color for event dots. It can be string (all events will have the same color) or `object` where attribute is the event date and value is boolean/color/array of colors for specified date or `function` taking date as a parameter and returning boolean/color/array of colors for that date.\",\n \"events\": \"Array of dates or object defining events or colors or function returning boolean/color/array of colors.\",\n \"headerColor\": \"Allows you to set a different color for the header when used in conjunction with the `color` prop.\",\n \"hideHeader\": \"Hides the header.\",\n \"hideWeekdays\": \"Hides the weekdays.\",\n \"landscape\": \"Changes the picker to landscape mode.\",\n \"landscapeHeaderWidth\": \"Sets header width when in landscape mode.\",\n \"month\": \"Sets the month.\",\n \"year\": \"Sets the year.\",\n \"header\": \"Text shown when no **display-date** is set.\",\n \"headerDateFormat\": \"Allows you to customize the format of the date selection text that appears in the header of the calendar.\",\n \"max\": \"Maximum allowed date/month (ISO 8601 format).\",\n \"min\": \"Minimum allowed date/month (ISO 8601 format).\",\n \"multiple\": \"Allow the selection of multiple dates. The **range** value selects all dates between two selections.\",\n \"nextIcon\": \"Sets the icon for next month/year button.\",\n \"prevIcon\": \"Sets the icon for previous month/year button.\",\n \"readonly\": \"Makes the picker readonly (doesn't allow to select new date).\",\n \"showAdjacentMonths\": \"Toggles visibility of days from previous and next months.\",\n \"showWeek\": \"Toggles visibility of the week numbers in the body of the calendar.\",\n \"width\": \"Width of the picker.\",\n \"modeIcon\": \"Icon displayed next to the current month and year, toggles year selection when clicked.\",\n \"viewMode\": \"Determines which picker in the date or month picker is being displayed. Allowed values: `'month'`, `'months'`, `'year'`.\"\n },\n \"events\": {\n \"update:month\": \"Emitted when the month changes.\",\n \"update:viewMode\": \"Emitted when the view mode changes.\",\n \"update:year\": \"Emitted when the year changes.\"\n },\n \"slots\": {\n \"actions\": \"Slot for the actions.\",\n \"controls\": \"Slot for the controls.\",\n \"header\": \"Slot for the header.\",\n \"year\": \"Slot for the year.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDatePickerControls.json", "content": "{\n \"props\": {\n \"controlHeight\": \"Sets the height of the controls.\",\n \"controlVariant\": \"- **docked:** Separate control groups for month and year.\\n- **modal:** Month and year are displayed together, clicking the text opens a month picker, clicking the dropdown arrow opens a year picker. There are also arrow buttons to scroll between months.\",\n \"modeIcon\": \"Icon used for the mode button.\",\n \"nextIcon\": \"Icon used for the next button.\",\n \"noMonthPicker\": \"Only applies to `controlVariant=\\\"modal\\\"`, the month and year picker buttons are combined into one that only opens the year picker.\",\n \"prevIcon\": \"Icon used for the previous button.\",\n \"monthText\": \"Text displayed for the current month.\",\n \"yearText\": \"Text displayed for the current year.\",\n \"viewMode\": \"Sets the view mode of the date picker.\"\n },\n \"events\": {\n \"click:month\": \"Event fired when clicking on the month.\",\n \"click:next\": \"Event fired when clicking the next button.\",\n \"click:prev\": \"Event fired when clicking the previous button.\",\n \"click:year\": \"Event fired when clicking the date text.\",\n \"click:prev-year\": \"Event fired when clicking the previous year button.\",\n \"click:next-year\": \"Event fired when clicking the next year button.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDatePickerHeader.json", "content": "{\n \"props\": {\n \"header\": \"Sets the header content.\",\n \"transition\": \"Sets the transition when the header changes.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDatePickerMonth.json", "content": "{\n \"props\": {\n \"allowedDates\": \"Sets the allowed dates of the month.\",\n \"hideWeekdays\": \"Hide the days of the week letters.\",\n \"max\": \"Sets the maximum date of the month.\",\n \"min\": \"Sets the minimum date of the month.\",\n \"month\": \"Sets the month.\",\n \"year\": \"Sets the year.\",\n \"multiple\": \"Sets the multiple of the month.\",\n \"readonly\": \"Puts the picker in a readonly state.\",\n \"showAdjacentMonths\": \"Show adjacent months.\",\n \"showWeek\": \"Show the week number.\",\n \"transition\": \"The transition used when changing months into the future\",\n \"reverseTransition\": \"The transition used when changing months into the past\"\n },\n \"events\": {\n \"update:month\": \"Fired when the month changes.\",\n \"update:year\": \"Fired when the year changes.\"\n },\n \"slots\": {\n \"day\": \"Slot for a day in the month.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDatePickerMonths.json", "content": "{\n \"props\": {\n \"min\": \"Sets the minimum selectable date. Months before this date will be disabled.\",\n \"max\": \"Sets the maximum selectable date. Months after this date will be disabled.\",\n \"year\": \"Sets the year for the given months.\",\n \"allowedMonths\": \"Restricts which months can be selected.\"\n },\n \"slots\": {\n \"month\": \"Slot for the month.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDatePickerYears.json", "content": "{\n \"props\": {\n \"max\": \"Sets the maximum date of the month.\",\n \"min\": \"Sets the minimum date of the month.\",\n \"allowedYears\": \"Restricts which years can be selected.\"\n },\n \"slots\": {\n \"year\": \"Slot for the year.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDefaultsProvider.json", "content": "{\n \"props\": {\n \"defaults\": \"Specify new default prop values for components. Keep in mind that this will be merged with previously defined values.\",\n \"disabled\": \"Turns off all calculations of new default values for improved performance in situations where defaults propagation isn't necessary.\",\n \"reset\": \"Reset the default values up the nested chain by {n} amount.\",\n \"root\": \"Force current defaults to match the application root defaults.\",\n \"scoped\": \"Prevents the ability for default values to be inherited from parent components.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDialog.json", "content": "{\n \"props\": {\n \"fullscreen\": \"Changes layout for fullscreen display.\",\n \"maxWidth\": \"Sets the maximum width for the component.\",\n \"noClickAnimation\": \"Disables the bounce effect when clicking outside of a `v-dialog`'s content when using the **persistent** prop.\",\n \"openOnHover\": \"Designates whether component should activate when its activator is hovered.\",\n \"persistent\": \"Clicking outside of the element or pressing **esc** key will not deactivate it.\",\n \"scrollable\": \"When set to true, expects a `v-card` and a `v-card-text` component with a designated height. For more information, check out the [scrollable example](/components/dialogs#scrollable).\"\n },\n \"exposed\": {\n \"animateClick\": \"Function invoked when user clicks outside the component and the **persistent** prop is used.\",\n \"globalTop\": \"Used by activator to determine a components position in the global stack order.\",\n \"localTop\": \"Used by activator to determine a components position in the local stack order.\",\n \"updateLocation\": \"Function used for locationStrategy positioning.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDialogTransition.json", "content": "{\n \"props\": {\n \"target\": \"Sets the target element for the transition.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VDivider.json", "content": "{\n \"props\": {\n \"contentOffset\": \"Increases content spacing from the lines. When passed as an array, the second value shifts slot content down (or right in vertical mode).\",\n \"gradient\": \"Adds fading effect for both sides.\",\n \"inset\": \"Adds indentation (72px) for **normal** dividers, reduces max height for **vertical**.\",\n \"length\": \"Sets the dividers length. Default unit is px.\",\n \"thickness\": \"Sets the dividers thickness. Default unit is px.\",\n \"variant\": \"Applies `border-style`.\",\n \"vertical\": \"Displays dividers vertically.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VEmptyState.json", "content": "{\n \"props\": {\n \"actionText\": \"The text used for the action button.\",\n \"headline\": \"A large headline often used for 404 pages.\",\n \"href\": \"The URL the action button links to.\",\n \"justify\": \"Control the justification of the text.\",\n \"textWidth\": \"Sets the width of the text container.\",\n \"to\": \"The URL the action button links to.\",\n \"size\": \"The size used to control the dimensions of the media element inside the component. Can be specified as a number or a string (e.g., '50%', '100px').\"\n },\n \"events\": {\n \"click:action\": \"Event emitted when the action button is clicked.\"\n },\n \"slots\": {\n \"actions\": \"Slot for the action button.\",\n \"headline\": \"Slot for the component's headline.\",\n \"media\": \"Slot for the component's media.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VExpansionPanel.json", "content": "{\n \"props\": {\n \"disabled\": \"Disables the expansion-panel content.\",\n \"readonly\": \"Makes the expansion panel content read only.\",\n \"focusable\": \"Makes the expansion panel content focusable.\",\n \"value\": \"Controls the opened/closed state of content.\",\n \"static\": \"Remove title size expansion when selected.\"\n },\n \"exposed\": {\n \"groupItem\": \"The current expansion panel within the group in ``.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VExpansionPanelTitle.json", "content": "{\n \"props\": {\n \"collapseIcon\": \"Icon used when the expansion panel is in a collapsable state.\",\n \"expandIcon\": \"Icon used when the expansion panel is in a expandable state.\",\n \"hideActions\": \"Hide the expand icon in the content title.\",\n \"static\": \"Remove title size expansion when selected.\",\n \"focusable\": \"Makes the expansion panel headers focusable.\",\n \"readonly\": \"Makes the expansion panel content read only.\"\n },\n \"slots\": {\n \"actions\": \"Slot for the actions.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VExpansionPanels.json", "content": "{\n \"props\": {\n \"focusable\": \"Makes the expansion-panel headers focusable.\",\n \"flat\": \"Removes the expansion-panel's elevation and borders.\",\n \"modelValue\": \"Controls expanded panel(s). Defaults to an empty array when using **multiple** prop. It is recommended to set unique `value` prop for the panels inside, otherwise index is used instead.\",\n \"readonly\": \"Makes the entire expansion panel read only.\",\n \"static\": \"Remove title size expansion when selected.\",\n \"tile\": \"Removes the border-radius.\"\n },\n \"exposed\": {\n \"prev\": \"Open the previous panel from the currently selected panel.\",\n \"next\": \"Open the next panel from the currently selected panel.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VFab.json", "content": "{\n \"props\": {\n \"app\": \"If true, attaches to the closest layout and positions according to the value of **location**.\",\n \"layout\": \"If true, will effect layout dimensions based on size and position.\",\n \"appear\": \"Used to control the animation of the FAB.\",\n \"extended\": \"An alternate style for the FAB that expects text.\",\n \"location\": \"The location of the fab relative to the layout. Only works when using **app**.\",\n \"offset\": \"Translates the Fab up or down, depending on if location is set to **top** or **bottom**.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VField.json", "content": "{\n \"props\": {\n \"appendInnerIcon\": \"Creates a [v-icon](/api/v-icon/) component in the **append-inner** slot.\",\n \"baseColor\": \"Sets the color of the input when it is not focused.\",\n \"centerAffix\": \"Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center.\",\n \"clearIcon\": \"The icon used when the **clearable** prop is set to true.\",\n \"dirty\": \"Manually apply the dirty state styling.\",\n \"disabled\": \"Removes the ability to click or target the input.\",\n \"glow\": \"Makes prepend/append icons full opacity when the field is focused and apply color.\",\n \"error\": \"Puts the input in a manual error state.\",\n \"flat\": \"Removes box shadow when using a variant with elevation.\",\n \"iconColor\": \"Sets the color of the prepend/append icons.\",\n \"id\": \"Sets the DOM id on the component.\",\n \"labelId\": \"Sets the DOM id on the inner label element. Useful for associating the label with custom input elements.\",\n \"details\": \"Controls whether the field generates an `aria-describedby` attribute for accessibility.\",\n \"persistentClear\": \"Always show the clearable icon when the input is dirty (By default it only shows on hover).\",\n \"prependInnerIcon\": \"Creates a [v-icon](/api/v-icon/) component in the **prepend-inner** slot.\",\n \"reverse\": \"Reverses the orientation.\",\n \"singleLine\": \"Label does not move on focus/dirty.\"\n },\n \"events\": {\n \"click:appendInner\": \"Emitted when appended inner icon is clicked.\",\n \"click:clear\": \"Emitted when clearable icon clicked.\",\n \"click:prependInner\": \"Emitted when prepended inner icon is clicked.\",\n \"update:focused\": \"Emitted when the input is focused or blurred\"\n },\n \"slots\": {\n \"append-inner\": \"Slot that is appended to the input.\",\n \"clear\": \"Slot for custom clear icon (displayed when the **clearable** prop is equal to true).\",\n \"label\": \"The default slot of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component.\",\n \"prepend-inner\": \"Slot that is prepended to the input.\"\n },\n \"exposed\": {\n \"controlRef\": \"Reference to the control element of the field.\",\n \"fieldIconColor\": \"The color of the icon.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VFieldLabel.json", "content": "{\n \"props\": {\n \"floating\": \"Elevates the label above the slotted content.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VFileInput.json", "content": "{\n \"props\": {\n \"chips\": \"Changes display of selections to chips.\",\n \"counter\": \"Displays the number of selected files.\",\n \"counterSizeString\": \"The text displayed when using the **counter** and **show-size** props. Can also be customized globally on the [internationalization page](/customization/internationalization).\",\n \"counterString\": \"The text displayed when using the **counter** prop. Can also be customized globally on the [internationalization page](/customization/internationalization).\",\n \"hideInput\": \"Display the icon only without the input (file names).\",\n \"multiple\": \"Adds the **multiple** attribute to the input, allowing multiple file selections.\",\n \"showSize\": \"Sets the displayed size of selected file(s). When using **true** will default to _1000_ displaying (**kB, MB, GB**) while _1024_ will display (**KiB, MiB, GiB**).\",\n \"truncateLength\": \"The length of a filename before it is truncated with ellipsis.\"\n },\n \"slots\": {\n \"counter\": \"Slot for the input’s counter text.\",\n \"selection\": \"Slot for defining a custom appearance for selected item(s). Provides the current **index**, **text** (truncated) and [file](https://developer.mozilla.org/en-US/docs/Web/API/File).\"\n },\n \"events\": {\n \"mousedown:control\": \"Event that is emitted when using mousedown on the main control area.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VFileUpload.json", "content": "{\n \"props\": {\n \"browseText\": \"Text for the browse button.\",\n \"dividerText\": \"Text in the divider.\",\n \"hideBrowse\": \"Hides the browse button.\",\n \"multiple\": \"Allows multiple files to be uploaded.\",\n \"scrim\": \"Determines whether an overlay is used when hovering over the component with files. Accepts true/false to enable background, and string to define color.\",\n \"insetFileList\": \"Renders the file list inside the dropzone container instead of below it.\",\n \"showSize\": \"Shows the size of the file.\"\n },\n \"slots\": {\n \"browse\": \"Slot for the browse button.\",\n \"divider\": \"Slot for the divider between icon and the browse button.\",\n \"icon\": \"Slot for a custom appearance in icon section.\",\n \"input\": \"Define a custom native input.\",\n \"single\": \"Slot for customizing the appearance of a single file when using inset file list mode.\"\n },\n \"exposed\": {\n \"controlRef\": \"Reference to the underlying input control element.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VFileUploadDropzone.json", "content": "{\n \"props\": {\n \"browseText\": \"Text for the browse button.\",\n \"dividerText\": \"Text in the divider.\",\n \"error\": \"Puts the dropzone in an error state, changing the border color.\",\n \"hideBrowse\": \"Hides the browse button.\",\n \"insetFileList\": \"Renders the file list inside the dropzone container instead of below it.\",\n \"multiple\": \"Allows multiple files to be uploaded.\",\n \"scrim\": \"Determines whether an overlay is used when hovering over the component with files. Accepts true/false to enable background, and string to define color.\",\n \"showSize\": \"Shows the size of the file.\"\n },\n \"slots\": {\n \"browse\": \"Slot for the browse button.\",\n \"divider\": \"Slot for the divider between icon and the browse button.\",\n \"icon\": \"Slot to replace the default upload icon.\",\n \"input\": \"Slot to replace the native file input.\",\n \"single\": \"Slot for customizing the appearance of a single file when using inset file list mode.\"\n },\n \"events\": {\n \"drop\": \"Emitted when files are dropped onto the dropzone.\",\n \"click:browse\": \"Emitted when the browse button is clicked.\",\n \"click:remove\": \"Emitted when a file's remove button is clicked.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VFileUploadItem.json", "content": "{\n \"props\": {\n \"file\": \"The file object uploaded\",\n \"fileIcon\": \"The icon prepending each uploaded file. This will be a preview image if the file is an image.\",\n \"index\": \"The index of the file in the upload list.\",\n \"showSize\": \"Show the size of the file\"\n },\n \"events\": {\n \"click:remove\": \"Emitted when the remove icon is clicked\"\n },\n \"slots\": {\n \"clear\": \"Slot for the icon button to clear/remove a file\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VFileUploadList.json", "content": "{\n \"props\": {\n \"files\": \"An array of File objects to display in the list. When used inside a VFileUpload, this is provided automatically via injection.\",\n \"showSize\": \"Shows the size of each file.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VFooter.json", "content": "{\n \"props\": {\n \"app\": \"Determines the position of the footer. If true, the footer would be given a fixed position at the bottom of the viewport. If false, the footer is set to the bottom of the page.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VForm.json", "content": "{\n \"events\": {\n \"submit\": \"Emitted when form is submitted.\",\n \"update:modelValue\": \"Event emitted when the form's validity changes.\"\n },\n \"exposed\": {\n \"errors\": \"Contains all current form input errors.\",\n \"isDisabled\": \"Indicates if form is disabled or not.\",\n \"isReadonly\": \"Indicates if form is readonly or not.\",\n \"isValid\": \"Indicates if form is valid or not.\",\n \"isValidating\": \"Indicates if form is currently being validated or not.\",\n \"items\": \"Array of all registered inputs.\",\n \"reset\": \"Resets validation of all registered inputs, and clears their values.\",\n \"resetValidation\": \"Resets validation of all registered inputs without modifying their values.\",\n \"validate\": \"Validates all registered inputs.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VHotkey.json", "content": "{\n \"props\": {\n \"keys\": \"String representing keyboard shortcuts to display. Supports multiple formats:\\n- **Single keys:** `\\\"k\\\"`, `\\\"enter\\\"`, `\\\"escape\\\"`\\n- **Key combinations:** `\\\"ctrl+k\\\"`, `\\\"meta+shift+p\\\"`, `\\\"alt+arrowup\\\"`\\n- **Sequential actions:** `\\\"ctrl+k-then-p\\\"` (use dash for 'then' relationships)\\n- **Multiple shortcuts:** `\\\"ctrl+k meta+p\\\"` (space-separated for alternative shortcuts)\\n\\nSupports platform-aware key names like `meta` (becomes Cmd on Mac, Ctrl on PC) and `alt` (becomes Option on Mac).\",\n \"displayMode\": \"Controls how keyboard keys are visually represented. Affects the entire component's appearance:\\n- **icon:** Uses SVG icons for keys when appropriate (default)\\n- **symbol:** Uses Unicode symbols (⌘, ⌃, ⇧, ⌥) - Allows you to manage presentation of modifier keys with fonts\\n- **text:** Uses full text labels (Command, Control, Shift, Alt) - most accessible and descriptive\",\n \"keyMap\": \"Custom key mapping object that defines how individual keys should be displayed. Users can import and modify the exported `hotkeyMap` to create custom configurations. Each key maps to a `PlatformKeyConfig` object with:\\n\\n```typescript\\n{\\n mac?: { symbol?: string, icon?: string, text: string },\\n default: { symbol?: string, icon?: string, text: string }\\n}\\n```\\n\\n**Usage Example:**\\n```typescript\\nimport { hotkeyMap } from 'vuetify/labs/VHotkey'\\n\\nconst customKeyMap = {\\n ...hotkeyMap,\\n 'custom-key': {\\n default: { text: 'Custom', icon: 'custom-icon' },\\n mac: { text: 'Custom', symbol: '⚡' }\\n }\\n}\\n```\\n\\nThis enables:\\n- **Custom key definitions:** Add support for application-specific keys\\n- **Localization:** Override text representations for different languages\\n- **Brand customization:** Change how modifier keys appear\\n- **Platform-specific styling:** Different representations for Mac vs other platforms\\n\\nRecommended to set at the application level via component defaults rather than per-instance for consistency.\",\n \"platform\": \"Controls platform-specific rendering behavior for keyboard shortcuts. Accepts three values:\\n- **`'auto'` (default):** Automatically detects the user's platform based on user agent and renders appropriately\\n- **`'mac'`:** Forces Mac-style rendering (Command symbols, icons, Option key, etc.)\\n- **`'pc'`:** Forces PC-style rendering (Ctrl text, Alt key, etc.)\\n\\nThis is particularly useful for:\\n- **Cross-platform testing:** Verify how shortcuts appear on different platforms\\n- **Design consistency:** Ensure specific platform rendering in demos and prototypes\\n- **Development workflow:** Test platform-specific behaviors without switching devices\\n- **Documentation:** Show platform-specific examples in help content\",\n \"inline\": \"Optimizes the component for seamless integration within text content and documentation. Applies compact styling with baseline alignment, constrained height (1lh), and responsive typography that inherits from parent text. Ideal for help documentation, tooltips, and instructional content. When using multiple inline hotkeys in the same paragraph, increase line-height to prevent visual overlap on text wrapping.\",\n \"variant\": \"Controls the visual style and presentation of the hotkey component. Supports standard Vuetify variants plus a special contained variant:\\n\\n**Standard Variants** (apply styling to individual key elements):\\n- **elevated (default):** Raised appearance with shadow, good for standalone hotkey displays\\n- **flat:** Solid background without shadow, clean and minimal\\n- **tonal:** Subtle tinted background without border, balances visibility with restraint\\n- **outlined:** Border-only styling without elevation, lightweight and unobtrusive\\n- **text:** Minimal styling with text color emphasis only, blends with content\\n- **plain:** No background or border, most subtle option\\n\\n**Special Variant** (different visual structure):\\n- **contained:** Follows MDN's nested `` pattern - wraps all keys in a single styled container with unstyled nested elements. Creates a cohesive visual unit that clearly groups related keys together. Cannot be combined with standard variants. Ideal for complex key combinations where you want to show the entire sequence as one unit.\",\n \"disabled\": \"Applies a disabled visual state to the component.\",\n \"prefix\": \"Text to display before the hotkey.\",\n \"suffix\": \"Text to display after the hotkey.\"\n },\n \"slots\": {\n \"default\": \"The default Vue slot. Not supported.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VHover.json", "content": "{\n \"props\": {\n \"disabled\": \"Removes hover functionality.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VIconBtn.json", "content": "{\n \"props\": {\n \"active\": \"When undefined (default), the component utilizes its default variant, otherwise it will use the activeVariant if active is true, or the baseVariant if active is false.\",\n \"activeIcon\": \"When active is a boolean, this icon is used when active is true.\",\n \"activeVariant\": \"When active is a boolean, this variant is used when active is true.\",\n \"baseVariant\": \"When active is a boolean, this variant is used when active is false.\",\n \"hideOverlay\": \"Hides overlay from being displayed when active or focused.\",\n \"iconColor\": \"Explicit color applied to the icon.\",\n \"loading\": \"Displays circular progress bar in place of the icon.\",\n \"readonly\": \"Puts the button in a readonly state. Cannot be clicked or navigated to by keyboard.\",\n \"rotate\": \"The rotation of the icon in degrees.\",\n \"sizes\": \"An array of tuples that define the button sizes for each named size.\"\n },\n \"events\": {\n \"update:active\": \"Event that is emitted when the active state changes.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VImg.json", "content": "{\n \"props\": {\n \"absolute\": \"Applies position: absolute to the component.\",\n \"alt\": \"Alternate text for screen readers. Leave empty for decorative images.\",\n \"aspectRatio\": \"Calculated as `width/height`, so for a 1920x1080px image this will be `1.7778`. Will be calculated automatically if omitted.\",\n \"cover\": \"Resizes the background image to cover the entire container.\",\n \"draggable\": \"Controls the `draggable` behavior of the image. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/draggable).\",\n \"lazySrc\": \"Something to show while waiting for the main image to load, typically a small base64-encoded thumbnail. Has a slight blur filter applied. \\nNOTE: This prop has no effect unless either `height` or `aspect-ratio` are provided.\",\n \"crossorigin\": \"Specify that images should be fetched with CORS enabled [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#crossorigin)\",\n \"position\": \"Applies [object-position](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position) styles to the image and placeholder elements.\",\n \"referrerpolicy\": \"Define which referrer is sent when fetching the resource [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#referrerpolicy)\",\n \"options\": \"Options that are passed to the [Intersection observer](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) constructor.\",\n \"sizes\": \"For use with `srcset`, see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes).\",\n \"src\": \"The image URL. This prop is mandatory.\",\n \"srcset\": \"A set of alternate images to use based on device size. [Read more...](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-srcset).\",\n \"transition\": \"The transition to use when switching from `lazy-src` to `src`. Can be one of the [built in](/styles/transitions/) or custom transition.\",\n \"gradient\": \"The gradient to apply to the image. Only supports [linear-gradient](https://developer.mozilla.org/en-US/docs/Web/CSS/gradient/linear-gradient) syntax, anything else should be done with classes.\",\n \"imageClass\": \"Applies CSS classes to the inner `` element.\"\n },\n \"slots\": {\n \"placeholder\": \"Display an overlay while the image is loading.\",\n \"error\": \"Will be shown if the image fails to load, replacing the placeholder slot.\",\n \"sources\": \"A list of `` elements. If this slot is used v-img will render a `` instead of ``.\"\n },\n \"events\": {\n \"error\": \"Emitted if the image fails to load.\",\n \"load\": \"Emitted when the image is loaded.\",\n \"loadstart\": \"Emitted when the image starts to load.\"\n },\n \"exposed\": {\n \"currentSrc\": \"The current source of the image. This is the image that is currently being displayed. This is useful for determining if the image is loading or not.\",\n \"image\": \"The image element.\",\n \"naturalHeight\": \"The natural height of the image.\",\n \"naturalWidth\": \"The natural width of the image.\",\n \"state\": \"The current state of the image. This is useful for determining if the image is loading or not.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VInfiniteScroll.json", "content": "{\n \"props\": {\n \"direction\": \"Specifies if scroller is **vertical** or **horizontal**.\",\n \"emptyText\": \"Text shown when there is no more content to load.\",\n \"loadMoreText\": \"Text shown in default load more button, when in manual mode.\",\n \"margin\": \"Value sent to the intersection observer. Will make the observer trigger earlier, by the margin (px) value supplied.\",\n \"mode\": \"Specifies if content should load automatically when scrolling (**intersect**) or manually (**manual**).\",\n \"side\": \"Specifies the side where new content should appear. Either the **start**, **end**, or **both** sides.\"\n },\n \"slots\": {\n \"empty\": \"Shown when load returned status 'empty'.\",\n \"error\": \"Shown when load returned status 'error'.\",\n \"load-more\": \"Shown when scrolled to either side of the content, in manual mode.\",\n \"loading\": \"Shown when content is loading.\"\n },\n \"events\": {\n \"load\": \"Emitted when reaching the start / end threshold, or if triggered when using manual mode.\"\n },\n \"exposed\": {\n \"reset\": \"Resets side status to 'ok' letting it trigger 'load' again. Useful to prevent given side being stuck in 'empty' or 'error' state.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VInput.json", "content": "{\n \"props\": {\n \"baseColor\": \"Sets the color of the input when it is not focused.\",\n \"centerAffix\": \"Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center.\",\n \"direction\": \"Changes the direction of the input.\",\n \"hideDetails\": \"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.\",\n \"hideSpinButtons\": \"Hides spin buttons on the input when type is set to `number`.\",\n \"glow\": \"Makes prepend/append icons full opacity when the input is focused and apply color.\",\n \"hint\": \"Displays hint text below the input when focused. Force this always open with the [persistent-hint](#props-persistent-hint) property.\",\n \"iconColor\": \"Sets the color of the prepend/append icons.\",\n \"id\": \"Sets the DOM id on the component.\",\n \"indentDetails\": \"Adds / removes inline padding in inputs details. Useful when trying to align different variants of fields and selection controls.\",\n \"persistentHint\": \"Forces [hint](#props-hint) to always be visible.\",\n \"prependIcon\": \"Prepends an icon to the component, uses the same syntax as `v-icon`.\"\n },\n \"events\": {\n \"click:append\": \"Emitted when appended icon is clicked.\",\n \"click:prepend\": \"Emitted when prepended icon is clicked.\"\n },\n \"exposed\": {\n \"errorMessages\": \"An array of error messages that were set by the `setErrors` method.\",\n \"isValid\": \"Boolean indicating if the input is valid.\",\n \"reset\": \"Resets the input value.\",\n \"resetValidation\": \"Resets validation of the input without modifying its value.\",\n \"validate\": \"Validates the input's value.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VItemGroup.json", "content": "{\n \"props\": {\n \"selectedClass\": \"Configure the selected CSS class. This class will be available in `v-item` default scoped slot.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VLayout.json", "content": "{}\n" }, { "path": "packages/api-generator/src/locale/en/VLayoutItem.json", "content": "{\n \"props\": {\n \"position\": \"The position of the item.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VLazy.json", "content": "{\n \"props\": {\n \"options\": \"Options that are passed to the [Intersection observer](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) constructor.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VList.json", "content": "{\n \"props\": {\n \"activeColor\": \"Deprecated, use `color` instead.\",\n \"activatable\": \"Designates whether the list items are activatable. Additionally, sets necessary accessibility attributes internally.\",\n \"disabled\": \"Puts all children inputs into a disabled state.\",\n \"filterable\": \"**FOR INTERNAL USE ONLY** Prevents list item selection using [space] key and pass it back to the text input. Used internally for VAutocomplete and VCombobox.\",\n \"itemsRegistration\": \"When set to 'props', skips rendering collapsed items/nodes (for significant performance gains).\",\n \"lines\": \"Designates a **minimum-height** for all children `v-list-item` components. This prop uses [line-clamp](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp) and is not supported in all browsers.\",\n \"nav\": \"An alternative styling that reduces `v-list-item` width and rounds the corners. Typically used with **[v-navigation-drawer](/components/navigation-drawers)**.\",\n \"navigationIndex\": \"Specifies the currently selected navigation index when using `navigationStrategy=\\\"track\\\"`. Can be used with `v-model:navigationIndex` for two-way binding. Items at this index receive visual keyboard focus styling and automatic scrolling. Note: Only works with the `items` prop, not with slotted items.\",\n \"navigationStrategy\": \"Determines keyboard navigation behavior. **focus** (default) moves DOM focus to items, suitable for traditional lists. **track** provides visual keyboard focus without moving DOM focus, ideal for command palettes and autocomplete where an external element retains focus. When track mode is active, items automatically receive `tabindex=\\\"-1\\\"`, proper `aria-activedescendant` is set on the list container, and keyboard-focused items display focus-visible styling with auto-scrolling.\",\n \"slim\": \"Reduces horizontal spacing for badges, icons, tooltips, and avatars within slim list items to create a more compact visual representation.\",\n \"prependGap\": \"Sets the horizontal spacing between prepend slot and the main content within list item. Also affects indent to ensure expected alignment of group children.\",\n \"indent\": \"Overrides the indent size for nested groups.\",\n \"collapseIcon\": \"Icon to display when the list item is expanded.\",\n \"expandIcon\": \"Icon to display when the list item is collapsed.\",\n \"selectable\": \"Designates whether the list items are selectable. Additionally, sets necessary accessibility attributes internally.\"\n },\n \"events\": {\n \"click:activate\": \"Emitted when the list item is activated.\",\n \"click:open\": \"Emitted when the list item is opened.\",\n \"click:select\": \"Emitted when the list item is selected.\",\n \"update:activated\": \"Emitted when the list item is activated.\",\n \"update:navigationIndex\": \"Emitted when keyboard navigation occurs in `navigationStrategy=\\\"track\\\"`. The event payload is the new index of the selected item. Automatically skips non-selectable items like dividers and subheaders.\",\n \"update:opened\": \"Emitted when the list item is opened.\",\n \"update:selected\": \"Emitted when the list item is selected.\"\n },\n \"slots\": {\n \"item\": \"Slot for rendering custom list items. Receives `{ props }` where `props` contains item data (`title`, `subtitle`, `value`, etc.) plus `index` (the item's position in the list). Use this to completely customize item rendering while still using VList's navigation and selection features.\",\n \"header\": \"Slot for rendering custom group headers when using nested items. Receives `{ props }` containing the group's header item data plus activator props for expand/collapse functionality.\"\n },\n \"exposed\": {\n \"children\": \"The nested list items within the component.\",\n \"focus\": \"Focus the list item.\",\n \"getPath\": \"Get the position of an item within the nested structure.\",\n \"navigationIndex\": \"A computed ref that returns the current navigation index when using `navigationStrategy=\\\"track\\\"`. Returns -1 when no item is selected or when using `navigationStrategy=\\\"focus\\\"`.\",\n \"open\": \"Open the list item.\",\n \"parents\": \"The parent list items within the component.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VListGroup.json", "content": "{\n \"props\": {\n \"activeColor\": \"Deprecated, use `color` instead.\",\n \"disabled\": \"Puts all children inputs into a disabled state.\",\n \"collapseIcon\": \"Icon to display when the list item is expanded.\",\n \"expandIcon\": \"Icon to display when the list item is collapsed.\",\n \"prependIcon\": \"Prepends an icon to the component, uses the same syntax as `v-icon`.\",\n \"rawId\": \"Defines the root element's id attribute in the component. If it is provided, the id attribute will be dynamically generated in the format: \\\"v-list-group--id-[rawId]\\\".\",\n \"subgroup\": \"Designate the component as nested list group.\",\n \"value\": \"Expands / Collapse the list-group.\",\n \"fluid\": \"Removes the left padding assigned for action icons from group items.\"\n },\n \"exposed\": {\n \"isOpen\": \"Returns the current state of the list-group.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VListItem.json", "content": "{\n \"props\": {\n \"active\": \"Controls the **active** state of the item. This is typically used to highlight the component.\",\n \"activeColor\": \"Deprecated, use `color` instead.\",\n \"color\": \"Applies specified color to the control when in an **active** state or **input-value** is **true** - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors),\",\n \"title\": \"Generates a `v-list-item-title` component with the supplied value. Note that this overrides the native [`title`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title) attribute, that must be set with `v-bind:title.attr` instead.\",\n \"value\": \"The value used for selection. Obtained from [`v-list`](/api/v-list)'s `v-model:selected` when the item is selected.\",\n \"lines\": \"The line declaration specifies the minimum height of the item and can also be controlled from v-list with the same prop.\",\n \"nav\": \"Reduces the width v-list-item takes up as well as adding a border radius.\",\n \"slim\": \"Reduces horizontal spacing for badges, icons, tooltips, and avatars to create a more compact visual representation.\",\n \"index\": \"The index of the item within the list. Used internally for keyboard navigation and selection.\",\n \"tabindex\": \"Controls the tabindex of the list item. When set, overrides the default tabindex behavior. Automatically set to -1 by VList when using `navigationStrategy=\\\"track\\\"` to prevent Tab key navigation into items.\"\n },\n \"exposed\": {\n \"activate\": \"Activate the list item.\",\n \"id\": \"The unique identifier of the list item.\",\n \"isActivated\": \"Check if the list item is activated.\",\n \"isGroupActivator\": \"Check if the list item activates a group.\",\n \"isSelected\": \"Check if the list item is selected.\",\n \"link\": \"Navigation information if list item functions as a link.\",\n \"list\": \"The reference to the parent list component.\",\n \"root\": \"The root nested list component\",\n \"select\": \"Select this list item.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VListSubheader.json", "content": "{\n \"props\": {\n \"tag\": \"Specify a custom tag used on the root element.\",\n \"title\": \"Specify a title text for the component.\",\n \"inset\": \"Insets the subheader without additional spacing, aligning it flush with the surrounding content.\",\n \"sticky\": \"Sticks the header to the top of the table.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VLocaleProvider.json", "content": "{\n \"props\": {\n \"fallbackLocale\": \"Specify a fallback locale to use when a locale is not found.\",\n \"locale\": \"Specify a locale to use.\",\n \"rtl\": \"Specify a RTL mode.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VMain.json", "content": "{\n \"props\": {\n \"scrollable\": \"Specify a custom scrollable function.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VMenu.json", "content": "{\n \"props\": {\n \"attach\": \"Specifies which DOM element the overlay content should teleport to. Can be a direct element reference, querySelector string, or `true` to disable teleporting. Uses `body` by default. Generally not recommended except as a last resort: the default positioning algorithm should handle most scenarios better than is possible without teleporting, and you may have unexpected behavior if the menu ends up as child of its activator.\",\n \"id\": \"The unique identifier of the component.\",\n \"closeOnContentClick\": \"Designates if menu should close when its content is clicked.\",\n \"closeDelay\": \"Milliseconds to wait before closing component. Only works with the **open-on-hover** prop.\",\n \"disableInitialFocus\": \"Deprecated, use `capture-focus` instead. Prevents automatic redirect of first `focusin` event. Intended to use on permanently open menus or VSpeedDial.\",\n \"minWidth\": \"Sets the minimum width for the component. Use `auto` to use the activator width.\",\n \"openDelay\": \"Milliseconds to wait before opening component. Only works with the **open-on-hover** prop.\",\n \"openOnClick\": \"Designates whether menu should open on activator click.\",\n \"openOnHover\": \"Designates whether menu should open on activator hover.\",\n \"submenu\": \"Opens with right arrow and closes on left instead of up/down. Implies `location=\\\"end\\\"`. Directions are reversed for RTL.\"\n },\n \"exposed\": {\n \"animateClick\": \"Function invoked when user clicks outside.\",\n \"globalTop\": \"Used by activator to determine a components position in the global stack order.\",\n \"id\": \"The unique identifier of the component.\",\n \"localTop\": \"Used by activator to determine a components position in the local stack order.\",\n \"target\": \"Ref to the current target element.\",\n \"updateLocation\": \"Function used for locationStrategy positioning.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VMessages.json", "content": "{\n \"props\": {\n \"active\": \"Determines whether the messages are visible or not.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VNavigationDrawer.json", "content": "{\n \"props\": {\n \"disableResizeWatcher\": \"Prevents the automatic opening or closing of the drawer when resized, based on whether the device is mobile or desktop.\",\n \"disableRouteWatcher\": \"Disables opening of navigation drawer when route changes.\",\n \"expandOnHover\": \"Collapses the drawer to a **rail-variant** until hovering with the mouse.\",\n \"floating\": \"A floating drawer has no visible container (no border-right).\",\n \"image\": \"Apply a specific background image to the component.\",\n \"mobileBreakpoint\": \"Sets the designated mobile breakpoint for the component. This will apply alternate styles for mobile devices such as the `temporary` prop, or activate the `bottom` prop when the breakpoint value is met. Setting the value to `0` will disable this functionality.\",\n \"permanent\": \"The drawer remains visible regardless of screen size.\",\n \"rail\": \"Sets the component width to the **rail-width** value.\",\n \"railWidth\": \"Sets the width for the component when `rail` is enabled.\",\n \"scrim\": \"Determines whether an overlay is used when a **temporary** drawer is open. Accepts true/false to enable background, and string to define color.\",\n \"temporary\": \"A temporary drawer sits above its application and uses a scrim (overlay) to darken the background.\",\n \"touchless\": \"Disable mobile touch functionality.\",\n \"location\": \"Controls the edge of the screen the drawer is attached to.\",\n \"sticky\": \"When true, the drawer will remain visible when scrolling past the top of the page.\"\n },\n \"slots\": {\n \"append\": \"A slot at the bottom of the drawer.\",\n \"image\": \"Used to modify `v-img` properties when using the **src** prop.\",\n \"prepend\": \"A slot at the top of the drawer\"\n },\n \"events\": {\n \"update:rail\": \"Event that is emitted when the rail model changes.\"\n },\n \"exposed\": {\n \"isStuck\": \"Used to determine if the drawer is stuck to the top of the page.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VNumberInput.json", "content": "{\n \"props\": {\n \"controlVariant\": \"The color of the control. It defaults to the value of `variant` prop.\",\n \"decimalSeparator\": \"Expects single character to be used as decimal separator.\",\n \"hideInput\": \"Hide the input field.\",\n \"inset\": \"Applies an indentation to the dividers used in the stepper buttons.\",\n \"max\": \"Specifies the maximum allowable value for the input.\",\n \"min\": \"Specifies the minimum allowable value for the input.\",\n \"minFractionDigits\": \"Specifies the minimum fraction digits to be displayed (capped to `precision`). Defaults to `precision` when not explicitly set.\",\n \"precision\": \"Enforces strict precision. It is expected to be an integer value in range between `0` and `15`, or null for unrestricted.\",\n \"step\": \"Defines the interval between allowed values when the user increments or decrements the input\",\n \"type\": \"**IGNORED** underlying input is always of type 'text'\"\n },\n \"slots\": {\n \"decrement\": \"Slot for customizing the decrement button or icon used to decrease the value of the input.\",\n \"increment\": \"Slot for customizing the increment button or icon used to increase the value of the input.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VOtpInput.json", "content": "{\n \"props\": {\n \"autofocus\": \"Automatically focuses the first input on page load\",\n \"divider\": \"Specifies the dividing character between items.\",\n \"focusAll\": \"Puts all inputs into a focus state when any are focused\",\n \"length\": \"The OTP field's length.\",\n \"placeholder\": \"Sets the input’s placeholder text.\",\n \"masked\": \"Hides the entered characters with bullets, similar to a password input, but makes it possible to also restrict characters to digits with `type=\\\"number\\\"`.\",\n \"type\": \"Supported types: `text`, `password`, `number`.\"\n },\n \"events\": {\n \"finish\": \"Emitted when the input is filled completely and cursor is blurred.\"\n },\n \"exposed\": {\n \"reset\": \"Reset's the input model to an empty array\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VOverflowBtn.json", "content": "{\n \"props\": {\n \"editable\": \"Creates an editable button.\",\n \"overflow\": \"Creates an overflow button.\",\n \"persistentPlaceholder\": \"Forces label to always be visible.\",\n \"segmented\": \"Creates a segmented button.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VOverlay-activator.json", "content": "{\n \"props\": {\n \"activator\": \"Explicitly sets the overlay's activator.\",\n \"activatorProps\": \"Apply custom properties to the activator.\",\n \"contentProps\": \"Apply custom properties to the content.\",\n \"closeOnContentClick\": \"Closes component when you click on its content.\",\n \"location\": \"Specifies the anchor point for positioning the component, using directional cues to align it either horizontally, vertically, or both..\",\n \"openOnClick\": \"Activate the component when the activator is clicked.\",\n \"openOnFocus\": \"Activate the component when the activator is focused.\",\n \"openOnHover\": \"Activate the component when the activator is hovered.\",\n \"target\": \"For locationStrategy=\\\"connected\\\", specify an element or array of x,y coordinates that the overlay should position itself relative to. This will be the activator element by default.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VOverlay-location-strategies.json", "content": "{\n \"props\": {\n \"locationStrategy\": \"A function used to specifies how the component should position relative to its activator.\",\n \"offset\": \"Increases distance from the target. When passed as a pair of numbers, the second value shifts anchor along the side and away from the target.\",\n \"stickToTarget\": \"Enables the overlay content to go off-screen when scrolling.\",\n \"viewportMargin\": \"Sets custom viewport margin for the overlay content\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VOverlay-scroll-strategies.json", "content": "{\n \"props\": {\n \"scrollStrategy\": \"Strategy used when the component is activate and user scrolls.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VOverlay.json", "content": "{\n \"props\": {\n \"absolute\": \"Applies **position: absolute** to the content element.\",\n \"attach\": \"Specifies which DOM element the overlay content should teleport to. Can be a direct element reference, querySelector string, or `true` to disable teleporting. Uses `body` by default.\",\n \"closeOnBack\": \"Closes the overlay content when the browser's back button is pressed or `$router.back()` is called, cancelling the original navigation. `persistent` overlays will cancel navigation and animate as if they were clicked outside instead of closing.\",\n \"contained\": \"Limits the size of the component and scrim to its offset parent. Implies `absolute` and `attach`. (Note: The parent element must have position: relative.).\",\n \"noClickAnimation\": \"Disables the bounce effect when clicking outside of the content element when using the persistent prop.\",\n \"opacity\": \"Sets the opacity of the scrim element. Only applies if `scrim` is enabled.\",\n \"persistent\": \"Clicking outside of the element or pressing esc key will not deactivate it.\",\n \"scrim\": \"Accepts true/false to enable background, and string to define color.\",\n \"zIndex\": \"The z-index used for the component.\"\n },\n \"events\": {\n \"click:outside\": \"Event that fires when clicking outside an active overlay.\",\n \"afterLeave\": \"Event that fires after the overlay has finished transitioning out.\",\n \"afterEnter\": \"Event that fires after the overlay has finished transitioning in.\",\n \"keydown\": \"Emitted when **any** key is pressed.\"\n },\n \"exposed\": {\n \"activatorEl\": \"Ref to the current activator element.\",\n \"animateClick\": \"Function invoked when user clicks outside.\",\n \"contentEl\": \"Ref to the current content element.\",\n \"globalTop\": \"Used by activator to determine a components position in the global stack order.\",\n \"localTop\": \"Used by activator to determine a components position in the local stack order.\",\n \"rootEl\": \"Ref to the root v-overlay element.\",\n \"scrimEl\": \"Ref to the current scrim element.\",\n \"target\": \"Ref to the current target element.\",\n \"updateLocation\": \"Function used for locationStrategy positioning.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VPagination.json", "content": "{\n \"props\": {\n \"ariaLabel\": \"Label for the root element.\",\n \"color\": \"Applies specified color to the selected page button - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors).\",\n \"currentPageAriaLabel\": \"Label for the currently selected page.\",\n \"ellipsis\": \"Text to show between page buttons when truncating the list.\",\n \"firstAriaLabel\": \"Label for the go to first button.\",\n \"firstIcon\": \"The icon to use for the first button.\",\n \"lastAriaLabel\": \"Label for the go to last button.\",\n \"lastIcon\": \"The icon to use for the last button.\",\n \"length\": \"The number of pages.\",\n \"nextAriaLabel\": \"Label for the next button.\",\n \"nextIcon\": \"The icon to use for the next button.\",\n \"pageAriaLabel\": \"Label for each page button.\",\n \"prevIcon\": \"The icon to use for the prev button.\",\n \"previousAriaLabel\": \"Label for the previous button.\",\n \"showFirstLastPage\": \"Show buttons for going to first and last page.\",\n \"start\": \"Specify the starting page.\",\n \"totalVisible\": \"Specify the total visible pagination numbers.\"\n },\n \"slots\": {\n \"first\": \"Define a custom appearance for the first button.\",\n \"last\": \"Define a custom appearance for the last button.\",\n \"next\": \"Define a custom appearance for the next button.\",\n \"prev\": \"Define a custom appearance for the previous button.\"\n },\n \"events\": {\n \"first\": \"Emitted when clicking on go to first button.\",\n \"last\": \"Emitted when clicking on go to last button.\",\n \"next\": \"Emitted when clicking on go to next button.\",\n \"prev\": \"Emitted when clicking on go to previous button.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VParallax.json", "content": "{\n \"props\": {\n \"scale\": \"The scale of the parallax image.\"\n },\n \"slots\": {\n \"error\": \"Puts the input in a manual error state.\",\n \"placeholder\": \"Sets the input's placeholder text.\",\n \"sources\": \"A list of `` elements.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VPicker.json", "content": "{\n \"props\": {\n \"divided\": \"Adds a divider between the header and controls.\",\n \"landscape\": \"Puts the picker into landscape mode.\",\n \"hideHeader\": \"Hide the picker header.\",\n \"hideTitle\": \"Hide the picker title.\"\n },\n \"slots\": {\n \"actions\": \"Slot for customizing the content in the actions area\",\n \"header\": \"Slot for the component's header content.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VPie.json", "content": "{\n \"props\": {\n \"gaugeCut\": \"Allows removing bottom part of the chart to make it into a gauge. Expects angle (0-180).\",\n \"hoverScale\": \"Enables interactive behavior by reducing segment size until it gets hovered. Expects fraction value (0-0.25).\",\n \"innerCut\": \"Specifies inner radius for a donut-style chart as a percent (0-100). Without `hide-slice`, inner slice is visible with translucent color matching the item.\",\n \"items\": \"Data items expected to contain `key`, `title` and `value`.\",\n \"legend\": \"Controls legend visibility, position and text format.\",\n \"palette\": \"Defines colors and patterns to be applied based on the data items order. Data items can also define their colors.\",\n \"rotate\": \"Rotates the chart segments clockwise.\",\n \"size\": \"Sets the height and width of the chart (excluding title and legend).\",\n \"tooltip\": \"Controls tooltip visibility, transition, offset from the cursor and formats of title and subtitle.\"\n },\n \"slots\": {\n \"center\": \"Slot used to put custom content in the center of the chart\",\n \"legend\": \"Slot used to override how legend is being displayed\",\n \"legend-text\": \"Slot used to customize as text content of single legend item\",\n \"title\": \"Slot used to customize the title above the chart\",\n \"tooltip\": \"Slot used to customize tooltip content\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VPieSegment.json", "content": "{\n \"props\": {\n \"animation\": \"Controls duration and easing of the expand/collapse and hover effect. Defaults to `easeInOutCubic` over 400ms.\",\n \"color\": \"Sets segment color to be passed straight to CSS style attribute.\",\n \"gap\": \"Reduces segment size by a specified angle. Recommended to in range (0-10).\",\n \"hideSlice\": \"Makes inner slice invisible instead of semi-transparent.\",\n \"innerCut\": \"Sets inner slice size in percent (0-100).\",\n \"pattern\": \"Decal pattern to put on top of the outer slice.\",\n \"rotate\": \"Sets segment offset angle.\",\n \"rounded\": \"Number passed as corner radius relative to 100x100 SVG viewport\",\n \"value\": \"The value used for calculate segment/arc angle size.\",\n \"hoverScale\": \"Reduces outer radius until segment is hovered. Expects fraction value (0-0.25)\",\n \"reveal\": \"Enables and controls duration for initial reveal animation. Easing function is shared with `animation` prop.\"\n },\n \"events\": {\n \"update:active\": \"Emitted when the segment's active (hovered) state changes.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VPieTooltip.json", "content": "{\n \"props\": {\n \"item\": \"Data item related to hovered segment\",\n \"titleFormat\": \"Formatter definition or function. When passed as String macros for `[title]` and `[value]` get replaced dynamically.\",\n \"subtitleFormat\": \"Formatter definition or function. When passed as String macros for `[title]` and `[value]` get replaced dynamically.\",\n \"target\": \"The coordinates used to position the tooltip.\",\n \"transition\": \"The transition used when hovering between chart segments\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VProgress.json", "content": "{\n \"props\": {\n \"absolute\": \"Positions the component absolutely within its parent, centering the progress indicator and placing details without affecting layout.\",\n \"type\": \"Determines which progress indicator to render.\",\n \"label\": \"Text displayed alongside the progress indicator and placed in `aria-label`.\",\n \"detailsPosition\": \"Controls the position of the details (label and value) relative to the progress indicator.\",\n \"max\": \"Sets the maximum value for the progress indicator.\",\n \"hideLabel\": \"Hides the label text.\",\n \"hideValue\": \"Hides the value text.\",\n \"valueFormat\": \"Formatter for the visible value text and `aria-valuetext`. Use `[value]` and `[max]` as placeholders in strings, or pass a function that receives `{ value, max }` and returns a string.\"\n },\n \"slots\": {\n \"label\": \"Slot for custom label content.\",\n \"value\": \"Slot for custom value content.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VProgressCircular.json", "content": "{\n \"props\": {\n \"indeterminate\": \"Constantly animates, use when loading progress is unknown. If set to the string `'disable-shrink'` it will use a simpler animation that does not run on the main thread.\",\n \"reveal\": \"Animates the progress circle from 0 to its model value when the component mounts.\",\n \"rounded\": \"Rounds the ends of the progress arc for a softer appearance. When enabled, the progress stroke will have rounded caps instead of square ends.\",\n \"modelValue\": \"The percentage value for current progress.\",\n \"rotate\": \"Rotates the circle start point in degrees.\",\n \"size\": \"Sets the diameter of the circle in pixels.\",\n \"width\": \"Sets the stroke of the circle in pixels.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VProgressLinear.json", "content": "{\n \"props\": {\n \"absolute\": \"Applies position: absolute to the component.\",\n \"active\": \"Reduce the height to 0, hiding component.\",\n \"bgOpacity\": \"Background opacity, if null it defaults to 0.3 if background color is not specified or 1 otherwise.\",\n \"bufferColor\": \"Sets the color of the buffer bar.\",\n \"bufferOpacity\": \"Set the opacity of the buffer bar.\",\n \"bufferValue\": \"The percentage value for the buffer.\",\n \"chunkCount\": \"Specifies amount of chunks to divide the bar into.\",\n \"chunkGap\": \"Defines size of the gap between chunks.\",\n \"chunkWidth\": \"Defines chunk absolute size. Useful when chunk is narrow.\",\n \"clickable\": \"Clicking on the progress track will automatically set the value.\",\n \"indeterminate\": \"Constantly animates, use when loading progress is unknown.\",\n \"max\": \"Sets the maximum value the progress can reach.\",\n \"opacity\": \"Set the opacity of the progress bar.\",\n \"reverse\": \"Displays reversed progress (right to left in LTR mode and left to right in RTL).\",\n \"roundedBar\": \"Applies a border radius to the progress bar.\",\n \"stream\": \"An alternative style for portraying loading that works in tandem with **buffer-value**.\",\n \"striped\": \"Adds a stripe background to the filled portion of the progress component.\"\n },\n \"slots\": {\n \"default\": \"Provides the current value of the component.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VPullToRefresh.json", "content": "{\n \"props\": {\n \"pullDownThreshold\": \"The distance the user must pull down to trigger a refresh.\"\n },\n \"events\": {\n \"load\": \"Emitted when the user pulls down past the threshold.\"\n },\n \"slots\": {\n \"pullDownPanel\": \"Slot to override the display of the progress indicator after a pull down\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VRadio.json", "content": "{\n \"props\": {\n \"falseIcon\": \"The icon used when inactive.\",\n \"trueIcon\": \"The icon used when active.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VRadioGroup.json", "content": "{\n \"props\": {\n \"inline\": \"Displays radio buttons in row.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VRangeSlider.json", "content": "{\n \"props\": {\n \"strict\": \"Disallows dragging the ending thumb past the starting thumb and vice versa.\"\n\n },\n \"slots\": {\n \"thumb-label\": \"Slot for the thumb label.\",\n \"tick-label\": \"Slot for the tick label.\"\n },\n \"events\": {\n \"end\": \"Slider value emitted at the end of slider movement.\",\n \"start\": \"Slider value emitted at start of slider movement.\"\n },\n \"exposed\": {\n \"focus\": \"Focus the first slider handle\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VRating.json", "content": "{\n \"props\": {\n \"clearable\": \"Allows for the component to be cleared by clicking on the current value.\",\n \"emptyIcon\": \"The icon displayed when empty.\",\n \"fullIcon\": \"The icon displayed when full.\",\n \"itemLabels\": \"Array of labels to display next to each item..\",\n \"itemLabelPosition\": \"Position of item labels. Accepts 'top' and 'bottom'.\",\n \"halfIncrements\": \"Allows the selection of half increments.\",\n \"hover\": \"Provides visual feedback when hovering over icons.\",\n \"length\": \"The amount of items to show.\",\n \"readonly\": \"Removes all hover effects and pointer events.\",\n \"itemAriaLabel\": \"The **aria-label** used for each item.\"\n },\n \"slots\": {\n \"item\": \"The slot for each item.\",\n \"item-label\": \"The slot for each item label.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VResponsive.json", "content": "{\n \"props\": {\n \"aspectRatio\": \"Sets a base aspect ratio, calculated as width/height. This will only set a **minimum** height, the component can still grow if it has a lot of content.\",\n \"contentClass\": \"Apply a custom class to the internal content element.\",\n \"inline\": \"Display as an inline element instead of a block, also disables flex-grow.\"\n },\n \"slots\": {\n \"additional\": \"The slot for additional content.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VRow.json", "content": "{\n \"props\": {\n \"align\": \"Deprecated, use **align-\\\\*** class. Available options are: **start**, **center**, **end**, **baseline** and **stretch**.\",\n \"alignLg\": \"Deprecated, use **align-lg-\\\\*** class\",\n \"alignMd\": \"Deprecated, use **align-md-\\\\*** class\",\n \"alignSm\": \"Deprecated, use **align-sm-\\\\*** class\",\n \"alignXl\": \"Deprecated, use **align-xl-\\\\*** class\",\n \"alignXxl\": \"Deprecated, use **align-xxl-\\\\*** class\",\n \"alignContent\": \"Deprecated, use **align-content-\\\\***. Available options are: **start**, **center**, **end**, **space-between**, **space-around** and **stretch**.\",\n \"alignContentLg\": \"Deprecated, use **align-content-lg-\\\\*** class\",\n \"alignContentMd\": \"Deprecated, use **align-content-md-\\\\*** class\",\n \"alignContentSm\": \"Deprecated, use **align-content-sm-\\\\*** class\",\n \"alignContentXl\": \"Deprecated, use **align-content-xl-\\\\*** class\",\n \"alignContentXxl\": \"Deprecated, use **align-content-xxl-\\\\*** class\",\n \"dense\": \"Deprecated, use `density` with **comfortable** instead.\",\n \"density\": \"Adjusts the spacing between `v-col`s. Available options are: **default**, **comfortable**, **compact**.\",\n \"justify\": \"Deprecated, use **justify-\\\\***. Available options are: **start**, **center**, **end**, **space-between** and **space-around**.\",\n \"justifyLg\": \"Deprecated, use **justify-lg-\\\\*** class\",\n \"justifyMd\": \"Deprecated, use **justify-md-\\\\*** class\",\n \"justifySm\": \"Deprecated, use **justify-sm-\\\\*** class\",\n \"justifyXl\": \"Deprecated, use **justify-xl-\\\\*** class\",\n \"justifyXxl\": \"Deprecated, use **justify-xxl-\\\\*** class\",\n \"gap\": \"Sets the gap between `v-col`s. Can be a single value for both row and column gap, or the array of two values [column gap, row gap].\",\n \"noGutters\": \"Removes the gutter between `v-col`s (same as `gap='0'`).\",\n \"size\": \"Sets the number of columns.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSelect.json", "content": "{\n \"props\": {\n \"chips\": \"Changes display of selections to chips.\",\n \"closableChips\": \"Enables the [closable](/api/v-chip/#props-closable) prop on all [v-chip](/components/chips/) components.\",\n \"hideSelected\": \"Do not display in the select menu items that are already selected.\",\n \"itemColor\": \"Sets color of selected items.\",\n \"itemChildren\": \"This property currently has **no effect**.\",\n \"items\": \"Can be an array of objects or strings. By default objects should have **title** and **value** properties, and can optionally have a **props** property containing any [VListItem props](/api/v-list-item/#props). Keys to use for these can be changed with the **item-title**, **item-value**, and **item-props** props.\",\n \"itemValue\": \"Set property of **items**'s value - **must be primitive**. Dot notation is supported. **Note:** This is currently not supported with `v-combobox` [GitHub Issue](https://github.com/vuetifyjs/vuetify/issues/5479).\",\n \"minWidth\": \"Sets the minimum width of the select's `v-menu` content.\",\n \"multiple\": \"Changes select to multiple. Accepts array for value.\",\n \"openOnClear\": \"When using the **clearable** prop, once cleared, the select menu will either open or stay open, depending on the current state.\"\n },\n \"slots\": {\n \"item\": \"Define a custom item appearance. The root element of this slot must be a **v-list-item** with `v-bind=\\\"props\\\"` applied. `props` includes everything required for the default select list behaviour - including title, value, click handlers, virtual scrolling, and anything else that has been added with [`item-props`](api/v-select/#props-item-props).\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSelectionControl.json", "content": "{\n \"props\": {\n \"baseColor\": \"Sets the color of the input when it is not focused.\",\n \"value\": \"The value used when the component is selected in a group. If not provided, a unique ID will be used.\"\n },\n \"slots\": {\n \"input\": \"The slot used for the default input element.\"\n },\n \"exposed\": {\n \"isFocused\": \"Will return true if the component is currently focused.\",\n \"input\": \"Reference to the root input element.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSheet.json", "content": "{}\n" }, { "path": "packages/api-generator/src/locale/en/VSkeletonLoader.json", "content": "{\n \"props\": {\n \"boilerplate\": \"Remove the loading animation from the skeleton.\",\n \"loading\": \"Applies a loading animation with a on-hover loading cursor. A value of **false** will only work when there is content in the `default` slot.\",\n \"loadingText\": \"aria-label for the element in a loading state.\",\n \"type\": \"A string delimited list of skeleton components to create such as `type=\\\"text@3\\\"` or `type=\\\"card, list-item\\\"`. Will recursively generate a corresponding skeleton from the provided string. Also supports short-hand for multiple elements such as **article@3** and **paragraph@2** which will generate 3 _article_ skeletons and 2 _paragraph_ skeletons. Please see below for a list of available pre-defined options.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSlideGroup.json", "content": "{\n \"props\": {\n \"centerActive\": \"Forces the selected component to be centered.\",\n \"contentClass\": \"Adds classes to the slide group item.\",\n \"direction\": \"Switch between horizontal and vertical modes.\",\n \"mobileBreakpoint\": \"Sets the designated mobile breakpoint for the component.\",\n \"nextIcon\": \"The appended slot when arrows are shown.\",\n \"prevIcon\": \"The prepended slot when arrows are shown.\",\n \"showArrows\": \"Change when the overflow arrow indicators are shown. By **default**, arrows *always* display on Desktop when the container is overflowing. When the container overflows on mobile, arrows are not shown by default. A **show-arrows** value of `true` allows these arrows to show on Mobile if the container overflowing. A value of `desktop` *always* displays arrows on Desktop while a value of `mobile` always displays arrows on Mobile. A value of `always` always displays arrows on Desktop *and* Mobile. Use **never** to turn arrows off. Find more information on how to customize breakpoint thresholds on the [breakpoints page](/customizing/breakpoints).\"\n },\n \"slots\": {\n \"next\": \"The next slot.\",\n \"prev\": \"The prev slot.\"\n },\n \"exposed\": {\n \"focus\": \"Focus the component.\",\n \"hasNext\": \"Returns true if there are items after current index.\",\n \"hasPrev\": \"Returns true if there are items before current index.\",\n \"scrollOffset\": \"Scroll the component to a given index.\",\n \"scrollTo\": \"Scroll the component to a given index.\",\n \"selected\": \"Get the selected component index.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSlider.json", "content": "{\n \"slots\": {\n \"thumb-label\": \"Slot for the thumb label.\",\n \"tick-label\": \"Slot for the tick label.\"\n },\n \"events\": {\n \"end\": \"Slider value emitted at the end of slider movement.\",\n \"start\": \"Slider value emitted at start of slider movement.\"\n },\n \"exposed\": {\n \"focus\": \"Focus the slider handle.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSnackbar.json", "content": "{\n \"props\": {\n \"loading\": \"Displays a loading spinner in the prepend area.\",\n \"prependAvatar\": \"Displays an avatar in the prepend area using the provided image source.\",\n \"prependIcon\": \"Displays an icon in the prepend area.\",\n \"reverseTimer\": \"Reverses the direction of the timer progress bar, filling up instead of depleting.\",\n \"timer\": \"Display a progress bar that counts down until the snackbar closes. Use `bottom` to change the default placement.\",\n \"timerColor\": \"Sets the color of the timer progress bar.\",\n \"timeout\": \"Time (in milliseconds) to wait until snackbar is automatically hidden. Use `-1` to keep open indefinitely. It is recommended for this number to be between `4000` and `10000`. Changes to this property will reset the countdown.\",\n \"transition\": \"Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition. Supports special location-aware mode with **slide-auto** and **scroll-auto**\",\n \"collapsed\": \"Alters the element size fit behind front snackbar in the queue.\",\n \"queueGap\": \"Sets the offset to show collapsed snackbars as a stack. Requires value in pixels.\",\n \"queueIndex\": \"The index position of this snackbar within a queue.\",\n \"vertical\": \"Stacks snackbar content on top of the actions (button).\"\n },\n \"slots\": {\n \"actions\": \"Used to bind styles to [v-btn](/components/buttons) to match MD2 specification.\",\n \"header\": \"Slot for custom content above the snackbar body.\"\n },\n \"exposed\": {\n \"animateClick\": \"Function invoked when user clicks outside.\",\n \"globalTop\": \"Used by activator to determine a components position in the global stack order.\",\n \"localTop\": \"Used by activator to determine a components position in the local stack order.\",\n \"updateLocation\": \"Function used for locationStrategy positioning.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSnackbarQueue.json", "content": "{\n \"props\": {\n \"closable\": \"Adds a dismiss button that closes the active snackbar.\",\n \"displayStrategy\": \"Determines how new snackbars are handled when the queue is full. **hold** (default) keeps new messages queued until a slot opens. **overflow** dismisses the oldest snackbar to make room for the new one.\",\n \"closeText\": \"The text used in the close button when using the **closable** prop.\",\n \"gap\": \"Sets the gap between stacked snackbars. Requires value in pixels.\",\n \"collapsed\": \"Puts the visible snackbars behind each other (expands on hover).\",\n \"totalVisible\": \"Specify the total visible snackbars.\"\n },\n \"exposed\": {\n \"clear\": \"Dismisses all visible snackbars and clears the queue.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSparkline.json", "content": "{\n \"props\": {\n \"autoDraw\": \"Trace the length of the line when first rendered.\",\n \"autoDrawDuration\": \"Amount of time (in ms) to run the trace animation.\",\n \"autoDrawEasing\": \"The easing function to use for the trace animation.\",\n \"autoLineWidth\": \"Automatically expand bars to use space efficiently.\",\n \"fill\": \"Using the **fill** property allows you to better customize the look and feel of your sparkline.\",\n \"gradient\": \"An array of colors to use as a linear-gradient.\",\n \"gradientDirection\": \"The direction the gradient should run.\",\n \"height\": \"Height of the SVG trendline or bars.\",\n \"labels\": \"An array of string labels that correspond to the same index as its data counterpart.\",\n \"labelSize\": \"The label font size.\",\n \"lineWidth\": \"The thickness of the line, in px.\",\n \"padding\": \"Low `smooth` or high `line-width` values may result in cropping, increase padding to compensate.\",\n \"showLabels\": \"Show labels below each data point.\",\n \"smooth\": \"Number of px to use as a corner radius. `true` defaults to 8, `false` is 0.\",\n \"type\": \"Choose between a trendline or bars.\",\n \"width\": \"Width of the SVG trendline or bars.\",\n \"id\": \"The id of the component.\",\n \"itemValue\": \"The value of the item.\",\n \"max\": \"The maximum value of the sparkline.\",\n \"min\": \"The minimum value of the sparkline.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSpeedDial.json", "content": "{\n \"props\": {\n \"openOnHover\": \"Opens speed-dial on hover.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VStepper.json", "content": "{\n \"props\": {\n \"completeIcon\": \"Icon to display when step is marked as completed.\",\n \"editIcon\": \"Icon to display when step is editable.\",\n \"errorIcon\": \"Icon to display when step has an error.\",\n \"flat\": \"Removes the stepper's elevation.\"\n },\n \"exposed\": {\n \"next\": \"Move to the next step.\",\n \"prev\": \"Move to the prev step.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VStepperActions.json", "content": "{\n \"props\": {\n \"nextText\": \"The text used for the Next button.\",\n \"prevText\": \"The text used for the Prev button.\"\n },\n \"events\": {\n \"click:next\": \"Event emitted when clicking the next button.\",\n \"click:prev\": \"Event emitted when clicking the prev button.\"\n },\n \"slots\": {\n \"next\": \"Slot for customizing the next step functionality\",\n \"prev\": \"Slot for customizing the prev step functionality\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VStepperHeader.json", "content": "{\n \"props\": {}\n}\n" }, { "path": "packages/api-generator/src/locale/en/VStepperItem.json", "content": "{\n \"props\": {\n },\n \"events\": {\n },\n \"slots\": {\n \"icon\": \"Slot for customizing all stepper item icons.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VStepperVertical.json", "content": "{\n \"props\": {\n \"completeIcon\": \"Icon to display when step is marked as completed.\",\n \"editIcon\": \"Icon to display when step is editable.\",\n \"errorIcon\": \"Icon to display when step has an error.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VStepperVerticalItem.json", "content": "{\n \"events\": {\n \"click:finish\": \"Event emitted when clicking the finish button\",\n \"click:next\": \"Event emitted when clicking the next button\",\n \"click:prev\": \"Event emitted when clicking the previous button\"\n },\n \"slots\": {\n \"icon\": \"Slot to override the icon\",\n \"next\": \"Slot to override the next button\",\n \"prev\": \"Slot to override the previous button\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VStepperWindow.json", "content": "{\n \"props\": {}\n}\n" }, { "path": "packages/api-generator/src/locale/en/VStepperWindowItem.json", "content": "{\n \"props\": {}\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSwitch.json", "content": "{\n \"props\": {\n \"flat\": \"Display component without elevation. Default elevation for thumb is 4dp, `flat` resets it.\",\n \"indeterminate\": \"Sets an indeterminate state for the switch.\",\n \"inset\": \"Enlarge the `v-switch` track to encompass the thumb.\",\n \"loading\": \"Displays circular progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - primary, secondary, success, info, warning, error) or a Boolean which uses the component color (set by color prop - if it's supported by the component) or the primary color.\",\n \"multiple\": \"Changes expected model to an array.\"\n },\n \"events\": {\n \"update:indeterminate\": \"Event that is emitted when the component's indeterminate state changes.\"\n },\n \"slots\": {\n \"thumb\": \"Slot for custom thumb content.\",\n \"track-true\": \"Slot for custom track content when value is true.\",\n \"track-false\": \"Slot for custom track content when value is false.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VSystemBar.json", "content": "{\n \"props\": {\n \"height\": \"Sets the height for the component.\",\n \"window\": \"Increases the system bar height to 32px (24px default).\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTab.json", "content": "{\n \"props\": {\n \"direction\": \"Changes the direction of the tabs. Can be either `horizontal` or `vertical`.\",\n \"hideSlider\": \"Hides the active tab slider component (no exit or enter animation).\",\n \"inset\": \"Changes the slider to take full height. Automatically propagated from VTabs.\",\n \"fixed\": \"Forces component to take up all available space up to their maximum width (300px), and centers it.\",\n \"sliderColor\": \"Applies specified color to the slider when active on that component - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors).\",\n \"sliderTransition\": \"Changes slider transition to one of the predefined animation presets.\",\n \"sliderTransitionDuration\": \"Applies custom slider transition duration. Default duration depends on transition type (fade: 400, grow: 350, shift: 225).\",\n \"stacked\": \"Displays the tab as a flex-column.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTable.json", "content": "{\n \"props\": {\n \"fixedFooter\": \"Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table.\",\n \"fixedHeader\": \"Use the fixed-header prop together with the height prop to fix the header to the top of the table.\",\n \"height\": \"Use the height prop to set the height of the table.\",\n \"hover\": \"Will add a hover effect to a table's row when the mouse is over it.\",\n \"striped\": \"Applies a background to either **even** or **odd** rows.\"\n },\n \"slots\": {\n \"bottom\": \"Slot to add content below the table.\",\n \"top\": \"Slot to add content above the table.\",\n \"wrapper\": \"Slots for custom rendering of the table wrapper.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTabs.json", "content": "{\n \"props\": {\n \"alignTabs\": \"Aligns the tabs to the `start`, `center`, or `end` of container. Also accepts `title` to align with the `v-toolbar-title` component.\",\n \"color\": \"Applies specified color to the selected tab - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors).\",\n \"centerActive\": \"Forces the selected tab to be centered.\",\n \"direction\": \"Changes the direction of the tabs. Can be either `horizontal` or `vertical`.\",\n \"fixedTabs\": \"Tabs will be centered and each tab item will grow up to 300px width.\",\n \"grow\": \"Forces tabs to take up all available space.\",\n \"height\": \"Sets the height of the tabs bar.\",\n \"hideSlider\": \"Hide's the generated `v-tabs-slider`.\",\n \"inset\": \"Changes the slider to take full height. Tabs will also get some spacing and customizable rounding.\",\n \"insetPadding\": \"Sets custom spacing between tabs for `inset` mode.\",\n \"insetRadius\": \"Sets custom border radius for the tabs container `inset` mode. Rounding for individual tabs is calculated by subtracting the padding.\",\n \"items\": \"The items to display in the component. This can be an array of strings or objects with a property `text`.\",\n \"mobileBreakpoint\": \"Sets the designated mobile breakpoint for the component.\",\n \"prevIcon\": \"Left pagination icon.\",\n \"nextIcon\": \"Right pagination icon.\",\n \"showArrows\": \"Show pagination arrows if the tab items overflow their container. For mobile devices, arrows will only display when using this prop.\",\n \"sliderColor\": \"Changes the background color of an auto-generated `v-tabs-slider`.\",\n \"sliderTransition\": \"Changes slider transition to one of the predefined animation presets.\",\n \"sliderTransitionDuration\": \"Applies custom slider transition duration. Default duration depends on transition type (fade: 400, grow: 350, shift: 225).\",\n \"stacked\": \"Apply the stacked prop to all children v-tab components.\"\n },\n \"slots\": {\n \"[`item.${string}`]\": \"Dynamic slot to define custom slots for specific tab window items\",\n \"[`tab.${string}`]\": \"Dynamic slot to define custom slots for specific tab headers in the slide group\",\n \"tab\": \"Slot for custom tab header content.\",\n \"window\": \"Slot for custom tab window content.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTextField.json", "content": "{\n \"props\": {\n \"autofocus\": \"Enables autofocus.\",\n \"clearIcon\": \"Applied when using **clearable** and the input is dirty.\",\n \"counterValue\": \"Function returns the counter display text.\",\n \"flat\": \"Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props.\",\n \"persistentPlaceholder\": \"Forces placeholder to always be visible.\",\n \"placeholder\": \"Sets the input’s placeholder text.\",\n \"prefix\": \"Displays prefix text.\",\n \"prependIcon\": \"Prepends an icon to the outside the component's input, uses the same syntax as `v-icon`.\",\n \"prependInnerIcon\": \"Prepends an icon inside the component's input, uses the same syntax as `v-icon`.\",\n \"reverse\": \"Reverses the input orientation.\",\n \"role\": \"The role attribute applied to the input.\",\n \"rounded\": \"Adds a border radius to the input.\",\n \"suffix\": \"Displays suffix text.\",\n \"type\": \"Sets input type.\"\n },\n \"events\": {\n \"click:append\": \"Emitted when append icon is clicked.\",\n \"click:appendInner\": \"Emitted when appended inner icon is clicked.\",\n \"click:clear\": \"Emitted when clearable icon clicked.\",\n \"click:prepend\": \"Emitted when prepended icon is clicked.\",\n \"click:prependInner\": \"Emitted when prepended inner icon is clicked.\",\n \"mousedown:control\": \"Event that is emitted when using mousedown on the main control area.\"\n },\n \"slots\": {\n \"counter\": \"Slot for the input’s counter text.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTextarea.json", "content": "{\n \"props\": {\n \"autoGrow\": \"Automatically grow the textarea depending on amount of text.\",\n \"counterValue\": \"Display the input length but do not provide any validation.\",\n \"noResize\": \"Remove resize handle.\",\n \"persistentPlaceholder\": \"Forces placeholder to always be visible.\",\n \"prefix\": \"Displays prefix text.\",\n \"rows\": \"Default row count.\",\n \"suffix\": \"Displays suffix text.\",\n \"maxHeight\": \"Alternative for **max-rows**. Specifies the maximum height in pixels (including the field padding) for **auto-grow**.\",\n \"maxRows\": \"Specifies the maximum number of rows for **auto-grow**.\",\n \"autofocus\": \"The element should be focused as soon as the page loads.\"\n },\n \"events\": {\n \"mousedown:control\": \"Event that is emitted when using mousedown on the main control area.\",\n \"update:rows\": \"Emitted when the number of rows changes.\"\n },\n \"slots\": {\n \"counter\": \"Slot for the input’s counter text.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VThemeProvider.json", "content": "{\n \"props\": {\n \"withBackground\": \"Wraps its children in an element and applies the current theme's background color to it.\"\n },\n \"slots\": {\n \"default\": \"All child components will have their theme overridden. Must have exactly one root element.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTimePicker.json", "content": "{\n \"props\": {\n \"allowedHours\": \"Restricts which hours can be selected.\",\n \"allowedMinutes\": \"Restricts which minutes can be selected.\",\n \"allowedSeconds\": \"Restricts which seconds can be selected.\",\n \"format\": \"Defines the format of a time displayed in picker. Available options are `ampm` and `24hr`.\",\n \"max\": \"Maximum allowed time.\",\n \"min\": \"Minimum allowed time.\",\n \"period\": \"Sets period for 12hr format.\",\n \"readonly\": \"Puts picker in readonly state.\",\n \"scrollable\": \"Allows changing hour/minute with mouse scroll.\",\n \"useSeconds\": \"Toggles the use of seconds in picker.\",\n \"width\": \"Width of the picker.\",\n \"viewMode\": \"The current view mode of the picker.`\"\n },\n \"slots\": {\n \"default\": \"Displayed below the clock, can be used for example for adding action button (`OK` and `Cancel`)\"\n },\n \"events\": {\n \"update:hour\": \"Emitted when user selects the hour.\",\n \"update:minute\": \"Emitted when user selects the minute.\",\n \"update:second\": \"Emitted when user selects the second.\",\n \"update:period\": \"Emitted when user clicks the AM/PM button.\",\n \"update:viewMode\": \"Emitted when the view mode changes.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTimePickerClock.json", "content": "{\n \"props\": {\n \"allowedValues\": \"Restricts which hours can be selected.\",\n \"ampm\": \"Displays time in a 12-hour format.\",\n \"displayedValue\": \"Used to display a custom value on the clock.\",\n \"double\": \"If set, this probably indicates a double rotation or a mode where more than one set of values (like hours and minutes) is displayed on the clock at the same time.\",\n \"format\": \"Specifies the format of the displayed time, either 12-hour or 24-hour, depending on the component's setup.\",\n \"max\": \"Defines the maximum time value that can be selected.\",\n \"min\": \"Defines the minimum time value that can be selected.\",\n \"readonly\": \"When true, the picker is in a read-only state, and users cannot modify the selected time.\",\n \"rotate\": \"Controls rotation, specifying the degree of rotation for the clock hands.\",\n \"scrollable\": \"Allows the time selection to be scrollable, enhancing user experience for devices with scroll inputs.\",\n \"step\": \"Defines the increments between selectable times, such as a step of 1 for every minute or a larger step for every 5 or 15 minutes.\"\n },\n \"events\": {\n \"change\": \"The event that is triggered when the selected time is changed.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTimePickerControls.json", "content": "{\n \"props\": {\n \"ampm\": \"Enables AM/PM mode.\",\n \"hour\": \"The current hour value.\",\n \"minute\": \"The current minute value.\",\n \"second\": \"The current second value.\",\n \"period\": \"The current period value. either `am` or `pm`.\",\n \"readonly\": \"Makes the timepicker readonly.\",\n \"useSeconds\": \"Enables the display and selection of seconds in the timepicker.\",\n \"value\": \"The current value of the timepicker.\",\n \"inputHints\": \"Displays labels below the time input controls.\",\n \"viewMode\": \"The current view mode of the timepicker. Can be either `hour`, `minute`, or `second`.\"\n },\n \"events\": {\n \"update:period\": \"Emitted when the period is changed. The event payload is either `am` or `pm`.\",\n \"update:hour\": \"Emitted when the hour value changes.\",\n \"update:minute\": \"Emitted when the minute value changes.\",\n \"update:second\": \"Emitted when the second value changes.\",\n \"update:viewMode\": \"Emitted when the view mode is changed. The event payload is either `hour`, `minute`, or `second`.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTimeline.json", "content": "{\n \"props\": {\n \"align\": \"Places the timeline dot at the top or center of the timeline item.\",\n \"direction\": \"Display timeline in a **vertical** or **horizontal** direction.\",\n \"justify\": \"Places timeline line at the center or automatically on the left or right side.\",\n \"lineColor\": \"Color of the timeline line.\",\n \"lineInset\": \"Specifies the distance between the line and the dot of timeline items.\",\n \"lineThickness\": \"Thickness of the timeline line.\",\n \"side\": \"Display all timeline items on one side of the timeline, either **start** or **end**.\",\n \"truncateLine\": \"Truncate timeline directly at the **start** or **end** of the line, or on **both** ends.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTimelineItem.json", "content": "{\n \"props\": {\n \"dotColor\": \"Color of the item dot.\",\n \"fillDot\": \"Remove outer border of item dot, making the color fill the entire dot.\",\n \"hideDot\": \"Hide the timeline item dot.\",\n \"hideOpposite\": \"Hide opposite content if it exists.\",\n \"icon\": \"Apply a specific icon to the inside dot using the [v-icon](/components/icons/) component.\",\n \"iconColor\": \"Color of the icon.\",\n \"lineInset\": \"Specifies the distance between the line and the dot of the item.\",\n \"side\": \"Show the item either **before** or **after** the timeline. This will override the implicit ordering of items, but will in turn be overridden by the `v-timeline` **single-side** prop.\",\n \"size\": \"Size of the item dot\"\n },\n \"slots\": {\n \"icon\": \"Used to customize the icon inside the item dot.\",\n \"opposite\": \"Used to customize the opposite side of timeline items.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VToolbar.json", "content": "{\n \"props\": {\n \"absolute\": \"Applies position: absolute to the component.\",\n \"collapse\": \"Puts the toolbar into a collapsed state reducing its maximum width.\",\n \"collapsePosition\": \"Specifies side to attach the collapsed toolbar.\",\n \"extended\": \"Use this prop to increase the height of the toolbar _without_ using the `extension` slot for adding content. May be used in conjunction with the **extension-height** prop. When false, will not show extension slot even if content is present.\",\n \"extensionHeight\": \"Specify an explicit height for the `extension` slot.\",\n \"flat\": \"Removes the toolbar's box-shadow.\",\n \"floating\": \"Applies **display: inline-flex** to the component.\",\n \"height\": \"Designates a specific height for the toolbar. Overrides the heights imposed by other props, e.g. **prominent**, **dense**, **extended**, etc.\",\n \"image\": \"Specifies a [v-img](/components/images) as the component's background.\",\n \"location\": \"Specifies the component's location. Can combine by using a space separated string. Requires the **absolute** prop.\"\n },\n \"slots\": {\n \"extension\": \"Slot positioned directly under the main content of the toolbar. Height of this slot can be set explicitly with the **extension-height** prop. If this slot has no content, the **extended** prop may be used instead.\",\n \"image\": \"Expects the [v-img](/components/images) component. Scoped **props** should be applied with `v-bind=\\\"props\\\"`.\"\n },\n \"exposed\": {\n \"contentHeight\": \"The current height of the component's content.\",\n \"extensionHeight\": \"The current height of the component's extension slot.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTooltip.json", "content": "{\n \"props\": {\n \"closeDelay\": \"Delay (in ms) after which menu closes (when open-on-hover prop is set to true).\",\n \"id\": \"HTML id attribute of the tooltip overlay. If not set, a globally unique id will be used.\",\n \"interactive\": \"When true, the tooltip will respond to pointer events, allowing you to copy text from it.\",\n \"openDelay\": \"Delay (in ms) after which tooltip opens (when `open-on-hover` prop is set to **true**).\",\n \"openOnClick\": \"Designates whether the tooltip should open on activator click.\",\n \"openOnHover\": \"Designates whether the tooltip should open on activator hover.\"\n },\n \"exposed\": {\n \"animateClick\": \"Function invoked when user clicks outside.\",\n \"globalTop\": \"Used by activator to determine a components position in the global stack order.\",\n \"localTop\": \"Used by activator to determine a components position in the local stack order.\",\n \"updateLocation\": \"Function used for locationStrategy positioning.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTreeview.json", "content": "{\n \"props\": {\n \"activatable\": \"Allows user to mark a node as active by clicking on it.\",\n \"color\": \"Applies specified color to the active node - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors).\",\n \"disabled\": \"Disables selection for all nodes.\",\n \"expandIcon\": \"Icon used to indicate that a node can be expanded.\",\n \"fluid\": \"Removes indentation from nested items.\",\n \"hideActions\": \"Hide the expand icon and loading indicator next to each item title.\",\n \"indeterminateIcon\": \"Icon used when node is in an indeterminate state. Only visible when `selectable` is `true`.\",\n \"itemChildren\": \"Property on supplied `items` that contains its children.\",\n \"items\": \"An array of items used to build the treeview.\",\n \"loadChildren\": \"A function used when dynamically loading children. If this prop is set, then the supplied function will be run if expanding an item that has a `item-children` property that is an empty array. Supports returning a Promise.\",\n \"loadingIcon\": \"Icon used when node is in a loading state.\",\n \"modelValue\": \"Allows one to control which nodes are selected. The array contains the values of currently selected items. It is equivalent to the `v-model:selected`\",\n \"openAll\": \"When `true` will cause all branch nodes to be opened when component is mounted.\",\n \"openOnClick\": \"When `true` will cause nodes to be opened by clicking anywhere on it, instead of only opening by clicking on expand icon. When using this prop with `activatable` you will be unable to mark nodes with children as active.\",\n \"returnObject\": \"When `true` will make `v-model`, `v-model:selected, `v-model:activated` and `v-model:opened` return the complete object instead of just the key.\",\n \"rounded\": \"Provides an alternative active style for `v-treeview` node. Only visible when `activatable` is `true` and should not be used in conjunction with the `shaped` prop.\",\n \"search\": \"The search model for filtering results.\",\n \"selectable\": \"Will render a checkbox next to each node allowing them to be selected. Additionally, the **[openOnClick](/api/v-treeview/#props-open-on-click)** property will be applied internally.\",\n \"selectedColor\": \"The color of the selection checkbox.\",\n \"separateRoots\": \"Applies to `default` variant of `indent-lines`. Prevents showing lines between root-level nodes.\",\n \"indentLines\": \"Controls visibility and variant of the indent lines.\",\n \"indentLinesColor\": \"Sets color of indent lines\",\n \"indentLinesOpacity\": \"Sets opacity of indent lines\",\n \"collapseIcon\": \"Icon to display when the list item is expanded.\"\n },\n \"slots\": {\n \"append\": \"Appends content after label.\",\n \"prepend\": \"Prepends content before label.\",\n \"header\": \"Slot for expandable nodes (all items that are not leafs).\",\n \"footer\": \"Slot for footer below expanded children.\",\n \"subheader\": \"Slot for custom subheader.\",\n \"divider\": \"Slot for custom divider.\"\n },\n \"events\": {\n \"click:open\": \"Emits the item when it is clicked to open.\",\n \"click:select\": \"Emits the item when it is clicked to select.\",\n \"update:activated\": \"Emits the array of active items when this value changes.\",\n \"update:opened\": \"Emits the array of open items when this value changes.\",\n \"update:selected\": \"Emits the array of selected items when this value changes.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTreeviewGroup.json", "content": "{\n \"props\": {\n \"fluid\": \"Removes indentation from nested items.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VTreeviewItem.json", "content": "{\n \"props\": {\n \"hideActions\": \"Hide the expand icon and loading indicator next to each item title.\",\n \"indentLines\": \"Array of indent lines to render next to the item.\",\n \"loading\": \"Places the v-treeview-item into a loading state.\",\n \"nav\": \"Reduces the width of v-list-item takes and adds a border radius.\",\n \"slim\": \"Reduces the vertical padding or height of the v-treeview-item, making it more compact.\",\n \"index\": \"The index of the item within the treeview list.\",\n \"toggleIcon\": \"Allows customization of the icon used to toggle the expansion and collapse of treeview branches.\"\n },\n \"events\": {\n \"toggleExpand\": \"Emitted when the item is toggled to expand or collapse.\"\n },\n \"slots\": {\n \"toggle\": \"Slot for custom expand icon and loading indicator.\"\n }\n}\n" }, { "path": "packages/api-generator/src/locale/en/VVideo.json", "content": "{\n \"props\": {\n \"aspectRatio\": \"Sets the aspect ratio for the playback, calculated as width/height.\",\n \"src\": \"Media file URL\",\n \"srcObject\": \"Sets the source of the video to a MediaStream, MediaSource, or Blob object. Useful for WebRTC streaming.\",\n \"type\": \"Media file type (optional)\",\n \"error\": \"Puts the component in the manual error state.\",\n \"image\": \"Apply a specific image as cover before the video is loaded.\",\n \"autoplay\": \"Starts loading the media file without waiting for user to click. Playback begins once enough data is loaded.\",\n \"muted\": \"Hides volume control and disables the playback sound.\",\n \"eager\": \"Silently loades the media file without waiting for user to click.\",\n \"hideOverlay\": \"Hide center play icon.\",\n \"noFullscreen\": \"Disable fullscreen and hide the default fullscreen button.\",\n \"rounded\": \"Applies a border radius to the video container and the controls. Accepts array of two values to customize elements separately.\",\n \"startAt\": \"Moves progress to the specified time (in seconds) once the media file is loaded.\",\n \"controlsProps\": \"Pass props through to the `v-video-controls` component. Accepts an object with anything from [v-video-controls](/api/v-video-controls/#props) props, camelCase keys are recommended.\",\n \"controlsTransition\": \"The reveal transition applied to the VVideoControls component once the media file is loaded.\",\n \"controlsVariant\": \"Variant passed to the VVideoControls component.\"\n },\n \"events\": {\n \"loaded\": \"Emitted when the video has loaded and is ready to be played.\",\n \"update:playing\": \"Emitted when playing state changes.\",\n \"update:progress\": \"Emitted when the internal playback progress changes.\",\n \"update:volume\": \"Emitted when the volume changes.\",\n \"error\": \"Emits `true` when the video fails to load or `false` when user triggered retry.\"\n },\n \"slots\": {\n \"header\": \"Slot for additional content placed on top of the video.\",\n \"append\": \"Additional content on the right within the control bar.\",\n \"controls\": \"Replaces controls bar with custom content.\",\n \"loader\": \"Slot used to replace loader displayed when the video is being loaded.\",\n \"prepend\": \"Additional content on the left within the control bar.\",\n \"sources\": \"Slot for content placed within native `