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.

Sign up for GitHub

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

Jump to bottom

docs: assume tree-shaking bundler is the most common case #5160

Merged
merged 5 commits into from
May 23, 2024
Merged

docs: assume tree-shaking bundler is the most common case #5160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ddd2935
docs: remove notes about not bundling Preact
aduh95 May 14, 2024
21c9e34
Merge branch '4.x' of https://github.com/transloadit/uppy
aduh95 May 22, 2024
a96ff52
restore migration guide, keep note in Uppy core docs
aduh95 May 22, 2024
07b4d62
Update docs/uppy-core.mdx
aduh95 May 22, 2024
8f56341
lint
aduh95 May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/building-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The plugin constructor receives the Uppy instance in the first parameter, and
any options passed to `uppy.use()` in the second parameter.

```js
import BasePlugin from '@uppy/core/lib/BasePlugin.js';
import BasePlugin from '@uppy/core';

export default class MyPlugin extends BasePlugin {
constructor(uppy, opts) {
Expand Down
7 changes: 4 additions & 3 deletions docs/uppy-core.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1374,9 +1374,10 @@ Checkout the [building plugins](/docs/guides/building-plugins) guide.

:::note

If you don’t use any UI plugins and want to make sure Preact isn’t bundled into
your app, import `BasePlugin` like this:
`import BasePlugin from '@uppy/core/lib/BasePlugin`.
If you don’t use any UI plugins, any modern bundler should be able to tree-shake
Preact code away. If you are not using a bundler that supports tree-shaking,
it’s also possible to import `BasePlugin` like this:
`import BasePlugin from '@uppy/core/lib/BasePlugin.js`.

:::

Expand Down