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
93 lines
3 KiB
JavaScript
93 lines
3 KiB
JavaScript
import hbs from 'htmlbars-inline-precompile';
|
|
|
|
export default {
|
|
title: 'Components|Inline Definitions',
|
|
};
|
|
|
|
export let Standard = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Inline definitions</h5>
|
|
<div class="boxed-section is-small">
|
|
<div class="boxed-section-body inline-definitions">
|
|
<span class="label">Some Label</span>
|
|
<span class="pair">
|
|
<span class="term">Term Name</span>
|
|
<span>Term Value</span>
|
|
</span>
|
|
<span class="pair">
|
|
<span class="term">Running?</span>
|
|
<span>Yes</span>
|
|
</span>
|
|
<span class="pair">
|
|
<span class="term">Last Updated</span>
|
|
<span>{{format-ts (now)}}</span>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
<p class="annotation">A way to tightly display key/value information. Typically seen at the top of pages.</p>
|
|
`,
|
|
};
|
|
};
|
|
|
|
export let Variants = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Inline definitions variants</h5>
|
|
<div class="boxed-section is-small is-success">
|
|
<div class="boxed-section-body inline-definitions">
|
|
<span class="label">Success Label</span>
|
|
<span class="pair">
|
|
<span class="term">Term Name</span>
|
|
<span>Term Value</span>
|
|
</span>
|
|
<span class="pair">
|
|
<span class="term">Last Updated</span>
|
|
<span>{{format-ts (now)}}</span>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
<div class="boxed-section is-small is-warning">
|
|
<div class="boxed-section-body inline-definitions">
|
|
<span class="label">Warning Label</span>
|
|
<span class="pair">
|
|
<span class="term">Term Name</span>
|
|
<span>Term Value</span>
|
|
</span>
|
|
<span class="pair">
|
|
<span class="term">Last Updated</span>
|
|
<span>{{format-ts (now)}}</span>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
<div class="boxed-section is-small is-danger">
|
|
<div class="boxed-section-body inline-definitions">
|
|
<span class="label">Danger Label</span>
|
|
<span class="pair">
|
|
<span class="term">Term Name</span>
|
|
<span>Term Value</span>
|
|
</span>
|
|
<span class="pair">
|
|
<span class="term">Last Updated</span>
|
|
<span>{{format-ts (now)}}</span>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
<div class="boxed-section is-small is-info">
|
|
<div class="boxed-section-body inline-definitions">
|
|
<span class="label">Info Label</span>
|
|
<span class="pair">
|
|
<span class="term">Term Name</span>
|
|
<span>Term Value</span>
|
|
</span>
|
|
<span class="pair">
|
|
<span class="term">Last Updated</span>
|
|
<span>{{format-ts (now)}}</span>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
<p class="annotation">Inline definitions are meant to pair well with emotive color variations.</p>
|
|
`,
|
|
};
|
|
};
|