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

docs(api): add <ClientOnly> to API docs - #8400

Merged
atinux merged 2 commits into
nuxt:mainfrom
huang-julien:docs/api/client-only
Oct 21, 2022
Merged

docs(api): add <ClientOnly> to API docs#8400
atinux merged 2 commits into
nuxt:mainfrom
huang-julien:docs/api/client-only

Conversation

@huang-julien

Copy link
Copy Markdown
Member

🔗 Linked issue

❓ 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

Hi 👋 this add <ClientOnly> to the api docs.

📝 Checklist

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

@codesandbox

Copy link
Copy Markdown

CodeSandbox logoCodeSandbox logo Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

@netlify

netlifyBot commented Oct 21, 2022

Copy link
Copy Markdown

Deploy Preview for nuxt3-docs ready!

NameLink
🔨 Latest commitea2b258
🔍 Latest deploy loghttps://app.netlify.com/sites/nuxt3-docs/deploys/63531a90d330de0008a11c4e
😎 Deploy Previewhttps://deploy-preview-8400--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.

@atinux

Copy link
Copy Markdown
Member

Thank you @huang-julien it looks great!

I would actually set it as top of the list since we want to list in alphabetical order (1.client-only.md).

@atinux
atinux self-requested a review October 21, 2022 22:47
@atinux
atinux merged commit 02227a2 into nuxt:mainOct 21, 2022
@danielroe

Copy link
Copy Markdown
Member

couldn't imagine a better person to write these docs 😊

@huang-julien

Copy link
Copy Markdown
MemberAuthor

thank you ❤️

---
# `<ClientOnly>`

The `<ClientOnly>` component renders its slot only in client-side. To import a component only on the client, register the component in a client-side only plugin.

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.

(there seems a type at end of the sentence)

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

which one ?

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.

Instead of the plugin, I assume you meant "within the component". (Alternative to .client components)

@huang-julienhuang-julienOct 25, 2022

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

this was retrieved from the guide docs.
Maybe changing to To import a component only on the client, add the .client suffix to the component file name or import it explicitly within the component. might be better ?


## Props

- **placeholderTag** | **fallbackTag**: specify a tag to be rendered server-side.

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.

(default missing)

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

i'll fix this :) thanks !

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@huang-julien@atinux@danielroe@pi0