Storefront Toolkit Changelog
@appdirect/sfb-toolkit
Storefront Toolkit CLI to power up building your custom theme for AppDirect's Marketplace.
Theming a template leverages Nunjucks Template System to keep Server Side Rendering. It can be easily mixed with eg. HTML, CSS, JavaScript, jQuery, SASS.
Requirements
- Node 10.x or 12.x for versions 1.x.x to 3.0.6
- Node 16.x or 18.x for versions 4.x.x
Release Notes:
4.0.25
- Removed
Classic
option when creating theme - Updated
sfb-theme-components
library to version 0.0.352 [DEPRECATED]
sfb-toolkit storybook
command[BETA]
addedsfb-toolkit import
command[BETA]
addedsfb-toolkit components-add
command[BETA]
addedsfb-toolkit components-copy
command[BETA]
addedsfb-toolkit components-delete
command
4.0.20
- Updated internal packages
4.0.19
- Updated internal packages
4.0.18
- Updated documentation links
4.0.17
- Bug fix: fixed issue when executing
sfb-toolkit start
on Windows - Updated
sfb-theme-components
library to version 0.0.342
4.0.14
- Bug fix: fixed error message showing when executing
sfb-toolkit setup
4.0.13
- Added new command
sfb-toolkit components-info
- shows which custom components could override our internal UI library (
sfb-theme-components
)
- shows which custom components could override our internal UI library (
- Updated warning prompt for
sfb-toolkit install @appdirect/sfb-theme-components
- includes the current version of
sfb-theme-components
used - indicates which custom components should potentially be tested when updating the
sfb-theme-components
version
- includes the current version of
4.0.12
- Bug fix: fixed proxy issue
4.0.11
- Added warning prompt to
sfb-toolkit components
command - Added warning prompt to
sfb-toolkit install @appdirect/sfb-theme-components
command - Bug fix: fixed node_modules issue
4.0.10
- Add Node 18 support
- Add prompts when enabling custom components and updating sfb-theme-component version
- Update
@appdirect/sfb-theme-plaza
to version 0.0.76 (sfb-theme-mp2@0.0.75)- Add default translations for all supported languages
- Update
sfb-theme-components
library to version 0.0.340- Add Node 18 support
- Update
storefront-utils
library to version 0.0.125
4.0.8
- Update
@appdirect/sfb-theme-plaza
to version 0.0.64 (sfb-theme-mp2@0.0.75) - Update
@appdirect/sfb-theme-classic
to version 0.0.27 (sfb-theme-classic@0.0.27) - Update
sfb-theme-components
library to version 0.0.338
4.0.4
- Update
@appdirect/sfb-theme-plaza
to version 0.0.64 (sfb-theme-mp2@0.0.64) - Update
sfb-theme-components
library to version 0.0.321
4.0.2
sfb-components
bundles are split by storefront page to improve LCP performance.- Bug fix: Fix custom components with sfb-toolkit@4 on Windows.
- Bug fix: Fix favicon not showing in the Plaza theme.
- Update
@appdirect/sfb-theme-plaza
to version 0.0.59 (sfb-theme-mp2@0.0.59) - Update
sfb-theme-components
library to version 0.0.315
4.0.1
- Toolkit is now able to work on Node 16.
- Remove deprecated
node-sass
to compile SASS files in favour ofsass
aka Dart Sass. - Update
sfb-theme-components
library to version 0.0.293 - Update
@appdirect/sfb-theme-plaza
to version 0.0.57 (sfb-theme-mp2@0.0.57) - Update
@appdirect/sfb-theme-classic
to version 0.0.26 (sfb-theme-classic@0.0.26)
3.0.6
- Update
sfb-theme-components
library to version 0.0.282 - Update
@appdirect/sfb-theme-plaza
to version 0.0.55 (sfb-theme-mp2@0.0.55) - Update
@appdirect/sfb-theme-classic
to version 0.0.24 (sfb-theme-classic@0.0.24)
3.0.5
- Update
sfb-theme-components
library to version 0.0.272 - Update
@appdirect/sfb-theme-plaza
to version 0.0.53 (sfb-theme-mp2@0.0.53)
3.0.4
- Update
sfb-theme-components
library to version 0.0.262- Update custom components section in the Storybook documentation
- Update
@appdirect/sfb-theme-plaza
to version 0.0.50 (sfb-theme-mp2@0.0.47)
3.0.3
- Bug fix: Fix
PRODUCTS_LIST
schema type not working on a custom page - Update
sfb-toolkit package
command to minifysfb-components.js
bundle - Update
sfb-theme-components
library to version 0.0.245- Update custom components section in the Storybook documentation
- Update
@appdirect/sfb-theme-plaza
to version 0.0.47 (sfb-theme-mp2@0.0.47)- Add product variants template
- Add
enableProductVariant
theme setting
3.0.0
- Add new storefront Header & Footer components
- Add new menu manager in the Visual Editor
- Update
sfb-theme-components
library to version 0.0.237 and the Plaza theme to meet WCAG 2.1 level AA for accessibility - Update
@appdirect/sfb-theme-plaza
to version 0.0.45 (sfb-theme-mp2@0.0.45)
2.0.15
- Add new domain cross-selling page in Plaza theme. (See Documentation)
- Read
crossSellingEnabled
setting from theme to optionally disable cross-selling - Update
@appdirect/sfb-theme-plaza
to version 0.0.44 (sfb-theme-mp2@0.0.44)
2.0.14
- Fix npm security vulnerabilities when running
sfb-toolkit storybook
andsfb-toolkit components
commands
2.0.13
- Customize CTA labels and
i18n
object in the theme (See Documentation)
2.0.10
- Bug fix:
sfb-toolkit storybook
command throws an error
2.0.9
- Update storefront-utils library
2.0.8
- Improve the toolbar header view:
- to preview the header as a regular user or a marketplace manager without a user token
- to preview the header in the admin portal
- The theme header-footer section can use assets (images, fonts) in the theme assets folder
2.0.7
- Bug fix: Default props should be passed properly to custom components
- Bug fix: Custom components do not work in Classic theme
- Bug fix: Removing a null file when
customComponents
folder is created
2.0.6
- Updating Classic and Plaza theme
2.0.5
- Add new toolkit commands:
storybook
andcomponents
to build new custom components in your Plaza theme - Update
setup
andcreate
commands to choose between aClassic
or aPlaza
theme
2.0.4
- Update Classic theme, small fix in leads form
- Update Plaza theme with product domains and bundles page
2.0.3
- Add pricing content to add to cart mock
- Add Support for Storefront Builder Components rendering
- Bug fix: Fix Microsoft subscription upgraded rendering
2.0.2
- Added Support for both SASS and SCSS styling file compilation
- Bug fix: Hanging prompt on setup command on Windows
2.0.1
- Documentation links updated
- Bug fix: Footer custom JS script parsing
2.0.0
- Classic Theme with new Checkout and Cart integration is now available (See Documentation)
- Added Product Configuration page
- Added Cart Preview
- Added window function to add to cart
AD_addToCart()
- Standalone Domains now supports new Checkout
- Bug fix: Windows CRLF now supported
1.1.0
- Dynamic SASS compilation to work with Node 12
1.1.0
- Toolkit is now ready and able to work on Node 12
1.0.0
- Initial release
How to use
The idea behind Toolkit CLI is similar to how git
CLI has been made.
Developers can have multiple themes in a single environment.
Command | Description |
---|---|
sfb-toolkit setup | Creates a new project/environment where Developer can store themes |
sfb-toolkit create [name] | Creates a new theme |
sfb-toolkit checkout [name] | Changes context to the theme [name] |
sfb-toolkit about | Lists existing themes |
sfb-toolkit status | Gives information about current configuration |
sfb-toolkit update | Update current theme's configuration |
sfb-toolkit start | Starts local server with current theme on https://localhost:3555/en-US/home |
sfb-toolkit package | Creates a .zip file with current theme files |
sfb-toolkit storybook | Start storybook for the currently selected theme |
sfb-toolkit install [module] | Installs npm module in the currently selected theme |
sfb-toolkit components | Setup custom components |
sfb-toolkit version | Shows version of sfb-toolkit |
Other Resources
- Official Documentation
- Checkout Integration
- Video Tutorials
- Nunjucks Template System Documentation
- Contact Support
This Repository is owned and maintained by Storefront Builder Team @ AppDirect Inc.
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!