576bcf554f
I originally planned to add component documentation, but as this dragged on and I found that JSDoc-to-Markdown sometimes needed hand-tuning, I decided to skip it and focus on replicating what was already present in Freestyle. Adding documentation is a finite task that can be revisited in the future.
My goal was to migrate everything from Freestyle with as few changes as possible. Some adaptations that I found necessary:
• the DelayedArray and DelayedTruth utilities that delay component rendering until slightly after initial render because without them:
◦ charts were rendering with zero width
◦ the JSON viewer was rendering with empty content
• Storybook in Ember renders components in a routerless/controllerless context by default, so some component stories needed changes:
◦ table pagination/sorting stories access to query params, which necessitates some reaching into Ember internals to start routing and dynamically generate a Storybook route/controller to render components into
◦ some stories have a faux controller as part of their Storybook context that hosts setInterval-linked dynamic computed properties
• some jiggery-pokery with anchor tags
◦ inert href='#' had to become href='javascript:;
◦ links that are actually meant to navigate need target='_parent' so they don’t navigate inside the Storybook iframe
Maybe some of these could be addressed by fixes in ember-cli-storybook but I’m wary of digging around in there any more than I already have, as I’ve lost a lot of time to Storybook confusion and frustrations already 😞
The STORYBOOK=true environment variable tweaks some environment settings to get things working as expected in the Storybook context.
I chose to:
• use angle bracket invocation within stories rather than have to migrate them soon after having moved to Storybook
• keep Freestyle around for now for its palette and typeface components
70 lines
2.2 KiB
JavaScript
70 lines
2.2 KiB
JavaScript
/* eslint-env node */
|
|
import { addDecorator, addParameters, configure } from '@storybook/ember';
|
|
import { INITIAL_VIEWPORTS } from '@storybook/addon-viewport';
|
|
import theme from './theme.js';
|
|
|
|
addParameters({
|
|
viewport: { viewports: INITIAL_VIEWPORTS },
|
|
options: {
|
|
showPanel: true,
|
|
theme
|
|
},
|
|
});
|
|
|
|
addDecorator(storyFn => {
|
|
let { template, context } = storyFn();
|
|
|
|
let wrapperElementStyle = {
|
|
margin: '20px',
|
|
};
|
|
|
|
let applicationWrapperElement = document.createElement('div');
|
|
Object.assign(applicationWrapperElement.style, wrapperElementStyle);
|
|
|
|
let storybookElement = document.createElement('div');
|
|
storybookElement.setAttribute('id', 'storybook');
|
|
|
|
let wormhole = document.createElement('div');
|
|
wormhole.setAttribute('id', 'ember-basic-dropdown-wormhole');
|
|
|
|
storybookElement.appendChild(wormhole);
|
|
|
|
applicationWrapperElement.appendChild(storybookElement);
|
|
storybookElement.appendTo = function appendTo(el) {
|
|
el.appendChild(applicationWrapperElement);
|
|
};
|
|
|
|
/**
|
|
* Stories that require routing (table sorting/pagination) fail
|
|
* with the default iframe setup with this error:
|
|
* Path /iframe.html does not start with the provided rootURL /ui/
|
|
*
|
|
* Changing ENV.rootURL fixes that but then HistoryLocation.getURL
|
|
* fails because baseURL is undefined, which is usually set up by
|
|
* Ember CLI configuring the base element. This adds the href for
|
|
* Ember CLI to use.
|
|
*
|
|
* The default target="_parent" breaks table sorting and pagination
|
|
* by trying to navigate when clicking the query-params-changing
|
|
* elements. Removing the base target for the iframe means that
|
|
* navigation-requiring links within stories need to have the
|
|
* target themselves.
|
|
*/
|
|
let baseElement = document.querySelector('base');
|
|
baseElement.setAttribute('href', '/');
|
|
baseElement.removeAttribute('target');
|
|
|
|
return {
|
|
template,
|
|
context,
|
|
element: storybookElement,
|
|
};
|
|
});
|
|
|
|
// The order of import controls the sorting in the sidebar
|
|
configure([
|
|
require.context('../stories/theme', true, /\.stories\.js$/),
|
|
require.context('../stories/components', true, /\.stories\.js$/),
|
|
require.context('../stories/charts', true, /\.stories\.js$/),
|
|
], module);
|