From ce28607d7d5bea7244e15f3ac91aeb93f73e5c00 Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Fri, 26 Jul 2024 11:05:20 +0200 Subject: [PATCH] docs(app): update --- docs/content/3.components/0.app.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/content/3.components/0.app.md b/docs/content/3.components/0.app.md index ad435177..c282b387 100644 --- a/docs/content/3.components/0.app.md +++ b/docs/content/3.components/0.app.md @@ -1,6 +1,6 @@ --- title: App -description: Starting point for your Nuxt UI app. +description: Wraps your app to provide global configurations and more. links: - label: GitHub icon: i-simple-icons-github @@ -9,7 +9,15 @@ links: ## Usage -Wrap your app with this component in your `app.vue` to provide global configurations and enable features like toasts, tooltips, etc. as well as programmatic modals and slideovers. +This component implements Radix Vue [ConfigProvider](https://www.radix-vue.com/utilities/config-provider.html) to provide global configuration to all components: + +- Enables all primitives to inherit global reading direction. +- Enables changing the behavior of scroll body when setting body lock. +- Much more controls to prevent layout shifts. + +It's also using [ToastProvider](https://www.radix-vue.com/components/toast.html#provider) and [TooltipProvider](https://www.radix-vue.com/components/tooltip.html#provider) to provide global toasts and tooltips, as well as programmatic modals and slideovers. + +Use it as at the root of your app: ```vue [app.vue] ``` -It's using Radix Vue's [ConfigProvider](https://www.radix-vue.com/utilities/config-provider.html) to provide global configuration to all components: - -- Enables all primitives to inherit global reading direction. -- Enables changing the behavior of scroll body when setting body lock. -- Much more controls to prevent layout shifts. - ## API ### Props