Releases: flipbook-labs/flipbook
v2.0.0
Hi all, it's been a while since Flipbook has received a substantial update. We've been plugging away over the last year and now have a new version for you all.
Note
While this is a major version bump, we are aiming for as much backwards compatibility as possible. If you encounter any breakage in stories that worked on previous versions, please file a bug report
Storyteller
Storyteller is our new package for discovering, validating, loading, and rendering Storybooks and Stories. With it comes native support for Fusion stories, along with improved stability and testability of React and Roact stories.
It can also be installed through Wally allowing you to typecheck your Storybooks and Stories with the same types Flipbook uses internally, catching any issues right in your script editor. We aim to provide details on how this looks in practice to the docs site in the future.
New
- Added a Settings page providing a few options to start with
- Added an About page with details on the current installed version of the plugin (#252)
- Arrays are now a supported control type (#222)
Updates
- Overhauled the docs site, including updated installation instructions, new guides for using React, Fusion, and Roact, and stubs for future typechecking support and migration from other plugins (#276)
- Various README updates, including new badges along the top (#264, #271, #250, #216, #217)
- Improved support for React and Roact stories
- Flipbook is now a Luau repository. All Lua files have been updated to Luau (#238)
- Roblox's internal Storybooks in CoreGui will no longer pollute the output (#220)
- ModuleLoader is now hosted on the @flipbook-labs org (#214)
- Searching in the sidebar is now case-insensitive (#221)
- Fixes for search filtering (#231, #237)
Everything else
- Install React from the jsdotlua org by @vocksel in #219
- Use DataModel analysis by @vocksel in #227
- Use a project variable for most imports by @vocksel in #228
- Restructure the project into semantic folders by @vocksel in #229
- Rename RoactSpring to ReactSpring by @vocksel in #232
- Hoist wally types and fix type errors by @vocksel in #233
- Sort requires by @vocksel in #243
- Use Just as our command runner instead of shell scripts by @vocksel in #245
- Replace Moonwave site with Docusaurus by @vocksel in #244
- Use Jest for running unit tests by @vocksel in #242
- Use Darklua for string requires by @vocksel in #239
- Use Lune for script running by @vocksel in #247
- Create file watcher to rebuild on changes by @vocksel in #248
- Delete .gitattributes by @Someon1e in #255
- Update tool versions by @vocksel in #256
- Provide context to stories by @vocksel in #257
- Lints and test fix by @vocksel in #260
- Bump ModuleLoader to 0.6.2 by @vocksel in #262
- Enable Luau strict mode by @vocksel in #263
- Controls panel QOL improvements by @vocksel in #259
- Use Storyteller for handling all of our Story/Storybook needs by @vocksel in #267
- Upgrade Storyteller to 0.4.3 by @vocksel in #277
- Bump Storyteller to 0.5.0 by @vocksel in #280
New Contributors
- @ZachCurtis made their first contribution in #216
- @devSparkle made their first contribution in #222
- @hy2k made their first contribution in #231
- @Someon1e made their first contribution in #255
- @PatoFlamejanteTV made their first contribution in #271
Full Changelog: v1.5.0...v2.0.0
Contributors
Assets 2
v1.5.1
This release introduces a hotfix for a recent crash relating to StreamingService.
flipbook traverses the DataModel for storybooks and stories, and makes an effort to look through the various services in the DataModel. StreamingService being one of them. It seems recently any attempts to index StreamingService now throws an error. This patch adds a safety check to ensure flipbook has permission before performing any operations on an instance
Full Changelog: v1.5.0...v1.5.1
v1.5.0
Updates
- Added support for roblox-ts! This has been a longstanding battle happening over in the ModuleLoader codebase, and finally the kinks have been worked out and we should have support for roblox-ts #203
- flipbook now docks at the top of the viewport instead of on the left. This is an ever-so-slightly better default to make flipbook more likely to be usable on first open #195
Fixes
- When using "Preview in Viewport," the ZIndexBehavior is now set to "Sibling" (from "Global") #202
- Fixed an issue where updating a module that a component required would not reload the story
Full Changelog: v1.4.0...v1.5.0
v1.4.0
Updates
- Included a new feature request issue template
- Included a link to the devforum for users to ask questions and discuss flipbook
Fixes
- We've had a longstanding issue around stories that use scale-based sizing or AutomaticSize, which should now be fixed. Support is now included for components using Scale, Offset, and AutomaticSize, and components that resize themselves #192
- Fixed an issue where stories would be mounted before controls were set, resulting in attempts to index nil values #193
Full Changelog: v1.3.0...v1.4.0
v1.3.0
New
- Added a bug report template to make it easier for users to submit issues #183
Updates
- Added more unit tests to improve coverage #181
- Error messages are now selectable to make it easier to copy them when asking for help #188
- Took a pass over introductory content in the readme and docs site #190
Fixes
- Improved support for roblox-ts by resolving an import error #179
- "Preview in Viewport" no longer throws an error when clicking it #186
- The module cache is now cleared when reloading the plugin. Fixes issues where flipbook could get stuck in error states #187
- Fixed a bug where only one storybook would get picked up when syncing many with Rojo #189
Full Changelog: v1.2.0...v1.3.0
v1.2.0
What's Changed
- Fix example that throws an error when used by @vocksel in #165
- Use a flag for ignoring packages by @vocksel in #168
- Switch to Roact 17 internally by @vocksel in #153
- Add button to view mounted story instances by @vocksel in #169
- Only deploy docs on release by @vocksel in #170
- Attach plugin builds to action runs by @vocksel in #175
- Better error handling by @vocksel in #174
- Fix tests that are being treated as the wrong story format by @vocksel in #177
- Upgrade RoactSpring to 1.1.3 to fix usage with roblox-ts by @vocksel in #179
Full Changelog: v1.1.0...v1.2.0
Contributors
Assets 3
v1.1.0
v1.0.0
Welcome to the first release of flipbook!
You can either download it from the Roblox Marketplace or from the attached rbxm on this release.
More updates to come as we gather feedback to guide future releases and turn flipbook into the defacto storybook plugin for Roblox development.
Special thanks to @passhley for helping to make flipbook look its best
