🚨Upcoming Plugin Changes with Svelte 5 Migration🚨

[ConorWebb96]

** This change is now in effect as of Budibase 3.24.0**

Hey everyone,

We’re excited to announce that Budibase is officially migrating to Svelte 5! 🎉 This update brings major performance improvements and cleaner reactivity, but it also includes breaking changes that affect existing plugins.

Self-hosted users

After updating your Budibase instance to the version that includes this change, you can follow the process outlined below.

We’ll update this post once the specific version number is released. Please check back for that detail on January 9, 2025
Once you’ve updated to that version, continue following the steps in the rest of this post.

Cloud users

Please follow the process in this post on or after January 9, 2025.

Once that date arrives:

• Update your plugins through the Budibase UI. If your plugin does not have an available update, it may still work.
• Do not publish until your plugins have been updated.
• Once all plugins are updated, you can publish safely.
• Test your apps before publishing.

Plugins affected

The following verified plugins currently contain <slot /> usage and will need migration:

• chungchunwang/Budibase-File-Repeater
• mp-strachan/bb-buttonplus
• mjashanks/budibase-csv-import
• sj-distributor/budibase-component-dropdown-list
• melohagan/budibase-component-inline-alert
• melohagan/budibase-component-number-counter-input
• melohagan/budibase-component-number-spinner
• poirazis/bb-component-SuperSideNavigation
• poirazis/bb-component-SuperTable
• poirazis/bb-component-SuperTabs
• poirazis/bb-component-SuperTreeView
• poirazis/bb-plugin-TabContainer
• YuanZhang98/budibase-toggle
• andz-bb/budibase-component-tooltip

Even if your plugin doesn't contain <slot />, it is still a good idea to update to Svelte 5 purely for increased performance.
Thanks for keeping your plugins up to date and for your continued contributions and support ❤️

For plugin developers

You should begin updating your plugins now to ensure they’re ready before January 9, 2025.

Specifically: @YuanZhang98, @sj-distributor, @mp-strachan, @chungchunwang

We’ve made migration simple with a new CLI command (you'll need to ensure your Budibase CLI is up to date first npm install -g @budibase/cli@latest)

budi plugins --migrate-svelte5
budi plugins --build

After running these commands, increment the version number inside your package.json file, commit the changes, and push your updates to your GitHub repository.

If you need help or encounter any issues, please don't hesitate to start a discussion. We’ll be happy to assist.

Make sure to update your Budibase client after this is released; otherwise, it will seem like the plugin is broken.

[melohagan]

I have migrated my plugins for svelte 5!