From cac41137ae0250546be298027ea5d83c993ff7b8 Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Wed, 25 Sep 2024 16:42:40 +0200 Subject: [PATCH] docs(getting-started): update --- docs/content/1.getting-started/1.index.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/content/1.getting-started/1.index.md b/docs/content/1.getting-started/1.index.md index effad819..9a282e06 100644 --- a/docs/content/1.getting-started/1.index.md +++ b/docs/content/1.getting-started/1.index.md @@ -42,6 +42,26 @@ We've adopted [Tailwind Variants](https://www.tailwind-variants.org/) to manage This integration unifies the styling of components, ensuring consistency and code maintainability. +### TypeScript Integration + +Nuxt UI v3 offers significantly improved TypeScript integration, providing a superior developer experience: + +- **Enhanced Auto-completion**: + - Full auto-completion for component props based on your theme + - Intelligent suggestions for `app.config.ts` theme configuration + +- **Generic-based Components**: + - Built using [Vue 3 Generics](https://vuejs.org/api/sfc-script-setup.html#generics) + - Improved type inference for slots and events + +- **Type-safe Theming**: + - Leveraging Tailwind Variants for type-safe styling options + - Customizable types for extended theme configurations + +::note{to="/components/accordion#with-custom-slot"} +Check out an example of the Accordion component with auto-completion for props and slots. +:: + ## Migration We want to be transparent: migrating from Nuxt UI v2 to v3 will require significant effort. While we've maintained core concepts and components, Nuxt UI v3 has been rebuilt from the ground up, resulting in a new library with enhanced capabilities.