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

Sidebar Redesign #1046

Merged
merged 3 commits into from
Mar 29, 2017
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
11 changes: 4 additions & 7 deletions components/page/page-style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,19 @@

// XXX: Temporary hack to fix sidebar width
.page > div:first-of-type {
flex: 0 0 auto;
display: none;
position: relative;
overflow: hidden;

@include break {
flex:0 0 30%;
}

@include break('large') {
flex:0 0 25%;
display: block;
flex: 0 0 280px;
}
}

.page__content {
flex: 1 1 auto;
overflow-x: hidden;
width: 100%;
padding: 1.5em 1em;

@media break {
Expand Down
101 changes: 51 additions & 50 deletions components/sidebar-item/sidebar-item-style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -3,81 +3,82 @@

.sidebar-item {
position: relative;
font-size: getFontSize(-1);
margin-bottom: 0.75em;

&__title {
padding-right: 15px;
font-weight: 400;
text-decoration: none;
color: inherit;

&:hover {
color: $text-color-highlight;
}
}
display: flex;
flex-wrap: wrap;
font-size: 15px;
margin: 0.6em 0;

&__toggle {
position: absolute;
right: 0;
line-height: 1.5;
flex: 0 0 auto;
margin-top: 0.125em;
margin-right: 0.5em;
cursor: pointer;
color: getColor(dusty-grey);
transition: color 250ms;
margin-left: 1.5rem;
color: getColor(denim);
transition: all 250ms;

&:hover {
color: getColor(mine-shaft);
}
}

&__title {
flex: 1 1 auto;
font-weight: 600;
color: getColor(dove-grey);
}

&__anchors {
display:none;
position: relative;
display: none;
flex: 0 0 100%;
flex-wrap: wrap;
margin: 0.35em 0;
padding-left: 1.5em;
overflow: hidden;
list-style: none;
padding: 0;
margin: 0.5em 0 1em;
}

&__version {
margin-bottom: 10px;
&:before {
content: '';
position: absolute;
height: calc(100% - 0.6em);
top: 0;
left: 1.5em;
border-left: 1px dashed getColor(dusty-grey);
}
}

&__anchor {
margin:0.25em 0;
position: relative;
flex: 0 0 100%;
margin: 0.25em 0;
padding-left: 1em;
@include control-overflow;

a {
display: inline-block;
max-width: 100%;
overflow: hidden;
white-space: nowrap;
text-overflow: ellipsis;
color: getColor(dusty-grey);
&:first-child { margin-top: 0; }
&:last-child { margin-bottom: 0; }
&:before {
content: '';
position: absolute;
width: 0.5em;
left: 0;
top: 60%;
border-bottom: 1px dashed getColor(dusty-grey);
}

&:hover {
color: getColor(mine-shaft);
}
a {
color: getColor(emperor);
&:hover { color: getColor(denim); }
}
}

&--open {
.sidebar-item__anchors {
display:block;
}

.sidebar-item__title {
color: $text-color-highlight;
display: flex;
}

.sidebar-item__toggle {
margin-left:-2px;
transform:rotate(180deg) translateX(1px);
}
}

&--empty {
.sidebar-item__toggle,
.sidebar-item__anchors {
display: none;
transform-origin: center center;
transform: rotate(90deg);
}
}
}
88 changes: 64 additions & 24 deletions components/sidebar-item/sidebar-item.jsx
Original file line number Diff line number Diff line change
@@ -1,51 +1,77 @@
import React from 'react';
import Link from '../link/link';

const block = 'sidebar-item';

export default class SidebarItem extends React.Component {
constructor(props) {
super(props);

this.state = {
open: this.isOpen(props)
open: this._isOpen(props)
};
}

render() {
let { index, url, title, anchors = [], currentPage } = this.props;

let emptyMod = !anchors.length ? 'sidebar-item--empty' : '';
let openMod = (this.state.open) ? 'sidebar-item--open' : '';
let anchorUrl = url + '#';
let isCurrentPage = `/${currentPage}` === url;
let { title, anchors = [] } = this.props;
let openMod = this.state.open ? `${block}--open` : '';

return (
<div className={ `sidebar-item ${emptyMod} ${openMod}` }>
<Link className="sidebar-item__title" to={ url }>{ title }</Link>
<i className="sidebar-item__toggle icon-chevron-down" onClick={ this.toggle.bind(this) } />
<ul className="sidebar-item__anchors">
{
anchors.map((anchor, j) => (
<li className="sidebar-item__anchor" key={ `anchor-${index}-${j}` }>
<a href={ isCurrentPage ? `#${anchor.id}` : anchorUrl + anchor.id }>{ anchor.title}</a>
</li>
))
}
</ul>
<div className={ `${block} ${openMod}` }>
{ anchors.length > 0 ? (
<i
className={ `${block}__toggle icon-chevron-right` }
onClick={ this._toggle.bind(this) } />
) : null }

<Link
className={ `${block}__title` }
to={ this.props.url }>
{ title }
</Link>

{ anchors.length > 0 ? (
<ul className={ `${block}__anchors` }>
{
anchors.map(anchor => (
<li
className={ `${block}__anchor` }
key={ `anchor-${title}-${anchor.id}` }>
<a href={ this._generateAnchorURL(anchor) }>
{ anchor.title }
</a>
</li>
))
}
</ul>
) : null }
</div>
);
}

componentWillReceiveProps(nextProps) {
if (nextProps.currentPage == this.props.currentPage) return;

this.setState({ open: this.isOpen(nextProps) });
if ( nextProps.currentPage !== this.props.currentPage ) {
this.setState({
open: this._isOpen(nextProps)
});
}
}

isOpen(props) {
/**
* Checks whether the item should be expanded
*
* @param {object} props - The current props
*/
_isOpen(props) {
return `/${props.currentPage}` === props.url;
}

toggle(e) {
/**
* Toggles the open state (expanded/collapsed)
*
* @param {object} e - Click event
*/
_toggle(e) {
let { onToggle } = this.props;

this.setState({
Expand All @@ -56,4 +82,18 @@ export default class SidebarItem extends React.Component {
}
});
}

/**
* Generate the url for the given [anchor] depending on the current page
*
* @return {object} anchor - The anchor object containing its id
*/
_generateAnchorURL(anchor) {
let { currentPage, url } = this.props;

if ( `/${currentPage}` === url ) {
return `#${anchor.id}`;

} else return `${url}#${anchor.id}`;
}
}
5 changes: 2 additions & 3 deletions components/sidebar/sidebar.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,12 @@ export default class Sidebar extends Component {
height={ availableHeight } />

<div className="sidebar__inner">
<h3 className="sidebar-item__version">Version 2.2</h3>
<img src="https://img.shields.io/badge/webpack-v2.2.1-blue.svg" />

<SidebarItem
url={ `/${sectionName}` }
title="Introduction"
currentPage= { currentPage }
/>
currentPage= { currentPage } />

{
pages.map(({ url, title, anchors }, i) =>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Configuration with Javascript Alternatives
sort: 3
title: Configuration Languages
sort: 2
contributors:
- sokra
- skipjack
Expand Down
2 changes: 1 addition & 1 deletion content/configuration/configuration-types.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Configuration Types
sort: 2
sort: 3
contributors:
- sokra
- skipjack
Expand Down
6 changes: 6 additions & 0 deletions styles/partials/_mixins.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
}
}

@mixin control-overflow {
overflow: hidden;
white-space: nowrap;
text-overflow: ellipsis;
}

@mixin fontantialias ($on) {
@if $on == true {
-webkit-font-smoothing: antialiased;
Expand Down