diff --git a/packages/@uppy/svelte/package.json b/packages/@uppy/svelte/package.json index d8b41f0fe7..dc1d0f1075 100644 --- a/packages/@uppy/svelte/package.json +++ b/packages/@uppy/svelte/package.json @@ -1,5 +1,6 @@ { "name": "@uppy/svelte", + "description": "Uppy plugin that helps integrate Uppy into your Svelte project.", "svelte": "src/index.js", "module": "dist/index.mjs", "main": "dist/index.js", @@ -9,11 +10,13 @@ "prepublishOnly": "yarn run build", "validate": "svelte-check" }, - "dependencies": { - "@uppy/dashboard": "workspace:^", - "@uppy/drag-drop": "workspace:^", - "@uppy/progress-bar": "workspace:^", - "@uppy/status-bar": "workspace:^" + "homepage": "https://uppy.io", + "bugs": { + "url": "https://github.com/transloadit/uppy/issues" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/transloadit/uppy.git" }, "devDependencies": { "@rollup/plugin-node-resolve": "^13.0.0", @@ -26,12 +29,19 @@ }, "peerDependencies": { "@uppy/core": "workspace:^", + "@uppy/dashboard": "workspace:^", + "@uppy/drag-drop": "workspace:^", + "@uppy/progress-bar": "workspace:^", + "@uppy/status-bar": "workspace:^", "svelte": "^3.0.0" }, "publishConfig": { "access": "public" }, "keywords": [ + "file uploader", + "uppy", + "uppy-plugin", "svelte" ], "files": [ diff --git a/website/src/docs/migration-guides.md b/website/src/docs/migration-guides.md index 4edd881319..25c0253a52 100644 --- a/website/src/docs/migration-guides.md +++ b/website/src/docs/migration-guides.md @@ -168,6 +168,12 @@ It’s internal usage only. To migrate: use exposed options only. +#### `@uppy/svelte` + +`@uppy/dashboard`, `@uppy/drag-drop`, `@uppy/progress-bar`, and `@uppy/status-bar` are now peer dependencies. This means you don’t install all these packages if you only need one. + +To migrate: install only the packages you need. If you use the Dashboard component, you need `@uppy/dashboard`, and so onwards. + #### `@uppy/vue` `@uppy/dashboard`, `@uppy/drag-drop`, `@uppy/file-input`, `@uppy/progress-bar`, and `@uppy/status-bar` are now peer dependencies. This means you don’t install all these packages if you only need one. diff --git a/website/src/docs/svelte.md b/website/src/docs/svelte.md index 8adbad9e2a..cd5bd13b32 100644 --- a/website/src/docs/svelte.md +++ b/website/src/docs/svelte.md @@ -82,13 +82,14 @@ const uppy = new Uppy().use(Webcam); ``` -The following plugins are available as Svelte component wrappers: +The following plugins are available as Svelte component wrappers (you need to +install each package separately): -* `` - renders an inline `@uppy/dashboard` -* `` - renders a `@uppy/dashboard` modal -* `` - renders a `@uppy/drag-drop` area -* `` - renders a `@uppy/progress-bar` -* `` - renders a `@uppy/status-bar` +* `` - renders an inline [`@uppy/dashboard`][]. +* `` - renders a [`@uppy/dashboard`][] modal. +* `` - renders a [`@uppy/drag-drop`][] area. +* `` - renders a [`@uppy/progress-bar`][]. +* `` - renders a [`@uppy/status-bar`][]. Each component takes a `props` prop that will be passed to the UI Plugin. Both `@uppy/dashboard` based plugins also take a `plugins` array as a props, make it easier to add your plugins. @@ -222,6 +223,14 @@ Import general Core styles from `@uppy/core/dist/style.css` first, then add the The `` component supports all `@uppy/status-bar` options to be passed as an object on the `props` prop. An Uppy instance must be provided in the `uppy={}` prop. +[`@uppy/dashboard`]: /docs/dashboard + +[`@uppy/drag-drop`]: /docs/drag-drop + +[`@uppy/progress-bar`]: /docs/progress-bar + +[`@uppy/status-bar`]: /docs/status-bar + [`@uppy/webcam`]: /docs/webcam/ [Svelte]: https://svelte.dev diff --git a/yarn.lock b/yarn.lock index c760ce085d..2d6208500c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -8813,10 +8813,6 @@ __metadata: dependencies: "@rollup/plugin-node-resolve": ^13.0.0 "@tsconfig/svelte": ^3.0.0 - "@uppy/dashboard": "workspace:^" - "@uppy/drag-drop": "workspace:^" - "@uppy/progress-bar": "workspace:^" - "@uppy/status-bar": "workspace:^" rollup: ^2.60.2 rollup-plugin-svelte: ^7.0.0 svelte: ^3.31.0 @@ -8824,6 +8820,10 @@ __metadata: svelte-preprocess: ^4.6.1 peerDependencies: "@uppy/core": "workspace:^" + "@uppy/dashboard": "workspace:^" + "@uppy/drag-drop": "workspace:^" + "@uppy/progress-bar": "workspace:^" + "@uppy/status-bar": "workspace:^" svelte: ^3.0.0 languageName: unknown linkType: soft