Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.
/frameworkPublic archive

docs(api): add useNuxtApp composable - #6786

Merged
pi0 merged 26 commits into
nuxt:mainfrom
Krutie:docs/api-composable-use-nuxt-app
Aug 22, 2022
Merged

docs(api): add useNuxtApp composable#6786
pi0 merged 26 commits into
nuxt:mainfrom
Krutie:docs/api-composable-use-nuxt-app

Conversation

@Krutie

@KrutieKrutie commented Aug 19, 2022

Copy link
Copy Markdown
Contributor

🔗 Linked issue nuxt/nuxt#13653

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Added API documentation for useNuxtApp composable

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@netlify

netlifyBot commented Aug 19, 2022•
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for nuxt3-docs ready!

NameLink
🔨 Latest commit059abaa
🔍 Latest deploy loghttps://app.netlify.com/sites/nuxt3-docs/deploys/63039ee3fb3412000891324b
😎 Deploy Previewhttps://deploy-preview-6786--nuxt3-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

qin-guan
qin-guan reviewed Aug 21, 2022
View reviewed changes
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
DamianGlowala
DamianGlowala suggested changes Aug 22, 2022
View reviewed changes
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md Outdated
pi0and others added 22 commits August 22, 2022 12:46
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
97e2f34
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
4f67c03
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
f7189f2
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
6166eec
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
be86ba0
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
bad40ac
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
4603101
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
1e35140
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
7e5a3ba
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
82e91f8
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
72af002
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
bf2d2be
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
483d779
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
decaa0c
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
4ac796e
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
3deed14
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Update docs/content/3.api/1.composables/use-nuxt-app.md
9ea602c
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0@DamianGlowala
Apply suggestions from code review
51b8e08
Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>
@pi0
Merge branch 'main' into docs/api-composable-use-nuxt-app
307510d
@pi0
remove globalName from docs
d17bc1d
it is not used and modification should be build time
@pi0
updates
83b8ad3
- try to use external docs as possible to avoid duplicate and outdated docs
- avoid mentioning internals which can potentially be changed
@pi0
refactor ordering
059abaa
@pi0pi0 changed the title docs(api): add useNuxtApp composable docsdocs(api): add useNuxtApp composableAug 22, 2022
pi0
pi0 approved these changes Aug 22, 2022
View reviewed changes

@pi0pi0 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@pi0
pi0 merged commit dc6b6ce into nuxt:mainAug 22, 2022
DamianGlowala
DamianGlowala reviewed Aug 22, 2022
View reviewed changes
Comment threaddocs/content/3.api/1.composables/use-nuxt-app.md
`hook` function is useful for adding custom logic by hooking into the rendering lifecycle at a specific point. `hook` function is mostly used when creating Nuxt plugins.

`ssrContext` is generated during server-side rendering and it is only available on the server side. Nuxt exposes the following properties through `ssrContext`:
See [Runtime Hooks](/api/advanced/hooks#app-hooks-runtime) for avialble runtime hooks called by Nuxt.

@DamianGlowalaDamianGlowalaAug 22, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pi0 little typo: avialble

@pi0pi0Aug 22, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the notice. (please check your discord when could. I've sent a message)

@pi0pi0 mentioned this pull request Aug 26, 2022
Merged
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

3 more reviewers
@pi0pi0pi0 approved these changes
@qin-guanqin-guanqin-guan left review comments
@DamianGlowalaDamianGlowalaDamianGlowala requested changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

3.x

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@Krutie@pi0@qin-guan@DamianGlowala@danielroe