mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-22 05:35:13 +00:00
docs: add app-config
example (#7247)
Co-authored-by: Pooya Parsa <pooya@pi0.io>
This commit is contained in:
parent
8a81f2ad90
commit
94261349dc
14
docs/content/4.examples/1.app/app-config.md
Normal file
14
docs/content/4.examples/1.app/app-config.md
Normal 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"}
|
6
examples/app-config/app.config.ts
Normal file
6
examples/app-config/app.config.ts
Normal 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
|
||||||
|
})
|
13
examples/app-config/app.vue
Normal file
13
examples/app-config/app.vue
Normal 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>
|
7
examples/app-config/nuxt.config.ts
Normal file
7
examples/app-config/nuxt.config.ts
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
import { defineNuxtConfig } from 'nuxt'
|
||||||
|
|
||||||
|
export default defineNuxtConfig({
|
||||||
|
modules: [
|
||||||
|
'@nuxt/ui'
|
||||||
|
]
|
||||||
|
})
|
13
examples/app-config/package.json
Normal file
13
examples/app-config/package.json
Normal 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"
|
||||||
|
}
|
||||||
|
}
|
3
examples/app-config/tsconfig.json
Normal file
3
examples/app-config/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user