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

feature(storefront): BCTHEME-156 Selected state on search page not announced #1788

Merged
merged 2 commits into from
Aug 26, 2020
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Changelog

## Draft
Selected state on search page not announced. [#1788](https://github.com/bigcommerce/cornerstone/pull/1788)
- Added additional focusable element for rating announcing. [#1769](https://github.com/bigcommerce/cornerstone/pull/1769)
- Error messages from Write a Review should be announced. [#1777](https://github.com/bigcommerce/cornerstone/pull/1777)
- Fixed issue with missing logo on mobile and tablet. [#1767](https://github.com/bigcommerce/cornerstone/pull/1767)
Expand Down
67 changes: 61 additions & 6 deletions assets/js/theme/search.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ import collapsibleFactory from './common/collapsible';
import 'jstree';
import nod from './common/nod';

const leftArrowKey = 37;
const rightArrowKey = 39;
BC-tymurbiedukhin marked this conversation as resolved.
Show resolved Hide resolved

export default class Search extends CatalogPage {
formatCategoryTreeForJSTree(node) {
const nodeData = {
Expand All @@ -34,16 +37,18 @@ export default class Search extends CatalogPage {
}

showProducts(navigate = true) {
this.$productListingContainer.removeClass('u-hiddenVisually');
this.$facetedSearchContainer.removeClass('u-hiddenVisually');
this.$contentResultsContainer.addClass('u-hiddenVisually');
this.$productListingContainer.removeClass('u-hidden');
this.$facetedSearchContainer.removeClass('u-hidden');
this.$contentResultsContainer.addClass('u-hidden');

$('[data-content-results-toggle]').removeClass('navBar-action-color--active');
$('[data-content-results-toggle]').addClass('navBar-action');

$('[data-product-results-toggle]').removeClass('navBar-action');
$('[data-product-results-toggle]').addClass('navBar-action-color--active');

this.activateTab($('[data-product-results-toggle]'));

if (!navigate) {
return;
}
Expand All @@ -57,16 +62,18 @@ export default class Search extends CatalogPage {
}

showContent(navigate = true) {
this.$contentResultsContainer.removeClass('u-hiddenVisually');
this.$productListingContainer.addClass('u-hiddenVisually');
this.$facetedSearchContainer.addClass('u-hiddenVisually');
this.$contentResultsContainer.removeClass('u-hidden');
this.$productListingContainer.addClass('u-hidden');
this.$facetedSearchContainer.addClass('u-hidden');

$('[data-product-results-toggle]').removeClass('navBar-action-color--active');
$('[data-product-results-toggle]').addClass('navBar-action');

$('[data-content-results-toggle]').removeClass('navBar-action');
$('[data-content-results-toggle]').addClass('navBar-action-color--active');

this.activateTab($('[data-content-results-toggle]'));

if (!navigate) {
return;
}
Expand All @@ -79,6 +86,52 @@ export default class Search extends CatalogPage {
urlUtils.goToUrl(url);
}

activateTab($tabToActivate) {
const $tabsCollection = $('[data-search-page-tabs]').find('[role="tab"]');

$tabsCollection.each((idx, tab) => {
const $tab = $(tab);

if ($tab.is($tabToActivate)) {
$tab.removeAttr('tabindex');
$tab.attr('aria-selected', true);
return;
}

$tab.attr('tabindex', '-1');
$tab.attr('aria-selected', false);
});
}

onTabChangeWithArrows(event) {
const eventKey = event.which;
const isLeftOrRightArrowKeydown = eventKey === leftArrowKey
|| eventKey === rightArrowKey;
if (!isLeftOrRightArrowKeydown) return;

const $tabsCollection = $('[data-search-page-tabs]').find('[role="tab"]');

const isActiveElementNotTab = $tabsCollection.index($(document.activeElement)) === -1;
if (isActiveElementNotTab) return;

const $activeTab = $(`#${document.activeElement.id}`);
const activeTabIdx = $tabsCollection.index($activeTab);
const lastTabIdx = $tabsCollection.length - 1;

let nextTabIdx;
switch (eventKey) {
case leftArrowKey:
nextTabIdx = activeTabIdx === 0 ? lastTabIdx : activeTabIdx - 1;
break;
case rightArrowKey:
nextTabIdx = activeTabIdx === lastTabIdx ? 0 : activeTabIdx + 1;
break;
default: break;
}

$($tabsCollection.get(nextTabIdx)).focus().trigger('click');
}

onReady() {
compareProducts(this.context.urls);

Expand Down Expand Up @@ -111,6 +164,8 @@ export default class Search extends CatalogPage {
this.showContent();
});

$('[data-search-page-tabs]').on('keyup', this.onTabChangeWithArrows);

if (this.$productListingContainer.find('li.product').length === 0 || url.query.section === 'content') {
this.showContent(false);
} else {
Expand Down
8 changes: 8 additions & 0 deletions assets/scss/components/stencil/search/_search.scss
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,11 @@
margin: spacing("single") 0 0;
text-align: center;
}

.search-nav {
position: relative;

.search-tabs-widget-description {
@include ariaDescribeElement
}
}
9 changes: 9 additions & 0 deletions assets/scss/tools/_mixins.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
@mixin ariaDescribeElement {
position: absolute;
top: 0;
left: 0;
height: 1px;
width: 1px;
overflow: hidden;
margin-left: -10000px;
}
1 change: 1 addition & 0 deletions assets/scss/tools/_tools.scss
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
@import "list";
@import "string";
@import "image";
@import "mixins";
3 changes: 2 additions & 1 deletion lang/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -850,7 +850,8 @@
},
"error": {
"empty_field": "Search field cannot be empty."
}
},
"tabs_accesibility_hint": "Use left and right arrows to navigate between tabs."
},
"page_not_found": {
"page_heading": "404 Error - Page not found",
Expand Down
19 changes: 11 additions & 8 deletions templates/pages/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,18 @@
{{>components/search/heading}}
</div>
{{/if}}
<nav class="navBar navBar--sub">
<ul class="navBar-section account-navigation">
<li class="navBar-item">
<a id="search-results-product-count" class="navBar-action" href="{{forms.search.product_url}}" data-product-results-toggle>
<nav class="navBar navBar--sub search-nav">
<span id="search-tabs-widget-description" class="search-tabs-widget-description">
{{lang 'search.tabs_accesibility_hint'}}
</span>
<ul role="tablist" class="navBar-section account-navigation" data-search-page-tabs>
<li role="presentation" class="navBar-item">
<a aria-describedby="search-tabs-widget-description" role="tab" aria-controls="product-listing-container" id="search-results-product-count" class="navBar-action" href="{{forms.search.product_url}}" data-product-results-toggle>
{{>components/search/product-count}}
</a>
</li>
<li class="navBar-item">
<a id="search-results-content-count" class="navBar-action" href="{{forms.search.content_url}}" data-content-results-toggle>
<li role="presentation" class="navBar-item">
<a aria-describedby="search-tabs-widget-description" role="tab" aria-controls="search-results-content" id="search-results-content-count" class="navBar-action" href="{{forms.search.content_url}}" data-content-results-toggle>
{{>components/search/content-count}}
</a>
</li>
Expand Down Expand Up @@ -122,11 +125,11 @@ <h5 class="suggestion-title">{{lang 'forms.search.suggestions.title'}}</h5>
</div>
{{/if}}

<div id="search-results-content" {{#if forms.search.section '!=' 'content'}}class="u-hiddenVisually"{{/if}}>
<div role="tabpanel" id="search-results-content" aria-labelledby="search-results-content-count" {{#if forms.search.section '!=' 'content'}}class="u-hidden"{{/if}}>
{{> components/search/content-listing}}
</div>

<div id="product-listing-container" {{#if forms.search.section '!=' 'product'}}class="u-hiddenVisually"{{/if}}>
<div role="tabpanel" id="product-listing-container" aria-labelledby="search-results-product-count" {{#if forms.search.section '!=' 'product'}}class="u-hidden"{{/if}}>
{{> components/search/product-listing}}
</div>

Expand Down