Commit ed29dd52 authored by Ezekiel Kigbo's avatar Ezekiel Kigbo

Align nav-sidebar with design.gitlab.com docs

Updated nav-sidebar to reflect the documented
behaviour from the design.gitlab.com docs:
https://design.gitlab.com/regions/navigation#contextual-navigation

Updated rspec tests to reflect the expected behaviour
parent e4f9c3f6
...@@ -4,6 +4,10 @@ import _ from 'underscore'; ...@@ -4,6 +4,10 @@ import _ from 'underscore';
import bp from './breakpoints'; import bp from './breakpoints';
import { parseBoolean } from '~/lib/utils/common_utils'; import { parseBoolean } from '~/lib/utils/common_utils';
// NOTE: at 1200px nav sidebar should not overlap the content
// https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/24555#note_134136110
const NAV_SIDEBAR_BREAKPOINT = 1200;
export default class ContextualSidebar { export default class ContextualSidebar {
constructor() { constructor() {
this.initDomElements(); this.initDomElements();
...@@ -41,13 +45,9 @@ export default class ContextualSidebar { ...@@ -41,13 +45,9 @@ export default class ContextualSidebar {
$(window).on('resize', () => _.debounce(this.render(), 100)); $(window).on('resize', () => _.debounce(this.render(), 100));
} }
// NOTE: at 1200px nav sidebar should be in 'desktop mode' (not overlap the content)
// https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/24555#note_134136110
// But setting 'desktop mode' at 1200px will break spec/support/features/reportable_note_shared_examples.rb
// TODO: use the breakpoints from breakpoints.js once they have been updated for bootstrap 4 // TODO: use the breakpoints from breakpoints.js once they have been updated for bootstrap 4
// See related issue and discussion: https://gitlab.com/gitlab-org/gitlab-ce/issues/56745 // See documentation: https://design.gitlab.com/regions/navigation#contextual-navigation
static isDesktopBreakpoint = () => bp.windowWidth() >= 1200; static isDesktopBreakpoint = () => bp.windowWidth() >= NAV_SIDEBAR_BREAKPOINT;
static setCollapsedCookie(value) { static setCollapsedCookie(value) {
if (!ContextualSidebar.isDesktopBreakpoint()) { if (!ContextualSidebar.isDesktopBreakpoint()) {
return; return;
...@@ -60,18 +60,24 @@ export default class ContextualSidebar { ...@@ -60,18 +60,24 @@ export default class ContextualSidebar {
const dbp = ContextualSidebar.isDesktopBreakpoint(); const dbp = ContextualSidebar.isDesktopBreakpoint();
this.$sidebar.toggleClass('sidebar-expanded-mobile', !dbp ? show : false); this.$sidebar.toggleClass('sidebar-expanded-mobile', !dbp ? show : false);
this.$overlay.toggleClass('mobile-nav-open', breakpoint === 'xs' ? show : false); this.$overlay.toggleClass(
'mobile-nav-open',
breakpoint === 'xs' || breakpoint === 'sm' ? show : false,
);
this.$sidebar.removeClass('sidebar-collapsed-desktop'); this.$sidebar.removeClass('sidebar-collapsed-desktop');
} }
toggleCollapsedSidebar(collapsed, saveCookie) { toggleCollapsedSidebar(collapsed, saveCookie) {
const breakpoint = bp.getBreakpointSize(); const breakpoint = bp.getBreakpointSize();
const dbp = ContextualSidebar.isDesktopBreakpoint(breakpoint); const dbp = ContextualSidebar.isDesktopBreakpoint();
if (this.$sidebar.length) { if (this.$sidebar.length) {
this.$sidebar.toggleClass('sidebar-collapsed-desktop', collapsed); this.$sidebar.toggleClass('sidebar-collapsed-desktop', collapsed);
this.$sidebar.toggleClass('sidebar-expanded-mobile', !dbp ? !collapsed : false); this.$sidebar.toggleClass('sidebar-expanded-mobile', !dbp ? !collapsed : false);
this.$page.toggleClass('page-with-icon-sidebar', breakpoint === 'sm' ? true : collapsed); this.$page.toggleClass(
'page-with-icon-sidebar',
breakpoint === 'xs' || breakpoint === 'sm' ? true : collapsed,
);
} }
if (saveCookie) { if (saveCookie) {
......
.page-with-contextual-sidebar { .page-with-contextual-sidebar {
transition: padding-left $sidebar-transition-duration; transition: padding-left $sidebar-transition-duration;
@include media-breakpoint-up(sm) { @include media-breakpoint-up(md) {
padding-left: $contextual-sidebar-collapsed-width; padding-left: $contextual-sidebar-collapsed-width;
} }
// At 1200px nav sidebar should not overlap the content
// https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/24555#note_134136110
@include media-breakpoint-up(xl) { @include media-breakpoint-up(xl) {
padding-left: $contextual-sidebar-width; padding-left: $contextual-sidebar-width;
} }
...@@ -17,7 +15,7 @@ ...@@ -17,7 +15,7 @@
} }
.page-with-icon-sidebar { .page-with-icon-sidebar {
@include media-breakpoint-up(sm) { @include media-breakpoint-up(md) {
padding-left: $contextual-sidebar-collapsed-width; padding-left: $contextual-sidebar-collapsed-width;
} }
} }
...@@ -194,7 +192,7 @@ ...@@ -194,7 +192,7 @@
} }
} }
@include media-breakpoint-down(xs) { @include media-breakpoint-down(sm) {
left: (-$contextual-sidebar-width); left: (-$contextual-sidebar-width);
} }
...@@ -212,7 +210,7 @@ ...@@ -212,7 +210,7 @@
width: 16px; width: 16px;
} }
@media (min-width: map-get($grid-breakpoints, sm)) and (max-width: map-get($grid-breakpoints, xl) - 1px) { @media (min-width: map-get($grid-breakpoints, md)) and (max-width: map-get($grid-breakpoints, xl) - 1px) {
&:not(.sidebar-expanded-mobile) { &:not(.sidebar-expanded-mobile) {
@include collapse-contextual-sidebar; @include collapse-contextual-sidebar;
@include collapse-contextual-sidebar-content; @include collapse-contextual-sidebar-content;
...@@ -224,10 +222,6 @@ ...@@ -224,10 +222,6 @@
height: 100%; height: 100%;
width: 100%; width: 100%;
overflow: auto; overflow: auto;
@include media-breakpoint-up(sm) {
overflow: hidden;
}
} }
.with-performance-bar .nav-sidebar { .with-performance-bar .nav-sidebar {
...@@ -397,12 +391,6 @@ ...@@ -397,12 +391,6 @@
} }
} }
.toggle-sidebar-button {
@include media-breakpoint-down(xs) {
display: none;
}
}
.collapse-text { .collapse-text {
white-space: nowrap; white-space: nowrap;
overflow: hidden; overflow: hidden;
...@@ -445,16 +433,14 @@ ...@@ -445,16 +433,14 @@
color: $gl-text-color-secondary; color: $gl-text-color-secondary;
} }
@include media-breakpoint-down(xs) { @include media-breakpoint-down(sm) {
display: flex; display: flex;
align-items: center; align-items: center;
i { i {
font-size: 18px; font-size: 18px;
} }
}
@include media-breakpoint-down(xs) {
+ .breadcrumbs-links { + .breadcrumbs-links {
padding-left: $gl-padding; padding-left: $gl-padding;
border-left: 1px solid $gl-text-color-quaternary; border-left: 1px solid $gl-text-color-quaternary;
...@@ -462,13 +448,16 @@ ...@@ -462,13 +448,16 @@
} }
} }
@include media-breakpoint-down(xs) { @include media-breakpoint-down(sm) {
.close-nav-button { .close-nav-button {
display: flex; display: flex;
} }
}
.mobile-overlay { .toggle-sidebar-button {
display: none;
}
.mobile-overlay {
display: none; display: none;
&.mobile-nav-open { &.mobile-nav-open {
...@@ -479,4 +468,5 @@ ...@@ -479,4 +468,5 @@
width: 100%; width: 100%;
z-index: 300; z-index: 300;
} }
}
} }
...@@ -4,14 +4,30 @@ describe 'Projects > User sees sidebar' do ...@@ -4,14 +4,30 @@ describe 'Projects > User sees sidebar' do
let(:user) { create(:user) } let(:user) { create(:user) }
let(:project) { create(:project, :private, public_builds: false, namespace: user.namespace) } let(:project) { create(:project, :private, public_builds: false, namespace: user.namespace) }
context 'on a smaller screen', :js do # NOTE: See documented behaviour https://design.gitlab.com/regions/navigation#contextual-navigation
context 'on different viewports', :js do
include MobileHelpers include MobileHelpers
before do before do
sign_in(user) sign_in(user)
end end
shared_examples 'has a collapsible mobile nav sidebar' do shared_examples 'has a expanded nav sidebar' do
it 'has a expanded desktop nav-sidebar on load' do
expect(page).to have_content('Collapse sidebar')
expect(page).not_to have_selector('.sidebar-collapsed-desktop')
expect(page).not_to have_selector('.sidebar-expanded-mobile')
end
it 'can collapse the nav-sidebar' do
page.find('.nav-sidebar .js-toggle-sidebar').click
expect(page).to have_selector('.sidebar-collapsed-desktop')
expect(page).not_to have_content('Collapse sidebar')
expect(page).not_to have_selector('.sidebar-expanded-mobile')
end
end
shared_examples 'has a collapsed nav sidebar' do
it 'has a collapsed desktop nav-sidebar on load' do it 'has a collapsed desktop nav-sidebar on load' do
expect(page).not_to have_content('Collapse sidebar') expect(page).not_to have_content('Collapse sidebar')
expect(page).not_to have_selector('.sidebar-expanded-mobile') expect(page).not_to have_selector('.sidebar-expanded-mobile')
...@@ -24,22 +40,20 @@ describe 'Projects > User sees sidebar' do ...@@ -24,22 +40,20 @@ describe 'Projects > User sees sidebar' do
end end
end end
shared_examples 'has a desktop nav sidebar' do shared_examples 'has a mobile nav-sidebar' do
it 'has a expanded desktop nav-sidebar on load' do it 'has a hidden nav-sidebar on load' do
expect(page).to have_content('Collapse sidebar') expect(page).not_to have_content('.mobile-nav-open')
expect(page).not_to have_selector('.sidebar-collapsed-desktop')
expect(page).not_to have_selector('.sidebar-expanded-mobile') expect(page).not_to have_selector('.sidebar-expanded-mobile')
end end
it 'can collapse the nav-sidebar' do it 'can expand the nav-sidebar' do
page.find('.nav-sidebar .js-toggle-sidebar').click page.find('.toggle-mobile-nav').click
expect(page).to have_selector('.sidebar-collapsed-desktop') expect(page).to have_selector('.mobile-nav-open')
expect(page).not_to have_content('Collapse sidebar') expect(page).to have_selector('.sidebar-expanded-mobile')
expect(page).not_to have_selector('.sidebar-expanded-mobile')
end end
end end
context 'with xs size' do context 'with a extra small viewport' do
before do before do
resize_screen_xs resize_screen_xs
visit project_path(project) visit project_path(project)
...@@ -47,46 +61,48 @@ describe 'Projects > User sees sidebar' do ...@@ -47,46 +61,48 @@ describe 'Projects > User sees sidebar' do
expect(page).to have_selector('.toggle-mobile-nav') expect(page).to have_selector('.toggle-mobile-nav')
end end
it 'has a collapsed nav-sidebar on load' do it_behaves_like 'has a mobile nav-sidebar'
expect(page).not_to have_content('.mobile-nav-open')
expect(page).not_to have_selector('.sidebar-expanded-mobile')
end end
it 'can expand the nav-sidebar' do context 'with a small size viewport' do
page.find('.toggle-mobile-nav').click before do
expect(page).to have_selector('.mobile-nav-open') resize_screen_sm
expect(page).to have_selector('.sidebar-expanded-mobile') visit project_path(project)
expect(page).to have_selector('.nav-sidebar')
expect(page).to have_selector('.toggle-mobile-nav')
end end
it_behaves_like 'has a mobile nav-sidebar'
end end
context 'with sm size' do context 'with medium size viewport' do
before do before do
resize_screen_sm resize_window(768, 800)
visit project_path(project) visit project_path(project)
expect(page).to have_selector('.nav-sidebar') expect(page).to have_selector('.nav-sidebar')
end end
it_behaves_like 'has a collapsible mobile nav sidebar' it_behaves_like 'has a collapsed nav sidebar'
end end
context 'with size 1199px' do context 'with viewport size 1199px' do
before do before do
resize_window(1199, 800) resize_window(1199, 800)
visit project_path(project) visit project_path(project)
expect(page).to have_selector('.nav-sidebar') expect(page).to have_selector('.nav-sidebar')
end end
it_behaves_like 'has a collapsible mobile nav sidebar' it_behaves_like 'has a collapsed nav sidebar'
end end
context 'with a larger screen' do context 'with a extra large viewport' do
before do before do
resize_window(1200, 800) resize_window(1200, 800)
visit project_path(project) visit project_path(project)
expect(page).to have_selector('.nav-sidebar') expect(page).to have_selector('.nav-sidebar')
end end
it_behaves_like 'has a desktop nav sidebar' it_behaves_like 'has a expanded nav sidebar'
end end
end end
......
...@@ -41,7 +41,7 @@ shared_examples 'reportable note' do |type| ...@@ -41,7 +41,7 @@ shared_examples 'reportable note' do |type|
def open_dropdown(dropdown) def open_dropdown(dropdown)
# make window wide enough that tooltip doesn't trigger horizontal scrollbar # make window wide enough that tooltip doesn't trigger horizontal scrollbar
resize_window(1200, 800) restore_window_size
dropdown.find('.more-actions-toggle').click dropdown.find('.more-actions-toggle').click
dropdown.find('.dropdown-menu li', match: :first) dropdown.find('.dropdown-menu li', match: :first)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment