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

docs(app): update

Browse Source
This commit is contained in:
Benjamin Canac
2024-07-26 11:05:20 +02:00
parent 3319144962
commit ce28607d7d
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/content/3.components/0.app.md
View File

@@ -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]
<template>
@@ -19,12 +27,6 @@ Wrap your app with this component in your `app.vue` to provide global configurat
</template>
```
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