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
175 lines
6 KiB
JavaScript
175 lines
6 KiB
JavaScript
import hbs from 'htmlbars-inline-precompile';
|
|
|
|
export default {
|
|
title: 'Components|Gutter Menu',
|
|
};
|
|
|
|
export let Standard = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Gutter menu</h5>
|
|
<div class="columns">
|
|
<div class="column is-4">
|
|
<div class="gutter">
|
|
<aside class="menu">
|
|
<p class="menu-label">Places</p>
|
|
<ul class="menu-list">
|
|
<li><a href="javascript:;" class="is-active">Place One</a></li>
|
|
<li><a href="javascript:;">Place Two</a></li>
|
|
</ul>
|
|
|
|
<p class="menu-label">Features</p>
|
|
<ul class="menu-list">
|
|
<li><a href="javascript:;">Feature One</a></li>
|
|
<li><a href="javascript:;">Feature Two</a></li>
|
|
</ul>
|
|
</aside>
|
|
</div>
|
|
</div>
|
|
<div class="column">
|
|
<div class="mock-content">
|
|
<div class="mock-vague"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
`,
|
|
};
|
|
};
|
|
|
|
export let RichComponents = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Gutter navigation with rich components</h5>
|
|
<div class="columns">
|
|
<div class="column is-4">
|
|
<div class="gutter">
|
|
<aside class="menu">
|
|
<p class="menu-label">Places</p>
|
|
<ul class="menu-list">
|
|
<li>
|
|
<div class="menu-item">
|
|
<PowerSelect @selected={{or selection "One"}} @options={{array "One" "Two" "Three"}} @onChange={{action (mut selection)}} as |option|>
|
|
{{option}}
|
|
</PowerSelect>
|
|
</div>
|
|
</li>
|
|
<li><a href="javascript:;" class="is-active">Place One</a></li>
|
|
<li><a href="javascript:;">Place Two</a></li>
|
|
</ul>
|
|
|
|
<p class="menu-label">Features</p>
|
|
<ul class="menu-list">
|
|
<li><a href="javascript:;">Feature One</a></li>
|
|
<li><a href="javascript:;">Feature Two</a></li>
|
|
</ul>
|
|
</aside>
|
|
</div>
|
|
</div>
|
|
<div class="column">
|
|
<div class="mock-content">
|
|
<div class="mock-vague"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<p class="annotation">In order to keep the gutter navigation streamlined and easy to navigation, rich components should be avoided when possible. When not possible, they should be kept near the top.</p>
|
|
`,
|
|
};
|
|
};
|
|
|
|
export let ManyItems = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Hypothetical gutter navigation with many items</h5>
|
|
<div class="columns">
|
|
<div class="column is-4">
|
|
<div class="gutter">
|
|
<aside class="menu">
|
|
<p class="menu-label">Places</p>
|
|
<ul class="menu-list">
|
|
{{#each (array "One Two" "Three" "Four" "Five" "Six" "Seven") as |item|}}
|
|
<li><a href="javascript:;">Place {{item}}</a></li>
|
|
{{/each}}
|
|
</ul>
|
|
|
|
<p class="menu-label">Features</p>
|
|
<ul class="menu-list">
|
|
{{#each (array "One Two" "Three" "Four" "Five" "Six" "Seven") as |item|}}
|
|
<li><a href="javascript:;">Feature {{item}}</a></li>
|
|
{{/each}}
|
|
</ul>
|
|
|
|
<p class="menu-label">Other</p>
|
|
<ul class="menu-list">
|
|
<li><a href="javascript:;" class="is-active">The one that didn't fit in</a></li>
|
|
</ul>
|
|
|
|
<p class="menu-label">Things</p>
|
|
<ul class="menu-list">
|
|
{{#each (array "One Two" "Three" "Four" "Five" "Six" "Seven") as |item|}}
|
|
<li><a href="javascript:;">Thing {{item}}</a></li>
|
|
{{/each}}
|
|
</ul>
|
|
</aside>
|
|
</div>
|
|
</div>
|
|
<div class="column">
|
|
<div class="mock-content">
|
|
<div class="mock-vague"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<p class="annotation">There will only ever be one gutter menu in the Nomad UI, but it helps to imagine a situation where there are many navigation items in the gutter.</p>
|
|
`,
|
|
};
|
|
};
|
|
|
|
export let IconItems = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Hypothetical gutter navigation with icon items</h5>
|
|
<div class="columns">
|
|
<div class="column is-4">
|
|
<div class="gutter">
|
|
<aside class="menu">
|
|
<p class="menu-label">Places</p>
|
|
<ul class="menu-list">
|
|
<li><a href="javascript:;">{{x-icon "clock"}} Place One</a></li>
|
|
<li><a href="javascript:;" class="is-active">{{x-icon "history"}} Place Two</a></li>
|
|
</ul>
|
|
|
|
<p class="menu-label">Features</p>
|
|
<ul class="menu-list">
|
|
<li><a href="javascript:;">{{x-icon "warning"}} Feature One</a></li>
|
|
<li><a href="javascript:;">{{x-icon "media-pause"}} Feature Two</a></li>
|
|
</ul>
|
|
</aside>
|
|
</div>
|
|
</div>
|
|
<div class="column">
|
|
<div class="mock-content">
|
|
<div class="mock-vague"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<p class="annotation">In the future, the gutter menu may have icons.</p>
|
|
`,
|
|
};
|
|
};
|
|
|
|
export let Global = () => {
|
|
return {
|
|
template: hbs`
|
|
<h5 class="title is-5">Global gutter navigation</h5>
|
|
<div class="columns">
|
|
<div class="column is-4">
|
|
<GutterMenu>
|
|
{{!-- Page content here --}}
|
|
</GutterMenu>
|
|
</div>
|
|
</div>
|
|
<p class="annotation">Since there will only ever be one gutter menu in the UI, it makes sense to express the menu as a singleton component. This is what that singleton component looks like.</p>
|
|
<p class="annotation"><strong>Note:</strong> Normally the gutter menu is rendered within a page layout and is fixed position. The columns shown in this example are only to imitate the actual width without applying fixed positioning.</p>
|
|
`,
|
|
};
|
|
};
|