Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: call use client properly #1053

Merged
merged 1 commit into from
Nov 17, 2024
Merged

Conversation

akins-dev
Copy link
Contributor

@akins-dev akins-dev commented Nov 17, 2024

Screenshot from 2024-11-17 14-18-07

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions for setting up the Next.js App Router with UploadThing.
    • Clarified environment variable setup, including the UPLOADTHING_TOKEN.
    • Expanded guidance on creating a FileRouter, including permitted file types and error handling.
    • Added instructions for creating a Next.js API route using the FileRouter.
    • Corrected the presentation of the "use client"; directive.
    • Introduced an optional section on improving server-side rendering with <NextSSRPlugin />.

Copy link

changeset-bot bot commented Nov 17, 2024

⚠️ No Changeset found

Latest commit: 78fc609

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Nov 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-uploadthing ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 17, 2024 1:22pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
legacy-docs-uploadthing ⬜️ Ignored (Inspect) Visit Preview Nov 17, 2024 1:22pm

Copy link
Contributor

coderabbitai bot commented Nov 17, 2024

Walkthrough

The pull request introduces significant updates to the documentation for integrating UploadThing with the Next.js App Router. Key modifications include clearer installation instructions, detailed environment variable setup, and comprehensive guidance on creating a FileRouter. The documentation now emphasizes error handling, API route creation, and the use of UploadThing components. Additionally, there are corrections to directives and new recommendations for enhancing server-side rendering with a plugin. Overall, these changes aim to improve clarity and usability for developers.

Changes

File Path Change Summary
docs/src/app/(docs)/getting-started/appdir/page.mdx Updated installation instructions, environment variable setup, and FileRouter creation details.
app/api/uploadthing/core.ts Updated OurFileRouter type content.
app/api/uploadthing/route.ts Updated method signatures for GET and POST.
src/utils/uploadthing.ts Updated method signatures for UploadButton and UploadDropzone.
app/layout.tsx Updated method signature for RootLayout.

Possibly related PRs

Suggested labels

📚 documentation

Suggested reviewers

  • juliusmarminge

Poem

🐇 In the meadow where bunnies play,
New docs bloom bright, guiding the way.
With UploadThing's charm and Next.js flair,
Setting up routes with love and care.
So hop along, dear devs, don't delay,
Embrace the changes, let code sway! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4954c99 and 78fc609.

📒 Files selected for processing (1)
  • docs/src/app/(docs)/getting-started/appdir/page.mdx (1 hunks)

@@ -158,7 +158,7 @@ export const UploadDropzone = generateUploadDropzone<OurFileRouter>();
## Mount A Button And Upload!

<Warning>
Don't forget to add the `"use client;"` directive at the top of your file,
Don't forget to add the `"use client";` directive at the top of your file,
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

LGTM! Important fix for the "use client" directive syntax.

The removal of the period after the "use client" directive is correct. The directive must be exactly "use client"; without any additional punctuation to properly mark a component for client-side rendering in Next.js.

@juliusmarminge juliusmarminge merged commit 7bce139 into pingdotgg:main Nov 17, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants