search

pingdotgg / uploadthing

File uploads for modern web devs
https://uploadthing.com
MIT License
4.27k stars 319 forks source link

feat: Migrate Svelte package to Svelte 5 #1049

Open AlanAcDz opened 2 weeks ago

AlanAcDz commented 2 weeks ago

This updates the svelte package to make full use of the new v5 features.

Props

Component props use the $props rune. Makes them easier to type and manage compared to the bunch of export let declarations.

State

Caveats*

Snippets

Components now accept (as props) snippets instead of named slots. Also a breaking change and I added a note in the docs for this as well.

Other changes include the syntax change for declaring event listeners and no workarounds needed any more to work with generics in svelte components.

Summary by CodeRabbit

changeset-bot[bot] commented 2 weeks ago

⚠️ No Changeset found

Latest commit: a9f049511bed5ea905b1ad4fd944b93bfc1fa39f

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

vercel[bot] commented 2 weeks ago

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 12, 2024 5:22pm
1 Skipped Deployment | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **legacy-docs-uploadthing** | ⬜️ Ignored ([Inspect](https://vercel.com/pinglabs/legacy-docs-uploadthing/EMiGziBqj76FhpbXCHaXABP9BErn)) | [Visit Preview](https://legacy-docs-uploadthing-git-fork-alanacdz-svelt-74cc3b-pinglabs.vercel.app) | | Nov 12, 2024 5:22pm |
coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces significant updates to the documentation and implementation of the UploadThing library for SvelteKit. Key changes include modifications to code examples, emphasizing the use of the createUploadThing helper function, and transitioning from named slots to snippets for content customization in components. Additionally, updates to various Svelte components and their corresponding package configurations reflect changes in state management and prop handling, ensuring compatibility with the latest library versions.

Changes

File Path Change Summary
docs/src/app/(docs)/getting-started/svelte/page.mdx Updated documentation with new code examples and explanations for createUploadThing usage and component customization.
examples/minimal-sveltekit/package.json Updated @uploadthing/svelte version from 7.1.1 to 7.2.0 and several devDependencies to newer versions.
examples/minimal-sveltekit/src/routes/+page.svelte Changed how startUpload is accessed, now using ut.startUpload instead of destructuring.
packages/svelte/package.json Updated @uploadthing/svelte version to 7.2.0 and modified peer dependencies to require svelte version ^5.0.0.
packages/svelte/src/lib/component/Cancel.svelte Restructured prop handling using a new Props type definition.
packages/svelte/src/lib/component/UploadButton.svelte Consolidated props into a single Props type, updated internal state management, and adjusted upload handling logic.
packages/svelte/src/lib/component/UploadDropzone.svelte Refactored props structure and upload handling logic, consolidating into a Props type and improving state management.
packages/svelte/src/lib/component/Uploader.svelte Introduced a Props interface for clearer prop handling and removed workaround comments.
packages/svelte/src/lib/component/create-dropzone.svelte.ts Enhanced state management and refactored property handling in createDropzone.
packages/svelte/src/lib/create-uploadthing.svelte.ts Updated createRouteConfig and useUploadThing functions for simpler state management and modified import paths.
packages/svelte/src/lib/index.ts Updated export paths to include .svelte file extension.
packages/svelte/src/lib/utils/createFetch.svelte.ts Introduced FetchResponse class for state management and updated createFetch function to return this new instance.
tooling/eslint-config/package.json Updated eslint-plugin-svelte version from ^2.35.1 to ^2.46.0.
tooling/eslint-config/svelte.js Added svelteFeatures with experimentalGenerics to ESLint configuration for Svelte files.

Possibly related PRs

Suggested labels

examples, 📚 documentation

Suggested reviewers

🐰 In the meadow, changes abound,
With UploadThing, new paths are found.
Documentation shines, examples are bright,
SvelteKit's journey takes flight!
Snippets and props, all in a row,
Hopping along, watch our features grow! 🌼✨

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.