arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-14 20:19:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(getting-started): update

Browse Source
This commit is contained in:
Benjamin Canac
2024-09-12 12:22:17 +02:00
parent 8898a5d675
commit 2fc6e18179
1 changed files with 15 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/content/1.getting-started/1.index.md
View File

@@ -16,7 +16,6 @@ We've transitioned from [Headless UI](https://headlessui.com/) to [Radix Vue](ht
- **Active Development**: Radix Vue's growing popularity ensures ongoing improvements and updates.
- **Enhanced Accessibility**: Built-in accessibility features align with our commitment to inclusive design.
- **Vue 3 Optimization**: Seamless integration with Vue 3 and the Composition API.
- **Performance Boost**: Radix Vue's performance-focused design improves overall application efficiency.
This transition empowers Nuxt UI to become a more comprehensive and flexible UI library, offering developers greater power and customization options.
@@ -24,14 +23,10 @@ This transition empowers Nuxt UI to become a more comprehensive and flexible UI
Nuxt UI v3 integrates the latest Tailwind CSS v4 alpha (announced March 6, 2024), bringing significant improvements:
- **Faster Builds**: Up to 10-20x faster, especially for larger projects.
- **Enhanced Developer Experience**: Improved error messages and smarter autocomplete.
- **Advanced Styling**: Native color functions, extended animations, and flexible custom properties.
- **Optimized Performance**: Smaller CSS output and more efficient style application.
::caution
Tailwind CSS v4 is currently in alpha. While it offers exciting new features for Nuxt UI v3, we strongly recommend thorough testing in development environments before considering production use.
::
- **Faster Builds**: Up to 10x faster, especially for larger projects.
- **Unified Toolchain**: Built-in features like vendor prefixing, nesting support, and modern CSS transforms.
- **CSS-First Configuration**: New `@theme` directive for easy customization without JavaScript.
- **Optimized Performance**: Smaller engine footprint and more efficient processing.
::note
For a comprehensive overview of Tailwind CSS v4 alpha features, visit the [official announcement](https://tailwindcss.com/blog/tailwindcss-v4-alpha).
@@ -39,13 +34,13 @@ For a comprehensive overview of Tailwind CSS v4 alpha features, visit the [offic
### Tailwind Variants
We've adopted [Tailwind Variants](https://github.com/nextui-org/tailwind-variants) to manage our design system, offering:
We've adopted [Tailwind Variants](https://www.tailwind-variants.org/) to manage our design system, offering:
- **Dynamic Styling**: Create flexible component styles and enhance customization while maintaining consistency.
- **Performance and TypeScript**: Optimize style generation with minimal overhead and improve development with full TypeScript support.
- **Responsive Design**: Simplify creation of adaptive components and combine conditions for complex variations.
- **Dynamic Styling**: Flexible component variants with a powerful API
- **Type Safety**: Full TypeScript support with auto-completion
- **Conflict Resolution**: Efficient merging of conflicting styles
This integration streamlines development, enhances flexibility, improves maintainability, and boosts overall performance in Nuxt UI v3.
This integration unifies the styling of components, ensuring consistency and code maintainability.
## Migration
@@ -56,17 +51,11 @@ Key points to consider:
- Review the new documentation and components carefully before attempting to upgrade.
- If you encounter any issues, please report them on our [GitHub repository](https://github.com/nuxt/ui/issues).
## Frequently Asked Questions
## FAQ
::accordion
::accordion-item{label="What are the main compatibility challenges when upgrading to Nuxt UI v3?"}
The transition to Radix Vue and other significant changes limit direct compatibility between v2 and v3. Major differences include:
- New component structure and APIs
- Changes in theming and customization approaches
- Updated TypeScript definitions and prop types
We recommend a careful, incremental approach to upgrading, starting with thorough testing in a development environment.
::accordion-item{label="What are the main considerations when upgrading to Nuxt UI v3?"}
The transition to v3 involves significant changes, including new component structures, updated theming approaches, and revised TypeScript definitions. We recommend a careful, incremental upgrade process, starting with thorough testing in a development environment.
::
::accordion-item{label="Will Nuxt UI v3 work with other CSS frameworks like UnoCSS?"}
@@ -74,7 +63,7 @@ Key points to consider:
::
::accordion-item{label="Is Nuxt UI v3 compatible with standalone Vue projects?"}
We're planning to add Vue support in the near future. For now, Nuxt UI v3 is only available for Nuxt projects. Track progress on Vue compatibility [in this issue](https://github.com/nuxt/ui/issues/2129).
We're planning to add Vue support in the near future. For now, Nuxt UI v3 is only available for Nuxt. Track progress on Vue compatibility [in this issue](https://github.com/nuxt/ui/issues/2129).
::
::accordion-item{label="Is this version stable and suitable for production use?"}
@@ -82,4 +71,6 @@ Key points to consider:
::
::
:hr
We're excited about the possibilities Nuxt UI v3 brings to your projects. Explore our documentation to learn more about new features, components, and best practices for building powerful, accessible user interfaces with Nuxt UI v3.