Interactive interface for browsing global, full-resolution satellite imagery
WV-4041: Modernizing ProductPickerHeader, ProductPicker, and SearchUiProvider Components (#6805)
christof-wittreich4684a0e9eea6
diff --git a/web/js/components/layer/product-picker/header.js b/web/js/components/layer/product-picker/header.jsindex 2505592a1..d27b64600 100644--- a/web/js/components/layer/product-picker/header.js+++ b/web/js/components/layer/product-picker/header.js@@ -1,4 +1,4 @@-import React from 'react';+import { useEffect, useRef } from 'react';import { connect } from 'react-redux';import PropTypes from 'prop-types';import {@@ -24,48 +24,51 @@ import { JOYRIDE_INCREMENT } from '../../../util/constants';const { events } = util;-class ProductPickerHeader extends React.Component {- constructor(props) {- super(props);- this.revertToInitialScreen = this.revertToInitialScreen.bind(this);- this.handleChange = this.handleChange.bind(this);- this.onSearchInputFocus = this.onSearchInputFocus.bind(this);- this.resetSearch = this.resetSearch.bind(this);- }+function ProductPickerHeader(props) {+ const {+ isMobile,+ filters,+ searchTerm,+ searchConfig,+ saveSearchState,+ toggleCategoryMode,+ setSearchTerm,+ showMobileFacets,+ toggleMobileFacets,+ category,+ unselectLayer,+ mode,+ toggleSearchMode,+ categoryType,+ layerCount,+ results,+ selectedLayer,+ selectedProjection,+ width,+ } = props;++ const inputRef = useRef(null);- componentDidMount() {- const { isMobile } = this.props;+ useEffect(() => {setTimeout(() => {- if (this.input && !isMobile) this.input.focus();+ if (inputRef.current && !isMobile) inputRef.current.focus();}, 500);- }+ }, []);/*** Go back to original screen* @method revertToInitialScreen*/- revertToInitialScreen(e) {- const {- filters,- searchTerm,- searchConfig,- saveSearchState,- toggleCategoryMode,- } = this.props;+ function revertToInitialScreen(e) {e.preventDefault();saveSearchState(filters, searchTerm, searchConfig);toggleCategoryMode();}- handleChange = (e) => {- const {- setSearchTerm,- showMobileFacets,- toggleMobileFacets,- } = this.props;+ const handleChange = (e) => {const { value } = e.target;- this.onSearchInputFocus();+ onSearchInputFocus();setSearchTerm(value, {shouldClearFilters: false,debounce: 200,@@ -77,15 +80,14 @@ class ProductPickerHeader extends React.Component {}};- renderBreadCrumb() {- const { category } = this.props;+ function renderBreadCrumb() {return (<Breadcrumb tag="nav" className="layer-bread-crumb"><BreadcrumbItemtag="a"title="Back to Layer Categories"href="#"- onClick={this.revertToInitialScreen}+ onClick={revertToInitialScreen}>Categories</BreadcrumbItem>@@ -96,8 +98,7 @@ class ProductPickerHeader extends React.Component {);}- resetSearch() {- const { setSearchTerm, unselectLayer } = this.props;+ function resetSearch() {unselectLayer();setSearchTerm('', {shouldClearFilters: true,@@ -105,8 +106,7 @@ class ProductPickerHeader extends React.Component {});}- onSearchInputFocus (e) {- const { mode, toggleSearchMode } = this.props;+ function onSearchInputFocus (e) {if (mode !== 'search') {setTimeout(() => {events.trigger(JOYRIDE_INCREMENT);@@ -115,119 +115,101 @@ class ProductPickerHeader extends React.Component {}}- render() {- const {- category,- categoryType,- filters,- isMobile,- layerCount,- mode,- showMobileFacets,- toggleMobileFacets,- results,- searchTerm,- selectedLayer,- selectedProjection,- toggleSearchMode,- width,- } = this.props;- const searchMode = mode === 'search';- const categoryId = category && category.id;- const recentLayersMode = categoryType === 'recent';- const featuredLayersMode = categoryType === 'featured';- const showBackButton = searchMode ||- (categoryId !== 'featured-all' &&- selectedProjection === 'geographic' &&- mode !== 'category' &&- !featuredLayersMode &&- !recentLayersMode);- const isBreadCrumb = showBackButton && !searchMode && width > 650;- const showReset = !!(filters.length || searchTerm.length) && mode === 'search';- const showFilterBtnMobile = recentLayersMode ||- (searchMode ? !showMobileFacets : !selectedLayer);- const showFilterBnDesktop = recentLayersMode ||- (!searchMode && !selectedLayer);- const showFilterBn = isMobile ? showFilterBtnMobile : showFilterBnDesktop;- const filterBtnFn = !searchMode ? toggleSearchMode : toggleMobileFacets;- const inputClass = !searchMode && searchTerm ? 'faded' : '';+ const searchMode = mode === 'search';+ const categoryId = category && category.id;+ const recentLayersMode = categoryType === 'recent';+ const featuredLayersMode = categoryType === 'featured';+ const showBackButton = searchMode ||+ (categoryId !== 'featured-all' &&+ selectedProjection === 'geographic' &&+ mode !== 'category' &&+ !featuredLayersMode &&+ !recentLayersMode);+ const isBreadCrumb = showBackButton && !searchMode && width > 650;+ const showReset = !!(filters.length || searchTerm.length) && mode === 'search';+ const showFilterBtnMobile = recentLayersMode ||+ (searchMode ? !showMobileFacets : !selectedLayer);+ const showFilterBnDesktop = recentLayersMode ||+ (!searchMode && !selectedLayer);+ const showFilterBn = isMobile ? showFilterBtnMobile : showFilterBnDesktop;+ const filterBtnFn = !searchMode ? toggleSearchMode : toggleMobileFacets;+ const inputClass = !searchMode && searchTerm ? 'faded' : '';- return (- <>- <InputGroup id="layer-search" className="layer-search">- {showBackButton && (- <>- <Button- id="layer-back-button"- className="back-button"- color="secondary"- onClick={this.revertToInitialScreen}- >- <UncontrolledTooltip- id="center-align-tooltip"- placement="right"- target="layer-back-button"- >- Return to category view- </UncontrolledTooltip>- <FontAwesomeIcon icon="arrow-left" widthAuto />- </Button>- {isBreadCrumb && this.renderBreadCrumb()}- </>- )}-- {showReset && (- <Button- className="clear-filters"- onClick={() => this.resetSearch()}- >- Reset- </Button>- )}-- {showFilterBn && (+ return (+ <>+ <InputGroup id="layer-search" className="layer-search">+ {showBackButton && (+ <><Button- id="layer-filter-button"- className="filter-button"- onClick={filterBtnFn}- aria-label="Filtered layer search"+ id="layer-back-button"+ className="back-button"+ color="secondary"+ onClick={revertToInitialScreen}><UncontrolledTooltipid="center-align-tooltip"placement="right"- target="layer-filter-button"+ target="layer-back-button">- Filtered layer search+ Return to category view</UncontrolledTooltip>- <FontAwesomeIcon icon="filter" widthAuto />+ <FontAwesomeIcon icon="arrow-left" widthAuto /></Button>- )}+ {isBreadCrumb && renderBreadCrumb()}+ </>+ )}- <Input- className={inputClass}- onChange={this.handleChange}- onClick={this.onSearchInputFocus}- id="layers-search-input"- value={searchTerm}- placeholder="Search"- type="search"+ {showReset && (+ <Button+ className="clear-filters"+ onClick={() => resetSearch()}+ >+ Reset+ </Button>+ )}- innerRef={(c) => (this.input = c)}- />- </InputGroup>+ {showFilterBn && (+ <Button+ id="layer-filter-button"+ className="filter-button"+ onClick={filterBtnFn}+ aria-label="Filtered layer search"+ >+ <UncontrolledTooltip+ id="center-align-tooltip"+ placement="right"+ target="layer-filter-button"+ >+ Filtered layer search+ </UncontrolledTooltip>+ <FontAwesomeIcon icon="filter" widthAuto />+ </Button>+ )}++ <Input+ className={inputClass}+ onChange={handleChange}+ onClick={onSearchInputFocus}+ id="layers-search-input"+ value={searchTerm}+ placeholder="Search"+ type="search"++ innerRef={(c) => (inputRef.current = c)}+ />+ </InputGroup>- {mode === 'search' && (- <div className="header-filter-container">- <div className="results-text">- {results.length === layerCount- ? `Showing ${results.length} layers`- : `Showing ${results.length} out of ${layerCount}`}- </div>+ {mode === 'search' && (+ <div className="header-filter-container">+ <div className="results-text">+ {results.length === layerCount+ ? `Showing ${results.length} layers`+ : `Showing ${results.length} out of ${layerCount}`}</div>- )}- </>- );- }+ </div>+ )}+ </>+ );}ProductPickerHeader.propTypes = {diff --git a/web/js/components/layer/product-picker/product-picker.js b/web/js/components/layer/product-picker/product-picker.jsindex c06753d28..c92fa938b 100644--- a/web/js/components/layer/product-picker/product-picker.js+++ b/web/js/components/layer/product-picker/product-picker.js@@ -1,4 +1,4 @@-import React from 'react';+import { useState, useEffect, useRef } from 'react';import { connect } from 'react-redux';import PropTypes from 'prop-types';import {@@ -20,6 +20,7 @@ import {} from '../../../modules/product-picker/actions';import util from '../../../util/util';import { JOYRIDE_INCREMENT } from '../../../util/constants';+import usePrevious from '../../../util/customHooks';const { events } = util;@@ -28,39 +29,56 @@ const { events } = util;* @class LayerList* @extends React.Component*/-class ProductPicker extends React.Component {- constructor(props) {- super(props);- this.state = {- modalElement: undefined,+function ProductPicker(props) {+ const {+ filters,+ searchTerm,+ saveSearchState,+ mode,+ categoryType,+ closeModal,+ width,+ } = props;++ const [modalElement, setModalElement] = useState(undefined);++ const filtersRef = useRef(filters);+ const searchTermRef = useRef(searchTerm);++ const prevMode = usePrevious(mode);+ const prevCategoryType = usePrevious(categoryType);++ useEffect(() => {+ const modalElementNew = document.getElementById('layer_picker_component');+ setModalElement(modalElementNew);+ return () => {+ saveSearchState(filtersRef.current, searchTermRef.current);};- }+ }, []);- componentDidMount() {- const modalElement = document.getElementById('layer_picker_component');- this.setState({ modalElement }, () => {- setTimeout(() => {- events.trigger(JOYRIDE_INCREMENT);- }, 200);- this.setModalClass();- });- }+ useEffect(() => {+ if (!modalElement) return;+ setTimeout(() => {+ events.trigger(JOYRIDE_INCREMENT);+ }, 200);+ setModalClass();+ }, [modalElement]);- componentDidUpdate(prevProps) {- const { mode, categoryType } = this.props;- if (prevProps.mode !== mode || prevProps.categoryType !== categoryType) {- this.setModalClass();+ useEffect(() => {+ if ((prevMode !== mode || prevCategoryType !== categoryType) && modalElement) {+ setModalClass();}- }+ }, [mode, categoryType]);- componentWillUnmount() {- const { filters, searchTerm, saveSearchState } = this.props;- saveSearchState(filters, searchTerm);- }+ useEffect(() => {+ filtersRef.current = filters;+ }, [filters]);- setModalClass() {- const { modalElement } = this.state;- const { mode, categoryType } = this.props;+ useEffect(() => {+ searchTermRef.current = searchTerm;+ }, [searchTerm]);++ function setModalClass() {if (mode === 'category' && categoryType !== 'recent') {modalElement.classList.remove('browse-search-width');modalElement.classList.add('category-width');@@ -75,35 +93,28 @@ class ProductPicker extends React.Component {}}- render() {- const {- closeModal,- mode,- width,- } = this.props;- const closeBtn = (- <button className="layer-btn-close" onClick={closeModal} style={mode === 'search' ? { top: '-10px' } : {}} type="button">- ×- </button>- );- return (- <>- <ModalHeader toggle={closeModal} close={closeBtn}>- <ProductPickerHeader- width={width}- toggleFilterByAvailable={this.toggleFilterByAvailable}- />- </ModalHeader>- <ModalBody>- <div id="layer-modal-content" className="layer-modal-content">- {mode !== 'search'- ? (<BrowseLayers width={width} />)- : (<SearchLayers />)}- </div>- </ModalBody>- </>- );- }+ const closeBtn = (+ <button className="layer-btn-close" onClick={closeModal} style={mode === 'search' ? { top: '-10px' } : {}} type="button">+ ×+ </button>+ );++ return (+ <>+ <ModalHeader toggle={closeModal} close={closeBtn}>+ <ProductPickerHeader+ width={width}+ />+ </ModalHeader>+ <ModalBody>+ <div id="layer-modal-content" className="layer-modal-content">+ {mode !== 'search'+ ? (<BrowseLayers width={width} />)+ : (<SearchLayers />)}+ </div>+ </ModalBody>+ </>+ );}ProductPicker.propTypes = {diff --git a/web/js/components/layer/product-picker/search-ui-provider.js b/web/js/components/layer/product-picker/search-ui-provider.jsindex f8e2ea6e2..4d6442ff4 100644--- a/web/js/components/layer/product-picker/search-ui-provider.js+++ b/web/js/components/layer/product-picker/search-ui-provider.js@@ -1,4 +1,4 @@-import React from 'react';+import { useEffect } from 'react';import { connect } from 'react-redux';import PropTypes from 'prop-types';import {@@ -9,22 +9,23 @@ import {} from '../../../modules/product-picker/actions';import ProductPicker from './product-picker';-class SearchUiProvider extends React.Component {- componentDidMount() {- const { initState } = this.props;+function SearchUiProvider(props) {+ const {+ initState,+ searchConfig,+ } = props;++ useEffect(() => {initState();- }+ }, []);- render() {- const { searchConfig } = this.props;- return !searchConfig- ? null- : (- <SearchProvider config={searchConfig}>- <ProductPicker />- </SearchProvider>- );- }+ return !searchConfig+ ? null+ : (+ <SearchProvider config={searchConfig}>+ <ProductPicker />+ </SearchProvider>+ );}SearchUiProvider.propTypes = {