docs: add `app-config` example (#7247)

Co-authored-by: Pooya Parsa <pooya@pi0.io>
This commit is contained in:
Sébastien Chopin 2022-09-05 15:16:30 +02:00 committed by GitHub
parent 8a81f2ad90
commit 94261349dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 56 additions and 0 deletions

View File

@ -0,0 +1,14 @@
---
template: Example
---
# `app.config`
> Nuxt 3 provides an app.config config file to expose reactive configuration within your application with the ability to update it at runtime within lifecycle or using a nuxt plugin and editing it with HMR (hot-module-replacement).
This example shows how to use `app.config` feature.
::ReadMore{link="/guide/features/app-config"}
::
::sandbox{repo="nuxt/framework" branch="main" dir="examples/app-config" file="app.vue"}

View File

@ -0,0 +1,6 @@
export default defineAppConfig({
title: 'Hello App Config',
description:
'This is some content coming from app.config.ts that support HMR, try to update it and see it in action.',
showButton: false
})

View File

@ -0,0 +1,13 @@
<script setup>
const config = useAppConfig()
</script>
<template>
<NuxtExampleLayout example="app-config">
<h1>{{ config.title }}</h1>
<p>{{ config.description }}</p>
<button v-if="config.showButton">
I am a button
</button>
</NuxtExampleLayout>
</template>

View File

@ -0,0 +1,7 @@
import { defineNuxtConfig } from 'nuxt'
export default defineNuxtConfig({
modules: [
'@nuxt/ui'
]
})

View File

@ -0,0 +1,13 @@
{
"name": "example-app-config",
"private": true,
"scripts": {
"build": "nuxi build",
"dev": "nuxi dev",
"start": "nuxi preview"
},
"devDependencies": {
"@nuxt/ui": "^0.2.0",
"nuxt": "npm:nuxt3@latest"
}
}

View File

@ -0,0 +1,3 @@
{
"extends": "./.nuxt/tsconfig.json"
}