SideNav component - Porting of advanced features from HcNav
#1304
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@hashicorp/design-system-components": minor | ||
| --- | ||
|
|
||
| Extended the `Hds::SideNav` component to support responsiveness (animation/transition) and content portaling by adapting existing implementation for Cloud UI |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| <div class={{this.classNames}} ...attributes {{focus-trap isActive=this.shouldTrapFocus}}> | ||
| {{#if this.hasA11yRefocus}} | ||
| <NavigationNarrator | ||
| @routeChangeValidator={{@a11yRefocusRouteChangeValidator}} | ||
| @skipTo="#{{@a11yRefocusSkipTo}}" | ||
| @skipText={{@a11yRefocusSkipText}} | ||
| @navigationText={{@a11yRefocusNavigationText}} | ||
| /> | ||
| {{/if}} | ||
|
|
||
| {{#if this.isResponsive}} | ||
| {{! template-lint-disable no-invalid-interactive}} | ||
| <div class="hds-side-nav__overlay" {{on "click" this.toggleMinimizedStatus}} /> | ||
| {{/if}} | ||
|
|
||
| <div class="hds-side-nav__wrapper"> | ||
| {{#if this.isResponsive}} | ||
| <button | ||
| class="hds-side-nav__menu-toggle-button" | ||
| type="button" | ||
| {{on "click" this.toggleMinimizedStatus}} | ||
| {{! To be localized - see: https://hashicorp.atlassian.net/browse/HDS-567 }} | ||
| aria-label={{if this.isMinimized "Open menu" "Close menu"}} | ||
| > | ||
| <FlightIcon @name={{if this.isMinimized "menu" "x"}} @size="24" @stretched={{true}} /> | ||
| </button> | ||
| {{/if}} | ||
| <div class="hds-side-nav__wrapper-header"> | ||
| {{yield (hash isMinimized=this.isMinimized) to="header"}} | ||
| </div> | ||
| <div class="hds-side-nav__wrapper-body"> | ||
| {{yield (hash isMinimized=this.isMinimized) to="body"}} | ||
| </div> | ||
| <div class="hds-side-nav__wrapper-footer"> | ||
| {{yield (hash isMinimized=this.isMinimized) to="footer"}} | ||
| </div> | ||
| </div> | ||
| </div> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /** | ||
| * Copyright (c) HashiCorp, Inc. | ||
| * SPDX-License-Identifier: MPL-2.0 | ||
| */ | ||
|
|
||
| import Component from '@glimmer/component'; | ||
| import { action } from '@ember/object'; | ||
| import { tracked } from '@glimmer/tracking'; | ||
| import { assert } from '@ember/debug'; | ||
| import { registerDestructor } from '@ember/destroyable'; | ||
|
|
||
| export default class HdsSideNavComponent extends Component { | ||
| @tracked isResponsive = this.args.isResponsive ?? true; | ||
| @tracked isMinimized = this.isResponsive; // we set it minimized by default so that if we switch viewport from desktop to mobile its already minimized | ||
| @tracked isDesktop = true; | ||
| hasA11yRefocus = this.args.hasA11yRefocus ?? true; | ||
|
|
||
| desktopMQVal = getComputedStyle(document.documentElement).getPropertyValue( | ||
| '--hds-app-desktop-breakpoint' | ||
| ); | ||
|
|
||
| constructor() { | ||
| super(...arguments); | ||
| this.desktopMQ = window.matchMedia(`(min-width:${this.desktopMQVal})`); | ||
| this.addEventListeners(); | ||
| registerDestructor(this, () => { | ||
| this.removeEventListeners(); | ||
| }); | ||
|
|
||
| if (this.args.hasA11yRefocus) { | ||
| assert( | ||
| '@a11yRefocusSkipTo for NavigatorNarrator (a11y-refocus) in "Hds::SideNav" must have a valid value', | ||
| this.args.a11yRefocusSkipTo !== undefined | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| addEventListeners() { | ||
| document.addEventListener('keydown', this.escapePress, true); | ||
|
There was a problem hiding this comment. not sure if there's a non-convoluted way to add this listener to sidenav's outermost element instead of document There was a problem hiding this comment. @meirish I think you wrote this code (according to this commit: https://github.com/hashicorp/cloud-ui/commit/f8a3e3a9387a967654742fde2512cae816a1b79d#diff-571b3895fafd8c25954e1f6a914ed1b575c8a7211246259004b521459d5d2e4b) any ideas/suggestion? specific reasons for attaching the listener to the document ? |
||
| this.desktopMQ.addEventListener('change', this.updateDesktopVariable, true); | ||
| // set initial state based on viewport | ||
| this.updateDesktopVariable({ matches: this.desktopMQ.matches }); | ||
| } | ||
|
|
||
| removeEventListeners() { | ||
| document.removeEventListener('keydown', this.escapePress, true); | ||
| this.desktopMQ.removeEventListener( | ||
| 'change', | ||
| this.updateDesktopVariable, | ||
| true | ||
| ); | ||
| } | ||
|
|
||
| get shouldTrapFocus() { | ||
| return this.isResponsive && !this.isDesktop && !this.isMinimized; | ||
| } | ||
|
|
||
| get classNames() { | ||
| let classes = ['hds-side-nav']; | ||
|
|
||
| // add specific class names for the different possible states | ||
| if (this.isDesktop) { | ||
| classes.push('hds-side-nav--is-desktop'); | ||
| } else { | ||
| classes.push('hds-side-nav--is-mobile'); | ||
| } | ||
| if (this.isResponsive) { | ||
| classes.push('hds-side-nav--is-responsive'); | ||
| } | ||
| if (this.isMinimized) { | ||
| classes.push('hds-side-nav--is-minimized'); | ||
| } else { | ||
| classes.push('hds-side-nav--is-not-minimized'); | ||
| } | ||
|
|
||
| return classes.join(' '); | ||
| } | ||
|
|
||
| @action | ||
| escapePress(event) { | ||
| if (event.key === 'Escape' && !this.isMinimized) { | ||
| this.isMinimized = true; | ||
| } | ||
| } | ||
|
|
||
| @action | ||
| toggleMinimizedStatus() { | ||
| this.isMinimized = !this.isMinimized; | ||
|
|
||
| let { onToggleMinimizedStatus } = this.args; | ||
|
|
||
| if (typeof onToggleMinimizedStatus === 'function') { | ||
| onToggleMinimizedStatus(this.isMinimized); | ||
| } | ||
| } | ||
|
|
||
| @action | ||
| updateDesktopVariable(event) { | ||
| this.isDesktop = event.matches; | ||
|
|
||
| let { onDesktopViewportChange } = this.args; | ||
|
|
||
| if (typeof onDesktopViewportChange === 'function') { | ||
| onDesktopViewportChange(this.isDesktop); | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| <Portal @target={{if @targetName @targetName "hds-side-nav-portal-target"}}> | ||
| <div class="hds-side-nav__content-panel" ...attributes> | ||
| <Hds::SideNav::List aria-label={{@ariaLabel}} as |ListElements|> | ||
| {{yield ListElements}} | ||
| </Hds::SideNav::List> | ||
| </div> | ||
| </Portal> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <div class="hds-side-nav__content" ...attributes> | ||
| <PortalTarget | ||
| @multiple={{true}} | ||
| @onChange={{this.panelsChanged}} | ||
| @name={{if @targetName @targetName "hds-side-nav-portal-target"}} | ||
| class="hds-side-nav__content-panels hds-side-nav-hide-when-minimized" | ||
| {{did-update this.animateSubnav this.numSubnavs}} | ||
| /> | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| import Component from '@glimmer/component'; | ||
| import { inject as service } from '@ember/service'; | ||
| import { tracked } from '@glimmer/tracking'; | ||
| import { action } from '@ember/object'; | ||
| import { DEBUG } from '@glimmer/env'; | ||
| import Ember from 'ember'; | ||
|
|
||
| export default class SidenavPortalTarget extends Component { | ||
| @service router; | ||
|
|
||
| @tracked numSubnavs = 0; | ||
|
|
||
| static get prefersReducedMotionOverride() { | ||
| return Ember.testing; | ||
| } | ||
|
|
||
| prefersReducedMotionMQ = window.matchMedia( | ||
| '(prefers-reduced-motion: reduce)' | ||
| ); | ||
|
|
||
| get prefersReducedMotion() { | ||
| return ( | ||
| this.constructor.prefersReducedMotionOverride || | ||
| (this.prefersReducedMotionMQ && this.prefersReducedMotionMQ.matches) | ||
| ); | ||
| } | ||
|
|
||
| @action | ||
| panelsChanged(portalCount) { | ||
| this.numSubnavs = portalCount; | ||
| } | ||
|
|
||
| @action | ||
| animateSubnav(element, [count]) { | ||
| /* | ||
| * Here is what the layout looks like for this setup | ||
| * | ||
|
|
||
| SideNav | ||
| +----------------------+ | ||
| | +------------------+ | | ||
| | | ("header") | | | ||
| | +------------------+ | | ||
| | | | ||
| | +------------------+ | | ||
| | | ("body") | | | ||
| (PortalTarget) | | | | | ||
| +----------------------------------------------+ | | | ||
| | +----------+ +----------+ | +----------+ | | | | ||
| | | (Portal) | | (Portal) | | (Portal) | | | | | ||
| | | | | | | | | | | | | ||
| | | hidden | | hidden | | *active* | | | | | ||
| | | panel | | panel | | | panel | | | | | ||
| | | | | | | | | | | | ||
| | | | | | | | | | | | | ||
| | | | | | | | | | | | ||
| | | | | | | | | | | | | ||
| | | | | | | | | | | | ||
| | | | | | | | | | | | | ||
| | | | | | | | | | | | ||
| | +----------+ +----------+ | +----------+ | | | | ||
| +----------------------------------------------+ | | | ||
| | | | | | ||
| | +------------------+ | | ||
| | | | ||
| | +------------------+ | | ||
| | | ("footer") | | | ||
| | +------------------+ | | ||
| +----------------------+ | ||
|
|
||
| * | ||
| * every time `HcAppFrame::SideNav::Portal` renders, it contains a portaled "panel" | ||
| * that is rendered into the `hds-side-nav__content-panels` (inside the PortalTarget). | ||
| * | ||
| * Rendering or unrendering other `HcAppFrame::SideNav::Portal`s triggers the number of | ||
| * subnavs to change (via `numSubnavs`), so this function runs and slides | ||
| * `hds-side-nav__content-panels` left or right using the `element.animate` api. | ||
| * | ||
| * */ | ||
|
|
||
| let activeIndex = count - 1; | ||
| let targetElement = element; | ||
| let { prefersReducedMotion } = this; | ||
|
|
||
| let styles = getComputedStyle(targetElement); | ||
| let columnWidth = styles.getPropertyValue( | ||
| '--hds-app-sidenav-width-expanded' | ||
| ); | ||
| let slideDuration = prefersReducedMotion ? 0 : 150; | ||
| let fadeDuration = prefersReducedMotion ? 0 : 175; | ||
| let fadeDelay = prefersReducedMotion ? 0 : 50; | ||
|
|
||
| // slide entire parent panel | ||
| let start = styles.transform; | ||
| let end = `translateX(-${activeIndex * parseInt(columnWidth, 10)}px)`; | ||
| let anim = targetElement.animate( | ||
| [{ transform: start }, { transform: end }], | ||
| { | ||
| duration: slideDuration, | ||
| easing: 'cubic-bezier(0.65, 0, 0.35, 1)', | ||
| fill: 'forwards', | ||
| } | ||
| ); | ||
| // Notice: we don't add the styles by default because it writes a `style` attribute to the element and it causes an additional re-render | ||
| if (DEBUG) { | ||
| anim.commitStyles(); | ||
| } | ||
didoo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| anim.finished.then(() => { | ||
| // uncomment this if we need/want to scroll the element to the top | ||
| // targetElement.scrollIntoView(true); | ||
| if (activeIndex > 0) { | ||
| let allPrev = Array.from(targetElement.children).slice(0, activeIndex); | ||
| for (let ele of allPrev) { | ||
| ele.ariaHidden = 'true'; | ||
| ele.style.setProperty('visibility', 'hidden'); | ||
| ele.style.setProperty('opacity', '0'); | ||
| } | ||
| } | ||
| // Notice: we don't add the styles by default because it writes a `style` attribute to the element and it causes an additional re-render | ||
| if (DEBUG) { | ||
| anim.commitStyles(); | ||
| } | ||
| }); | ||
|
|
||
| // fade in next panel | ||
| let nextPanelEl = targetElement.children[activeIndex]; | ||
| if (nextPanelEl) { | ||
| nextPanelEl.ariaHidden = 'false'; | ||
| nextPanelEl.style.setProperty('visibility', 'visible'); | ||
| // this eliminates a flicker if there's only 1 subnav rendering | ||
| if (activeIndex === 0) { | ||
| fadeDelay = 0; | ||
| fadeDuration = 0; | ||
| } | ||
| nextPanelEl.animate([{ opacity: '0' }, { opacity: '1' }], { | ||
| delay: fadeDelay, | ||
| duration: fadeDuration, | ||
| fill: 'forwards', | ||
| }); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just curious why this needs to be a
divvs. abutton?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no strong reasons, apart from: