Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

Commit

Permalink
docs: add app-config example (#7247)
Browse files Browse the repository at this point in the history
Co-authored-by: Pooya Parsa <[email protected]>
  • Loading branch information
atinux and pi0 authored Sep 5, 2022
1 parent 8a81f2a commit 9426134
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/content/4.examples/1.app/app-config.md
Original file line number Diff line number Diff line change
@@ -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 changes: 6 additions & 0 deletions examples/app-config/app.config.ts
Original file line number Diff line number Diff line change
@@ -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 changes: 13 additions & 0 deletions examples/app-config/app.vue
Original file line number Diff line number Diff line change
@@ -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 changes: 7 additions & 0 deletions examples/app-config/nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { defineNuxtConfig } from 'nuxt'

export default defineNuxtConfig({
modules: [
'@nuxt/ui'
]
})
13 changes: 13 additions & 0 deletions examples/app-config/package.json
Original file line number Diff line number Diff line change
@@ -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 changes: 3 additions & 0 deletions examples/app-config/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "./.nuxt/tsconfig.json"
}

0 comments on commit 9426134

Please sign in to comment.