open-nomad/ui/stories/components/breadcrumbs.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

46 lines
1.3 KiB
JavaScript

import hbs from 'htmlbars-inline-precompile';
export default {
title: 'Components|Breadcrumbs',
};
export let Standard = () => {
return {
template: hbs`
<h5 class="title is-5">Breadcrumbs</h5>
<div class="navbar is-secondary">
<div class="navbar-item"></div>
<nav class="breadcrumb is-large">
<li>
<a href="javascript:;">Topic</a>
</li>
<li>
<a href="javascript:;">Sub-topic</a>
</li>
<li class="is-active">
<a href="javascript:;">Active Topic</a>
</li>
</nav>
</div>
<p class="annotation">Breadcrumbs are only ever used in the secondary nav of the primary header.</p>
`,
};
};
export let Single = () => {
return {
template: hbs`
<h5 class="title is-5">Single breadcrumb</h5>
<div class="navbar is-secondary">
<div class="navbar-item"></div>
<nav class="breadcrumb is-large">
<li>
<a href="javascript:;">Topic</a>
</li>
</nav>
</div>
<p class="annotation">Breadcrumbs are given a lot of emphasis and often double as a page title. Since they are also global state, they are important for helping a user keep their bearings.</p>
`,
};
};