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

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

Merged
merged 2 commits into from
Oct 21, 2022

Conversation

huang-julien
Copy link
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

codesandbox bot commented Oct 21, 2022

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

@netlify
Copy link

netlify bot commented Oct 21, 2022

βœ… Deploy Preview for nuxt3-docs ready!

Name Link
πŸ”¨ Latest commit ea2b258
πŸ” Latest deploy log https://app.netlify.com/sites/nuxt3-docs/deploys/63531a90d330de0008a11c4e
😎 Deploy Preview https://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.

Copy link
Member

atinux commented Oct 21, 2022

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:main Oct 21, 2022
@danielroe
Copy link
Member

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

@huang-julien
Copy link
Member Author

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
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
Member Author

Choose a reason for hiding this comment

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

which one ?

Copy link
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)

Copy link
Member Author

@huang-julien huang-julien Oct 25, 2022

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
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
Member Author

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 !

@pi0 pi0 mentioned this pull request Nov 3, 2022
@danielroe danielroe added the 3.x label Jan 19, 2023
Sign up for free to 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