cocopon commented 2 years ago

[x] Publish beta package
[x] CSS injection for plugin bundle
[x] Organize exports (Node.js v20.1.0 documentation)
[x] #209
[x] Update documents
- [x] Preset
- [x] Migration from v3 to v4
- [x] API reference
- [x] Update plugins: essentials and camerakit
[x] Re-check TODO: list
[x] Some minor refactoring
- [x] Replace TpEvent.key with TpEvent.target.key
- [x] Fix broken layout of the folder when the title is empty
[x] #431, #509
[x] #486
[x] #381
[x] #480
[x] #450
[x] #455
[x] #466
[x] #481
[x] #485
[x] #510
[x] Delete @deprecated functions

cocopon commented 1 year ago

Changelog (WIP)

For users

Migrated to ES modules (#209)
- Use <script type="module"> to use the package
Unified methods to add bindings (#486)
- Use addBinding() to add input bindings (former addInput())
- Use addBinding() with {readonly: true} to add monitor bindings (former　addMonitor())
Changed a event name for monitor bindings
- Use change event for handling monitor updates instead of update
Replaced a preset with a blade state
- Use importState() and exportState() instead of importPreset() and exportPreset()
Changed an option name for changing visual height of monitors
- lineCount -> rows
Changed a way to get a binding key in event handlers
- Use TpChangeEvent.target.key instead of TpChangeEvent.key
Renamed classes
- ListApi -> ListBindingApi
- SliderApi -> SliderBladeApi
- TextApi -> TextBladeApi
Renamed fields
- SliderApi.maxValue -> SliderBladeApi.max
- SliderApi.minValue -> SliderBladeApi.min

Improved blades specificity. (#455)
- Now you can access min and max of the slider, options of the list, etc. without any workarounds.
Importing/exporting all blades individually. (#509)
All container blades have refresh() and can be refreshed individually. (#510)
Added a shared config to point dimension params. (#417)
Added support for a custom formatter to point-nD inputs. (#511)
Added support for a custom key / pointer scale to number text inputs. (#471)

Diff of Essentials plugin (TODO) can be useful to know how to migrate your plugin to v4.

Added core field to all types of plugins for checking compatibility. Use createPlugin() to add the core version.
Added id field to plugin bundle.
Moved css field from plugin to plugin bundle.
Changed a core style file for plugins
- @import '../../node_modules/@tweakpane/core/lib/sass/plugin'; -> @use '../../node_modules/@tweakpane/core/lib/sass/tp';
Added a namespace and a prefix tp to mixins, functions, and variables
- .#{$prefix}-some -> .#{tp.$prefix}-some
- @extend %input -> @extend %tp-input

Added a way to provide a custom API for binding controllers (#455)
- InputBindingPlugin.api()
- MonitorBindingPlugin.api()
Added more stable way to access internal CSS variables
- var(--in-bg) -> tp.cssVar('input-bg')
- Refer _defs.scss to see the list of variables
Added more stable way to access CSS modifiers
- &.#{$prefix}-v-disabled -> &#{tp.$disabled}

cocopon commented 1 year ago

Migrate your package to ES modules
- Upgrade rollup.config.js
- Add .js postfix to all import statements
Add id to TpPluginBundle
Change TpPlugin.css to TpPluginBundle.css
Update rollup.config.js
- Change entries[0].replacement for @rollup/plugin-alias to ./node_modules/@tweakpane/core/dist/index.js
LabeledValueController -> LabeledValueBladeController
parseParams -> parseRecord
ParamsParser -> MicroParser
LabelController drops blade field
- Implement an own blade controller if your plugin directly uses LabelController

cocopon commented 1 year ago

Just released 4.0.0-alpha.0. Checking plugins' compatibility...

kitschpatrol commented 10 months ago

I know this is closed, but in case it's helpful to anyone else I've ported a bunch of community plugins to Tweakpane 4.

I have PRs open on all of the original repos, but if anyone needs a Tweakpane 4 compatible plugin right away, the forks are on NPM: