Skip to content

A fork of tweakpane-plugin-rotation with build optimizations.

License

Notifications You must be signed in to change notification settings

kitschpatrol/tweakpane-plugin-rotation

 
 

Repository files navigation

@kitschpatrol/tweakpane-plugin-rotation

NPM Package @kitschpatrol/tweakpane-plugin-rotation

Overview

This is a fork of 0b5vr's tweakpane-plugin-rotation with externalized dependencies.

This allows for smaller bundled file sizes in projects using multiple Tweakpane plugins.

It is published to NPM primarily for the Svelte Tweakpane UI project, and will be kept in sync with the upstream version of the plugin, with minimal changes other than dependency externalization.

For most use cases, you probably don't want this fork!

Background

The Rollup configuration provided in the Tweakpane plugin template does not externalize @tweakpane/core as a production dependency.

Instead, it gets built into the single-file plugin artifact, which is what's published to NPM and imported by plugin consumers. This makes it easy to import as an ES module from a URL, but means that larger projects importing multiple Tweakpane plugins end up with duplicate copies of the @tweakpane/core code, adding about ~100 Kb to the final minified build for each plugin after the first.

Externalizing this dependency allows build tools like vite to share a single instance of the @tweakpane/core code across multiple plugins.

If you're not using a bundler, direct ESM imports from URLs can still work if needed by defining the @tweakpane/core dependency in an importmap.

Implementation notes

This fork uses the main branch for the releases instead of dev.

Note the package's name change from @0b5vr/tweakpane-plugin-rotation to @kitschpatrol/tweakpane-plugin-rotation.

PNPM is used as the package manager.

About

A fork of tweakpane-plugin-rotation with build optimizations.

Topics

Resources

License

Stars

Watchers

Forks

Languages

  • TypeScript 81.0%
  • JavaScript 7.6%
  • HTML 7.0%
  • SCSS 4.4%