-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #47 from bcgov/DEVX110-ImproveSearcg
Devx110 improve searcg
- Loading branch information
Showing
7 changed files
with
442 additions
and
62 deletions.
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
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,157 @@ | ||
| /* | ||
| * CustomModal.tsx is a customized version of the original SearchModal.tsx | ||
| * The searchResultCustomList component is used rather than <SearchResult> element | ||
| */ | ||
|
|
||
| /* | ||
| * Copyright 2021 The Backstage Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import React, { useCallback, useEffect, useRef } from 'react'; | ||
| import { SearchBar, SearchContextProvider, SearchResultPager } from "@backstage/plugin-search-react"; | ||
| import { Box, Button, Dialog, DialogActions, DialogContent, DialogTitle, Divider, Grid, IconButton, makeStyles, useTheme } from "@material-ui/core"; | ||
| import CloseIcon from '@material-ui/icons/Close'; | ||
| import ArrowForwardIcon from '@material-ui/icons/ArrowForward'; | ||
| import { searchResultCustomList } from './SearchResultCustomList'; | ||
| import { SearchModalChildrenProps, SearchModalProps } from '@backstage/plugin-search'; | ||
| import { useNavigate } from 'react-router-dom'; | ||
| import { useContent } from '@backstage/core-components'; | ||
|
|
||
| const useStyles = makeStyles(theme => ({ | ||
| dialogTitle: { | ||
| gap: theme.spacing(1), | ||
| display: 'grid', | ||
| alignItems: 'center', | ||
| gridTemplateColumns: '1fr auto', | ||
| '&> button': { | ||
| marginTop: theme.spacing(1), | ||
| }, | ||
| }, | ||
| input: { | ||
| flex: 1, | ||
| }, | ||
| button: { | ||
| '&:hover': { | ||
| background: 'none', | ||
| }, | ||
| }, | ||
| // Reduces default height of the modal, keeping a gap of 128px between the top and bottom of the page. | ||
| paperFullWidth: { height: 'calc(100% - 128px)' }, | ||
| dialogActionsContainer: { padding: theme.spacing(1, 3) }, | ||
| viewResultsLink: { verticalAlign: '0.5em' }, | ||
| })); | ||
|
|
||
| export const CustomModal = ({ toggleModal }: SearchModalChildrenProps) => { | ||
| const classes = useStyles(); | ||
| const navigate = useNavigate(); | ||
| const { transitions } = useTheme(); | ||
| const { focusContent } = useContent(); | ||
| const searchBarRef = useRef<HTMLInputElement | null>(null); | ||
|
|
||
| useEffect(() => { | ||
| searchBarRef?.current?.focus(); | ||
| }); | ||
|
|
||
| const handleSearchResultClick = useCallback(() => { | ||
| setTimeout(focusContent, transitions.duration.leavingScreen); | ||
| }, [focusContent, transitions]); | ||
|
|
||
| // This handler is called when "enter" is pressed | ||
| const handleSearchBarSubmit = useCallback(() => { | ||
| // Using ref to get the current field value without waiting for a query debounce | ||
| const query = searchBarRef.current?.value ?? ''; | ||
| navigate(`/search?query=${query}`); | ||
| handleSearchResultClick(); | ||
| }, [navigate, handleSearchResultClick]); | ||
|
|
||
| return ( | ||
| <> | ||
| <DialogTitle> | ||
| <Box className={classes.dialogTitle}> | ||
| <SearchBar | ||
| className={classes.input} | ||
| inputProps={{ ref: searchBarRef }} | ||
| onSubmit={handleSearchBarSubmit} | ||
| /> | ||
|
|
||
| <IconButton aria-label="close" onClick={toggleModal}> | ||
| <CloseIcon /> | ||
| </IconButton> | ||
| </Box> | ||
| </DialogTitle> | ||
| <DialogContent> | ||
| <Grid | ||
| container | ||
| direction="row-reverse" | ||
| justifyContent="flex-start" | ||
| alignItems="center" | ||
| > | ||
| <Grid item> | ||
| <Button | ||
| className={classes.button} | ||
| color="primary" | ||
| endIcon={<ArrowForwardIcon />} | ||
| onClick={handleSearchBarSubmit} | ||
| disableRipple | ||
| > | ||
| View Full Results | ||
| </Button> | ||
| </Grid> | ||
| </Grid> | ||
| <Divider /> | ||
| <Grid container direction="column"> | ||
| <Grid item> | ||
| {searchResultCustomList} | ||
| </Grid> | ||
| </Grid> | ||
| </DialogContent> | ||
| <DialogActions className={classes.dialogActionsContainer}> | ||
| <Grid container direction="row"> | ||
| <Grid item xs={12}> | ||
| <SearchResultPager /> | ||
| </Grid> | ||
| </Grid> | ||
| </DialogActions> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export const CustomSearchModal = (props: SearchModalProps) => { | ||
| const { open = true, hidden, toggleModal, children } = props; | ||
|
|
||
| const classes = useStyles(); | ||
|
|
||
| return ( | ||
| <Dialog | ||
| classes={{ | ||
| paperFullWidth: classes.paperFullWidth, | ||
| }} | ||
| onClose={toggleModal} | ||
| aria-labelledby="search-modal-title" | ||
| fullWidth | ||
| maxWidth="lg" | ||
| open={open} | ||
| hidden={hidden} | ||
| > | ||
| {open && ( | ||
| <SearchContextProvider inheritParentContextIfAvailable> | ||
| {(children && children({ toggleModal })) ?? ( | ||
| <CustomModal toggleModal={toggleModal} /> | ||
| )} | ||
| </SearchContextProvider> | ||
| )} | ||
| </Dialog> | ||
| ); | ||
| }; |
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
64 changes: 64 additions & 0 deletions
64
packages/app/src/components/search/SearchResultCustomList.tsx
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,64 @@ | ||
| import React from 'react'; | ||
|
|
||
| import { List } from '@material-ui/core'; | ||
| import { SearchResult, DefaultResultListItem } from '@backstage/plugin-search-react'; | ||
|
|
||
| import { CatalogSearchResultListItem } from '@backstage/plugin-catalog'; | ||
| import { StackOverflowSearchResultListItem, StackOverflowIcon } from '@backstage/plugin-stack-overflow'; | ||
| import { CatalogIcon, DocsIcon } from '@backstage/core-components'; | ||
| import { TechDocsSearchResultCustomListItem } from './TechDocsSearchResultCustomListItem'; | ||
|
|
||
| const SearchResultCustomList = () => { | ||
| return ( | ||
| <SearchResult> | ||
| {({ results }) => ( | ||
| <List> | ||
| {results.map(({ type, document, highlight, rank }) => { | ||
| switch (type) { | ||
| case 'software-catalog': | ||
| return ( | ||
| <CatalogSearchResultListItem | ||
| key={document.location} | ||
| result={document} | ||
| highlight={highlight} | ||
| rank={rank} | ||
| icon={<CatalogIcon />} | ||
| /> | ||
| ); | ||
| case 'techdocs': | ||
| return ( | ||
| <TechDocsSearchResultCustomListItem | ||
| key={document.location} | ||
| result={document} | ||
| highlight={highlight} | ||
| rank={rank} | ||
| asListItem={true} | ||
| icon={<DocsIcon />} | ||
| /> | ||
| ); | ||
| case 'stack-overflow': | ||
| return ( | ||
| <StackOverflowSearchResultListItem | ||
| key={document.location} | ||
| result={document} | ||
| icon={<StackOverflowIcon />} | ||
| /> | ||
| ); | ||
| default: | ||
| return ( | ||
| <DefaultResultListItem | ||
| key={document.location} | ||
| result={document} | ||
| highlight={highlight} | ||
| rank={rank} | ||
| /> | ||
| ); | ||
| } | ||
| })} | ||
| </List> | ||
| )} | ||
| </SearchResult> | ||
| ) | ||
| } | ||
|
|
||
| export const searchResultCustomList = <SearchResultCustomList />; |
Oops, something went wrong.