Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(typescript): add new page #20061

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/docs/src/data/nav.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@
"scrolling",
"sass-variables",
"theme",
"treeshaking"
"treeshaking",
"typescript"
]
},
{
Expand Down
27 changes: 27 additions & 0 deletions packages/docs/src/pages/en/features/typescript.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
emphasized: true
meta:
title: Typescript
description: Vuetify supports Typescript out of the box. Learn how to get started with Typescript in your Vuetify project.
keywords: typescript, typescript support, typescript setup, typescript configuration
related:
- /features/treeshaking/
- /getting-started/unit-testing/
- /getting-started/contributing/
---

# Typescript

Vuetify supports Typescript out of the box. This means that you can use Typescript in your Vuetify project without any additional configuration.

## Installation

To get started with a new project using Typescript, following the instructions in the [Getting Started](/getting-started/installation/) guide and select the Typescript option when prompted.

## Types

Vuetify provides types for all of its components and seamlessly integrates with Typescript. If you're using an IDE such as VSCode, with the [Vue - Official extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar) and `<script lang="ts">`, you'll get automatic type checking and code completion.

## Custom components

TODO