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.9 KiB
JavaScript
70 lines
2.9 KiB
JavaScript
import hbs from 'htmlbars-inline-precompile';
|
|
|
|
export default {
|
|
title: 'Components|Page Title',
|
|
};
|
|
|
|
export let Standard = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Page title</h5>
|
|
<div class="mock-spacing">
|
|
<h1 class="title">This is the Page Title</h1>
|
|
</div>
|
|
<p class="annotation">In its simplest form, a page title is just an H1.</p>
|
|
`,
|
|
};
|
|
};
|
|
|
|
export let AfterElements = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Page title with after elements</h5>
|
|
<div class="mock-spacing">
|
|
<h1 class="title">
|
|
This is the Page Title
|
|
<span class="bumper-left tag is-running">Running</span>
|
|
<span class="tag is-hollow is-small no-text-transform">237aedcb8982fe09bcee0877acedd</span>
|
|
</h1>
|
|
</div>
|
|
<p class="annotation">It is common to put high-impact tags and badges to the right of titles. These tags should only ever appear on the right-hand side of the title, and they should be listed in descending weights. Tags with a background are heavier than tags that are hollow. Longer values are heavier than shorter values.</p>
|
|
`,
|
|
};
|
|
};
|
|
|
|
export let StatusLight = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Page title with status light</h5>
|
|
<div class="mock-spacing">
|
|
<h1 class="title">
|
|
<span class="node-status-light initializing"></span>
|
|
This is the Page Title
|
|
<span class="bumper-left tag is-running">Running</span>
|
|
<span class="tag is-hollow is-small no-text-transform">237aedcb8982fe09bcee0877acedd</span>
|
|
</h1>
|
|
</div>
|
|
<p class="annotation">A simple color or pattern is faster to scan than a title and can often say more than words can. For pages that have an important status component to them (e.g., client detail page), a status light can be shown to the left of the title where typically eyes will begin to scan a page.</p>
|
|
`,
|
|
};
|
|
};
|
|
|
|
export let Actions = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Page title with actions</h5>
|
|
<div class="mock-spacing">
|
|
<h1 class="title">
|
|
<span class="node-status-light initializing"></span>
|
|
This is the Page Title
|
|
<span class="bumper-left tag is-running">Running</span>
|
|
<span class="tag is-hollow is-small no-text-transform">237aedcb8982fe09bcee0877acedd</span>
|
|
<button class="button is-warning is-small is-inline">If you wish</button>
|
|
<button class="button is-danger is-outlined is-important is-small is-inline">No Regrets</button>
|
|
</h1>
|
|
</div>
|
|
<p class="annotation">When actions apply to the entire context of a page, (e.g., job actions on the job detail page), buttons for these actions go in the page title. Buttons are always placed on the far right end of a page title. No elements can go to the right of these buttons.</p>
|
|
`,
|
|
};
|
|
};
|