Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Group versions #250

Merged
merged 4 commits into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions src/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,10 @@ html.dark-theme #modal-versions .colset .col-right {
color: var(--link-font-color);
}

#modal-versions ul li.component {
padding-bottom: 1rem;
}

#modal-versions ul li.component > a.title {
color: var(--body-font-dark-color);
}
Expand All @@ -211,6 +215,55 @@ html.dark-theme #modal-versions .colset .col-right {
list-style: circle;
}

#modal-versions .nav-versions .version-item .versions {
display: none;
padding: 0;
margin: 0;
margin-left: 45px;
}

#modal-versions .nav-versions .version-item.is-active .versions {
display: block;
}

#modal-versions .nav-versions a.title {
color: var(--body-font-dark-color);
padding-bottom: 10px;
}

#modal-versions .version-toggle {
position: relative;
border: none;
margin: 8px 0;
padding: 0;
padding-left: 30px;
width: auto;
overflow: visible;
background: transparent;
color: var(--body-font-dark-color);
}

#modal-versions .version-toggle span {
background: transparent url(../img/chevron.svg) no-repeat center / 50%;
border: none;
outline: none;
line-height: inherit;
position: absolute;
height: 30px;
width: 30px;
left: 0;
top: -4px;
transform: rotate(-90deg);
}

html.dark-theme #modal-versions .version-toggle span {
background: transparent url(../img/chevron-white.svg) no-repeat center / 50%;
}

#modal-versions .is-active .version-toggle span {
transform: rotate(0);
}

#modal-versions ul.projects {
width: 100%;
}
Expand Down
3 changes: 3 additions & 0 deletions src/helpers/notEmpty.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
'use strict'

module.exports = (a) => a !== null
27 changes: 27 additions & 0 deletions src/helpers/versionTree.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
'use strict'

module.exports = (components) => versionTree(components)

function versionTree (components) {
return components.map((comp) => {
return {
...comp,
versions: splitVersions(comp.versions),
}
})
}

function splitVersions (versions) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice if we could have a test for this logic that checks a bunch of versions are split as expected. I've no idea what tests we've got for the UI.

const snapshot = versions.filter((v) => v.version.includes('SNAPSHOT'))
const stable = versions.filter((v) => {
const split = v.version.split('-')
if (split.length === 1) return true
return false
})
const preview = versions.filter((v) => !snapshot.includes(v) && !stable.includes(v))
return {
snapshot: snapshot.length > 0 ? snapshot : null,
stable: stable.length > 0 ? stable : null,
preview: preview.length > 0 ? preview : null,
}
}
10 changes: 10 additions & 0 deletions src/js/01-nav.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@
}
})

var versionsToggle = document.querySelectorAll('.version-toggle')
if (versionsToggle) {
versionsToggle.forEach(function (el) {
var container = el.parentElement.parentElement
el.addEventListener('click', function () {
container.classList.toggle('is-active')
})
})
}

document.querySelector('#browse-version').addEventListener('click', function () {
MicroModal.show('modal-versions', {
disableScroll: true,
Expand Down
12 changes: 12 additions & 0 deletions src/partials/version-nav.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<ul class="versions">
{{#each this}}
<li class="version
{{~#if (and (eq .. @root.page.component) (eq this @root.page.componentVersion))}} is-current{{/if~}}
{{~#if (eq this ../latest)}} is-latest{{/if}}">
<a href="{{{relativize ./url}}}">
{{./displayVersion}}
{{~#if (eq this ../latest)}}<span class="current">current</span>{{/if}}
</a>
</li>
{{/each}}
</ul>
61 changes: 45 additions & 16 deletions src/partials/version.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,52 @@
</button>
<div class="colset">
<div class="col-left">

<ul class="nav-versions">
{{#each site.components}}
<li class="component{{#if (eq this @root.page.component)}} is-current{{/if}}">
<a class="title" href="{{{relativize ./url}}}">{{{./title}}}</a>
<ul class="versions">
{{#each ./versions}}
<li class="version
{{~#if (and (eq .. @root.page.component) (eq this @root.page.componentVersion))}} is-current{{/if~}}
{{~#if (eq this ../latest)}} is-latest{{/if}}">
<a href="{{{relativize ./url}}}">
{{./displayVersion}}
{{~#if (eq this ../latest)}}<span class="current">current</span>{{/if}}
</a>
</li>
{{/each}}
</ul>
</li>
{{#each (versionTree site.components)}}
<li class="component">
<div>
<a class="title" href="{{{relativize ./url}}}">{{{./title}}}</a>
</div>


{{~#if (notEmpty ./versions.stable)}}
<div class="version-item is-active">
<div>
<button class="version-toggle" type="button">
<span></span>
Stable
</button>
</div>
{{> version-nav ./versions.stable}}
</div>
{{/if}}

{{~#if (notEmpty ./versions.preview)}}
<div class="version-item">
<div>
<button class="version-toggle" type="button">
<span></span>
Preview
</button>
</div>
{{> version-nav ./versions.preview}}
</div>
{{/if}}

{{~#if (notEmpty ./versions.snapshot)}}
<div class="version-item">
oodamien marked this conversation as resolved.
Show resolved Hide resolved
<div>
<button class="version-toggle" type="button">
<span></span>
Snapshot
</button>
</div>
{{> version-nav ./versions.snapshot}}
</div>
{{/if}}

</li>
{{/each}}
</ul>
</div>
Expand Down
58 changes: 58 additions & 0 deletions test/versionTree-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/* eslint-env mocha */
'use strict'

const { expect } = require('./harness')
const versionTree = require('../src/helpers/versionTree.js')

describe('versionTree', () => {
it('should return stable, preview and snapshot versions', () => {
const result = versionTree([
{
versions: [
{
version: '3.0.1-SNAPSHOT',
},
{
version: '3.0.0-SNAPSHOT',
},
{
version: '2.0.0',
},
{
version: '1.0.0',
},
{
version: '1.0.0-RC1',
},
{
version: '1.0.0-RC2',
},
],
},
])

expect(result[0].versions.stable.length).is.eql(2)
expect(result[0].versions.stable[0].version).is.eql('2.0.0')
expect(result[0].versions.stable[1].version).is.eql('1.0.0')

expect(result[0].versions.preview.length).is.eql(2)
expect(result[0].versions.preview[0].version).is.eql('1.0.0-RC1')
expect(result[0].versions.preview[1].version).is.eql('1.0.0-RC2')

expect(result[0].versions.snapshot.length).is.eql(2)
expect(result[0].versions.snapshot[0].version).is.eql('3.0.1-SNAPSHOT')
expect(result[0].versions.snapshot[1].version).is.eql('3.0.0-SNAPSHOT')
})

it('should return an empty structure', () => {
const result = versionTree([
{
versions: [
],
},
])
expect(result[0].versions.stable).is.eql(null)
expect(result[0].versions.preview).is.eql(null)
expect(result[0].versions.snapshot).is.eql(null)
})
})
Loading