open-nomad/ui/stories/components/boxed-section.stories.js
Buck Doyle 576bcf554f
UI: Migrate to Storybook (#6507)
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
2020-01-21 15:46:32 -06:00

165 lines
4.4 KiB
JavaScript

import hbs from 'htmlbars-inline-precompile';
import { withKnobs, optionsKnob } from '@storybook/addon-knobs';
export default {
title: 'Components|Boxed Section',
decorators: [withKnobs],
};
export let Standard = () => {
return {
template: hbs`
<h5 class="title is-5">Boxed section</h5>
<div class="boxed-section {{variant}}">
<div class="boxed-section-head">
Boxed Section
</div>
<div class="boxed-section-body">
<div class="mock-content">
<div class="mock-image"></div>
<div class="mock-copy"></div>
<div class="mock-copy"></div>
</div>
</div>
</div>
`,
context: contextFactory(),
};
};
export let RightHandDetails = () => {
return {
template: hbs`
<h5 class="title is-5">Boxed section with right hand details</h5>
<div class="boxed-section {{variant}}">
<div class="boxed-section-head">
Boxed Section With Right Hand Details
<span class="pull-right">{{now interval=1000}}</span>
</div>
<div class="boxed-section-body">
<div class="mock-content">
<div class="mock-image"></div>
<div class="mock-copy"></div>
<div class="mock-copy"></div>
</div>
</div>
</div>
`,
context: contextFactory(),
};
};
export let TitleDecoration = () => {
return {
template: hbs`
<h5 class="title is-5">Boxed section with title decoration</h5>
<div class="boxed-section {{variant}}">
<div class="boxed-section-head">
Boxed Section With Title Decoration
<span class="badge is-white">7</span>
</div>
<div class="boxed-section-body">
<div class="mock-content">
<div class="mock-image"></div>
<div class="mock-copy"></div>
<div class="mock-copy"></div>
</div>
</div>
</div>
`,
context: contextFactory(),
};
};
export let Foot = () => {
return {
template: hbs`
<h5 class="title is-5">Boxed section with foot</h5>
<div class="boxed-section {{variant}}">
<div class="boxed-section-head">
Boxed Section With Large Header
</div>
<div class="boxed-section-body with-foot">
<div class="mock-content">
<div class="mock-image"></div>
<div class="mock-copy"></div>
<div class="mock-copy"></div>
</div>
</div>
<div class="boxed-section-foot">
<span>Left-aligned message</span>
<a href="javascript:;" class="pull-right">Toggle or other action</a>
</div>
</div>
`,
context: contextFactory(),
};
};
export let LargeHeader = () => {
return {
template: hbs`
<h5 class="title is-5">Boxed section with large header</h5>
<div class="boxed-section {{variant}}">
<div class="boxed-section-head">
<div class="boxed-section-row">
Boxed Section With Large Header
<span class="badge is-white is-subtle bumper-left">Status</span>
</div>
<div class="boxed-section-row">
<span class="tag is-outlined">A tag that goes on a second line because it's rather long</span>
</div>
</div>
<div class="boxed-section-body">
<div class="mock-content">
<div class="mock-image"></div>
<div class="mock-copy"></div>
<div class="mock-copy"></div>
</div>
</div>
</div>
`,
context: contextFactory(),
};
};
export let DarkBody = () => {
return {
template: hbs`
<h5 class="title is-5">Boxed section with dark body</h5>
<div class="boxed-section {{variant}}">
<div class="boxed-section-head">
Boxed Section With Dark Body
</div>
<div class="boxed-section-body is-dark">
<div class="mock-content">
<div class="mock-image"></div>
<div class="mock-copy"></div>
<div class="mock-copy"></div>
</div>
</div>
</div>
`,
context: contextFactory(),
};
};
function contextFactory() {
return {
variant: optionsKnob(
'Variant',
{
Normal: '',
Info: 'is-info',
Warning: 'is-warning',
Danger: 'is-danger',
},
'',
{
display: 'inline-radio',
},
'variant-id'
),
};
}