storybook: The view is not re-rendered on toolbar change
Describe the bug I have created a new toolbar button following the steps in the documentation, the button is for localization change, the problem is that the story won’t re-render on globals change.
Expected behavior I expect the page reloads as language is changed as it is in your official storybook
I am using @ngx-translate/core for managing the translations.
export const globalTypes = {
locale: {
name: 'Locale',
description: 'Internationalization locale',
defaultValue: 'en',
toolbar: {
icon: 'globe',
items: [
{ value: 'en', right: 'en', title: 'English' },
{ value: 'he', right: 'he', title: 'Hebrew' },
],
},
},
};
const withLocaleProvider = (storyFunc, { globals: { locale } }) => {
const story = storyFunc();
story.moduleMetadata.imports.push(
TranslateModule.forRoot({
defaultLanguage: locale,
useDefaultLang: true,
loader: {
provide: TranslateLoader,
useFactory: HttpLoaderFactory,
deps: [HttpClient],
},
})
);
return story;
}
export const decorators = [
withLocaleProvider,
];
System
System:
OS: Windows 10 10.0.19041
CPU: (8) x64 Intel(R) Core(TM) i5-8265U CPU @ 1.60GHz
Binaries:
Node: 12.18.3 - C:\Program Files\nodejs\node.EXE
npm: 6.14.6 - C:\Program Files\nodejs\npm.CMD
Browsers:
Chrome: 87.0.4280.141
Edge: Spartan (44.19041.423.0), Chromium (88.0.705.56)
npmPackages:
@storybook/addon-actions: ^6.1.15 => 6.1.15
@storybook/addon-essentials: ^6.1.15 => 6.1.15
@storybook/addon-links: ^6.1.15 => 6.1.15
@storybook/angular: ^6.1.15 => 6.1.15
About this issue
- Original URL
- State: closed
- Created 6 years ago
- Reactions: 1
- Comments: 17 (3 by maintainers)
The issue is still present, at least with Vue. The Vue component defined in the
decoratorsarray doesn’t receive the updatedglobalsvalue until a re-render happens some other way like when switching to a different story or the Docs tab.I noticed the same thing with vue. In the docs tab auto-reload works though.
I moved to using
useChannel()to emit the updated value of the toolbar component instead, since the toolbar controls are rendered with React: https://storybook.js.org/docs/react/addons/addons-api#usechannelAnd then I’ve created a Vue decorator that listens for this event and re-renders the story accordingly:
@wes0310 For React you should be able to follow the pattern used by WordPress/Gutenberg here: https://github.com/WordPress/gutenberg/pull/35711/files#diff-493c10b62f2ed6d7c2a9945a55b58043b0f042c6b840f78c2193f8a01b2af613R15
Basically
useEffectto watch the global variable, manipulate whatever context you need to, then callforceReRender(). (forceReRenderdoes nothing for Vue but appears to work fine for React)I saw that. I was actually able to get it working using a
Vue.observableand awatchinsetup:https://github.com/WordPress/openverse-frontend/pull/346/files#diff-8371d29d475d4942ba34da809defa80e7b18f01a65da98f700b7e103980f95eeR8
Thanks for the details though!
+1 Issue still in Vue latest version of Storybook 6.3.8. Solution for now is to include deprecated
addon-contextspackage for this functionality. Not the most ideal.Same here, the “Docs” tab re-renders the component upon modifying the “globals” but the “Canvas” tab doesn’t react to it.