luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity
open-nomad/ui/stories/components/timeline.stories.js

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

249 lines
8.3 KiB
JavaScript
Raw Normal View History

[COMPLIANCE] Add Copyright and License Headers
2023-04-10 15:36:59 +00:00
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
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 21:46:32 +00:00
import hbs from 'htmlbars-inline-precompile';
import moment from 'moment';
export default {
Migrate: New hierarchical separator
2021-10-06 20:58:01 +00:00
title: 'Components/Timeline',
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 21:46:32 +00:00
};
export let Standard = () => {
return {
template: hbs`
<h5 class="title is-5">Timeline</h5>
<ol class="timeline">
<li class="timeline-note">
{{format-date yesterday}}
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head is-light">
Object number one
</div>
</div>
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head is-light">
Object number two
</div>
</div>
</li>
<li class="timeline-note">
{{format-date today}}
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head is-light">
Object number three
</div>
</div>
</li>
</ol>
<p class="annotation">Timelines are a combination of objects and notes. Objects compose with boxed sections to create structure.</p>
<p class="annotation">Timeline notes should be used sparingly when possible. In this example there is a note per day rather than a note per object.</p>
`,
context: {
yesterday: moment().subtract(1, 'd'),
today: moment(),
},
};
};
export let Detailed = () => {
return {
template: hbs`
<h5 class="title is-5">Detailed timeline</h5>
<ol class="timeline">
<li class="timeline-note">
{{format-date today}}
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head is-light">
<span class="tag is-running">Running</span>
<span class="bumper-left pair is-faded">
<span class="term">Stable</span>
<span class="badge is-light is-faded"><code>a387e243</code></span>
</span>
<span class="bumper-left pair is-faded">
<span class="term">Submitted</span>
<span class="tooltip" aria-label="{{format-month-ts (now)}}">{{moment-from-now (now)}}</span>
</span>
</div>
</div>
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head is-light">
<span class="tag is-complete">Complete</span>
<span class="bumper-left pair is-faded">
<span class="term">Expired</span>
<span class="badge is-light is-faded"><code>b3220efb</code></span>
</span>
<span class="bumper-left pair is-faded">
<span class="term">Submitted</span>
<span>{{format-month-ts yesterday}}</span>
</span>
</div>
</div>
</li>
<li class="timeline-note">
{{format-date yesterday}}
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head is-light">
<span class="tag is-error">Failed</span>
<span class="bumper-left pair is-faded">
<span class="term">Reverted</span>
<span class="badge is-light is-faded"><code>fec9218e</code></span>
</span>
<span class="bumper-left pair is-faded">
<span class="term">Submitted</span>
<span>{{format-month-ts yesterday}}</span>
</span>
</div>
</div>
</li>
</ol>
`,
context: {
yesterday: moment().subtract(1, 'd'),
today: moment(),
},
};
};
export let Toggling = () => {
return {
template: hbs`
<h5 class="title is-5">Toggling timeline objects</h5>
<ol class="timeline">
<li class="timeline-note">
{{format-date today}}
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head is-light">
<span class="tag is-running">Running</span>
<span class="bumper-left pair is-faded">
<span class="term">Stable</span>
<span class="badge is-light is-faded"><code>a387e243</code></span>
</span>
<button
class="button is-light is-compact pull-right"
onclick={{action (mut toggle1) (not toggle1)}}>
{{if toggle1 "Close" "Open"}}
</button>
</div>
{{#if toggle1}}
<div class="boxed-section-body">
<p>Some details for the timeline object.</p>
</div>
{{/if}}
</div>
</li>
<li class="timeline-note">
{{format-date yesterday}}
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head is-light">
<span class="tag is-complete">Complete</span>
<span class="bumper-left pair is-faded">
<span class="term">Expired</span>
<span class="badge is-light is-faded"><code>b3220efb</code></span>
</span>
<button
class="button is-light is-compact pull-right"
onclick={{action (mut toggle2) (not toggle2)}}>
{{if toggle2 "Close" "Open"}}
</button>
</div>
{{#if toggle2}}
<div class="boxed-section-body">
<p>Some details for the timeline object.</p>
</div>
{{/if}}
</div>
</li>
</ol>
<p class="annotation"></p>
`,
context: {
yesterday: moment().subtract(1, 'd'),
today: moment(),
},
};
};
export let Emphasizing = () => {
return {
template: hbs`
<h5 class="title is-5">Emphasizing timeline objects</h5>
<ol class="timeline">
<li class="timeline-note">
{{format-date today}}
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head is-light">
<span class="pair is-faded">
<span class="term">Stable</span>
<span class="badge is-light is-faded"><code>a387e243</code></span>
</span>
<span class="bumper-left pair is-faded">
<span class="term">Submitted</span>
<span class="tooltip" aria-label="{{format-ts (now)}}">{{moment-from-now (now)}}</span>
</span>
</div>
</div>
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head">
Pay attention here
</div>
<div class="boxed-section-body">
<span class="pair is-faded">
<span class="term">Expired</span>
<span class="badge is-light is-faded"><code>b3220efb</code></span>
</span>
<span class="bumper-left pair is-faded">
<span class="term">Submitted</span>
<span>{{format-ts yesterday}}</span>
</span>
</div>
</div>
</li>
<li class="timeline-note">
{{format-date yesterday}}
</li>
<li class="timeline-object">
<div class="boxed-section">
<div class="boxed-section-head is-light">
<span class="pair is-faded">
<span class="term">Reverted</span>
<span class="badge is-light is-faded"><code>fec9218e</code></span>
</span>
<span class="bumper-left pair is-faded">
<span class="term">Submitted</span>
<span>{{format-ts yesterday}}</span>
</span>
</div>
</div>
</li>
</ol>
<p class="annotation">By using a full boxed-section for an emphasized timeline object, the object takes up more space and gets more visual weight. It also adheres to existing patterns.</p>
`,
context: {
yesterday: moment().subtract(1, 'd'),
today: moment(),
},
};
};
Reference in a new issue Copy permalink