449 lines
12 KiB
JavaScript
449 lines
12 KiB
JavaScript
// @flow
|
||
import ArrowKeyNavigation from "boundless-arrow-key-navigation";
|
||
import { isEqual } from "lodash";
|
||
import { observable, action } from "mobx";
|
||
import { observer, inject } from "mobx-react";
|
||
import { PlusIcon } from "outline-icons";
|
||
import queryString from "query-string";
|
||
import * as React from "react";
|
||
import { withTranslation, Trans, type TFunction } from "react-i18next";
|
||
import keydown from "react-keydown";
|
||
import { withRouter, Link } from "react-router-dom";
|
||
import type { RouterHistory, Match } from "react-router-dom";
|
||
import { Waypoint } from "react-waypoint";
|
||
import styled from "styled-components";
|
||
import breakpoint from "styled-components-breakpoint";
|
||
|
||
import AuthStore from "stores/AuthStore";
|
||
import { DEFAULT_PAGINATION_LIMIT } from "stores/BaseStore";
|
||
import DocumentsStore from "stores/DocumentsStore";
|
||
import PoliciesStore from "stores/PoliciesStore";
|
||
import UsersStore from "stores/UsersStore";
|
||
|
||
import Button from "components/Button";
|
||
import CenteredContent from "components/CenteredContent";
|
||
import DocumentListItem from "components/DocumentListItem";
|
||
import Empty from "components/Empty";
|
||
import Fade from "components/Fade";
|
||
import Flex from "components/Flex";
|
||
import HelpText from "components/HelpText";
|
||
import LoadingIndicator from "components/LoadingIndicator";
|
||
import PageTitle from "components/PageTitle";
|
||
import CollectionFilter from "./components/CollectionFilter";
|
||
import DateFilter from "./components/DateFilter";
|
||
import SearchInput from "./components/SearchInput";
|
||
import StatusFilter from "./components/StatusFilter";
|
||
import UserFilter from "./components/UserFilter";
|
||
import NewDocumentMenu from "menus/NewDocumentMenu";
|
||
import { type LocationWithState } from "types";
|
||
import { newDocumentPath, searchUrl } from "utils/routeHelpers";
|
||
import { decodeURIComponentSafe } from "utils/urls";
|
||
|
||
type Props = {
|
||
history: RouterHistory,
|
||
match: Match,
|
||
location: LocationWithState,
|
||
documents: DocumentsStore,
|
||
auth: AuthStore,
|
||
users: UsersStore,
|
||
policies: PoliciesStore,
|
||
notFound: ?boolean,
|
||
t: TFunction,
|
||
};
|
||
|
||
@observer
|
||
class Search extends React.Component<Props> {
|
||
firstDocument: ?React.Component<any>;
|
||
lastQuery: string = "";
|
||
lastParams: Object;
|
||
|
||
@observable
|
||
query: string = decodeURIComponentSafe(this.props.match.params.term || "");
|
||
@observable params: URLSearchParams = new URLSearchParams();
|
||
@observable offset: number = 0;
|
||
@observable allowLoadMore: boolean = true;
|
||
@observable isLoading: boolean = false;
|
||
@observable pinToTop: boolean = !!this.props.match.params.term;
|
||
|
||
componentDidMount() {
|
||
this.handleTermChange();
|
||
|
||
if (this.props.location.search) {
|
||
this.handleQueryChange();
|
||
}
|
||
}
|
||
|
||
componentDidUpdate(prevProps: Props) {
|
||
if (prevProps.location.search !== this.props.location.search) {
|
||
this.handleQueryChange();
|
||
}
|
||
if (prevProps.match.params.term !== this.props.match.params.term) {
|
||
this.handleTermChange();
|
||
}
|
||
}
|
||
|
||
@keydown("esc")
|
||
goBack() {
|
||
this.props.history.goBack();
|
||
}
|
||
|
||
handleKeyDown = (ev: SyntheticKeyboardEvent<HTMLInputElement>) => {
|
||
if (ev.key === "Enter") {
|
||
this.updateLocation(ev.currentTarget.value);
|
||
this.fetchResults();
|
||
return;
|
||
}
|
||
|
||
if (ev.key === "Escape") {
|
||
ev.preventDefault();
|
||
return this.goBack();
|
||
}
|
||
|
||
if (ev.key === "ArrowDown") {
|
||
ev.preventDefault();
|
||
if (this.firstDocument) {
|
||
if (this.firstDocument instanceof HTMLElement) {
|
||
this.firstDocument.focus();
|
||
}
|
||
}
|
||
}
|
||
};
|
||
|
||
handleQueryChange = () => {
|
||
this.params = new URLSearchParams(this.props.location.search);
|
||
this.offset = 0;
|
||
this.allowLoadMore = true;
|
||
|
||
// To prevent "no results" showing before debounce kicks in
|
||
this.isLoading = true;
|
||
|
||
this.fetchResults();
|
||
};
|
||
|
||
handleTermChange = () => {
|
||
const query = decodeURIComponentSafe(this.props.match.params.term || "");
|
||
this.query = query ? query : "";
|
||
this.offset = 0;
|
||
this.allowLoadMore = true;
|
||
|
||
// To prevent "no results" showing before debounce kicks in
|
||
this.isLoading = true;
|
||
|
||
this.fetchResults();
|
||
};
|
||
|
||
handleFilterChange = (search: {
|
||
collectionId?: ?string,
|
||
userId?: ?string,
|
||
dateFilter?: ?string,
|
||
includeArchived?: ?string,
|
||
}) => {
|
||
this.props.history.replace({
|
||
pathname: this.props.location.pathname,
|
||
search: queryString.stringify(
|
||
{
|
||
...queryString.parse(this.props.location.search),
|
||
...search,
|
||
},
|
||
{ skipEmptyString: true }
|
||
),
|
||
});
|
||
};
|
||
|
||
handleNewDoc = () => {
|
||
if (this.collectionId) {
|
||
this.props.history.push(newDocumentPath(this.collectionId));
|
||
}
|
||
};
|
||
|
||
get includeArchived() {
|
||
return this.params.get("includeArchived") === "true";
|
||
}
|
||
|
||
get collectionId() {
|
||
const id = this.params.get("collectionId");
|
||
return id ? id : undefined;
|
||
}
|
||
|
||
get userId() {
|
||
const id = this.params.get("userId");
|
||
return id ? id : undefined;
|
||
}
|
||
|
||
get dateFilter() {
|
||
const id = this.params.get("dateFilter");
|
||
return id ? id : undefined;
|
||
}
|
||
|
||
get isFiltered() {
|
||
return (
|
||
this.dateFilter ||
|
||
this.userId ||
|
||
this.collectionId ||
|
||
this.includeArchived
|
||
);
|
||
}
|
||
|
||
get title() {
|
||
const query = this.query;
|
||
const title = this.props.t("Search");
|
||
if (query) return `${query} – ${title}`;
|
||
return title;
|
||
}
|
||
|
||
@action
|
||
loadMoreResults = async () => {
|
||
// Don't paginate if there aren't more results or we’re in the middle of fetching
|
||
if (!this.allowLoadMore || this.isLoading) return;
|
||
|
||
// Fetch more results
|
||
await this.fetchResults();
|
||
};
|
||
|
||
@action
|
||
fetchResults = async () => {
|
||
if (this.query) {
|
||
const params = {
|
||
offset: this.offset,
|
||
limit: DEFAULT_PAGINATION_LIMIT,
|
||
dateFilter: this.dateFilter,
|
||
includeArchived: this.includeArchived,
|
||
includeDrafts: true,
|
||
collectionId: this.collectionId,
|
||
userId: this.userId,
|
||
};
|
||
|
||
// we just requested this thing – no need to try again
|
||
if (this.lastQuery === this.query && isEqual(params, this.lastParams)) {
|
||
this.isLoading = false;
|
||
return;
|
||
}
|
||
|
||
this.isLoading = true;
|
||
this.lastQuery = this.query;
|
||
this.lastParams = params;
|
||
|
||
try {
|
||
const results = await this.props.documents.search(this.query, params);
|
||
|
||
this.pinToTop = true;
|
||
|
||
if (results.length === 0 || results.length < DEFAULT_PAGINATION_LIMIT) {
|
||
this.allowLoadMore = false;
|
||
} else {
|
||
this.offset += DEFAULT_PAGINATION_LIMIT;
|
||
}
|
||
} catch (err) {
|
||
this.lastQuery = "";
|
||
throw err;
|
||
} finally {
|
||
this.isLoading = false;
|
||
}
|
||
} else {
|
||
this.pinToTop = false;
|
||
this.isLoading = false;
|
||
this.lastQuery = this.query;
|
||
}
|
||
};
|
||
|
||
updateLocation = (query: string) => {
|
||
this.props.history.replace({
|
||
pathname: searchUrl(query),
|
||
search: this.props.location.search,
|
||
});
|
||
};
|
||
|
||
setFirstDocumentRef = (ref: any) => {
|
||
this.firstDocument = ref;
|
||
};
|
||
|
||
render() {
|
||
const { documents, notFound, location, t, auth, policies } = this.props;
|
||
const results = documents.searchResults(this.query);
|
||
const showEmpty = !this.isLoading && this.query && results.length === 0;
|
||
const showShortcutTip =
|
||
!this.pinToTop && location.state && location.state.fromMenu;
|
||
const can = policies.abilities(auth.team?.id ? auth.team.id : "");
|
||
const canCollection = policies.abilities(this.collectionId || "");
|
||
|
||
return (
|
||
<Container auto>
|
||
<PageTitle title={this.title} />
|
||
{this.isLoading && <LoadingIndicator />}
|
||
{notFound && (
|
||
<div>
|
||
<h1>{t("Not Found")}</h1>
|
||
<Empty>
|
||
{t("We were unable to find the page you’re looking for.")}
|
||
</Empty>
|
||
</div>
|
||
)}
|
||
<ResultsWrapper pinToTop={this.pinToTop} column auto>
|
||
<SearchInput
|
||
placeholder={`${t("Search")}…`}
|
||
onKeyDown={this.handleKeyDown}
|
||
defaultValue={this.query}
|
||
/>
|
||
{showShortcutTip && (
|
||
<Fade>
|
||
<HelpText small>
|
||
<Trans
|
||
defaults="Use the <em>{{ shortcut }}</em> shortcut to search from anywhere in your knowledge base"
|
||
values={{ shortcut: "/" }}
|
||
components={{ em: <strong /> }}
|
||
/>
|
||
</HelpText>
|
||
</Fade>
|
||
)}
|
||
{this.pinToTop && (
|
||
<Filters>
|
||
<StatusFilter
|
||
includeArchived={this.includeArchived}
|
||
onSelect={(includeArchived) =>
|
||
this.handleFilterChange({ includeArchived })
|
||
}
|
||
/>
|
||
<CollectionFilter
|
||
collectionId={this.collectionId}
|
||
onSelect={(collectionId) =>
|
||
this.handleFilterChange({ collectionId })
|
||
}
|
||
/>
|
||
<UserFilter
|
||
userId={this.userId}
|
||
onSelect={(userId) => this.handleFilterChange({ userId })}
|
||
/>
|
||
<DateFilter
|
||
dateFilter={this.dateFilter}
|
||
onSelect={(dateFilter) =>
|
||
this.handleFilterChange({ dateFilter })
|
||
}
|
||
/>
|
||
</Filters>
|
||
)}
|
||
{showEmpty && (
|
||
<Fade>
|
||
<Centered column>
|
||
<HelpText>
|
||
<Trans>
|
||
No documents found for your search filters. <br />
|
||
</Trans>
|
||
{can.createDocument && <Trans>Create a new document?</Trans>}
|
||
</HelpText>
|
||
<Wrapper>
|
||
{this.collectionId &&
|
||
can.createDocument &&
|
||
canCollection.update ? (
|
||
<Button
|
||
onClick={this.handleNewDoc}
|
||
icon={<PlusIcon />}
|
||
primary
|
||
>
|
||
{t("New doc")}
|
||
</Button>
|
||
) : (
|
||
<NewDocumentMenu />
|
||
)}
|
||
|
||
<Button as={Link} to="/search" neutral>
|
||
{t("Clear filters")}
|
||
</Button>
|
||
</Wrapper>
|
||
</Centered>
|
||
</Fade>
|
||
)}
|
||
<ResultList column visible={this.pinToTop}>
|
||
<StyledArrowKeyNavigation
|
||
mode={ArrowKeyNavigation.mode.VERTICAL}
|
||
defaultActiveChildIndex={0}
|
||
>
|
||
{results.map((result, index) => {
|
||
const document = documents.data.get(result.document.id);
|
||
if (!document) return null;
|
||
|
||
return (
|
||
<DocumentListItem
|
||
ref={(ref) => index === 0 && this.setFirstDocumentRef(ref)}
|
||
key={document.id}
|
||
document={document}
|
||
highlight={this.query}
|
||
context={result.context}
|
||
showCollection
|
||
showTemplate
|
||
/>
|
||
);
|
||
})}
|
||
</StyledArrowKeyNavigation>
|
||
{this.allowLoadMore && (
|
||
<Waypoint key={this.offset} onEnter={this.loadMoreResults} />
|
||
)}
|
||
</ResultList>
|
||
</ResultsWrapper>
|
||
</Container>
|
||
);
|
||
}
|
||
}
|
||
|
||
const Wrapper = styled(Flex)`
|
||
justify-content: center;
|
||
margin: 10px 0;
|
||
`;
|
||
|
||
const Centered = styled(Flex)`
|
||
text-align: center;
|
||
margin: 30vh auto 0;
|
||
max-width: 380px;
|
||
transform: translateY(-50%);
|
||
`;
|
||
|
||
const Container = styled(CenteredContent)`
|
||
> div {
|
||
position: relative;
|
||
height: 100%;
|
||
}
|
||
`;
|
||
|
||
const ResultsWrapper = styled(Flex)`
|
||
position: absolute;
|
||
transition: all 300ms cubic-bezier(0.65, 0.05, 0.36, 1);
|
||
top: ${(props) => (props.pinToTop ? "0%" : "50%")};
|
||
width: 100%;
|
||
|
||
${breakpoint("tablet")`
|
||
margin-top: ${(props) => (props.pinToTop ? "40px" : "-75px")};
|
||
`};
|
||
`;
|
||
|
||
const ResultList = styled(Flex)`
|
||
margin-bottom: 150px;
|
||
opacity: ${(props) => (props.visible ? "1" : "0")};
|
||
transition: all 400ms cubic-bezier(0.65, 0.05, 0.36, 1);
|
||
`;
|
||
|
||
const StyledArrowKeyNavigation = styled(ArrowKeyNavigation)`
|
||
display: flex;
|
||
flex-direction: column;
|
||
flex: 1;
|
||
`;
|
||
|
||
const Filters = styled(Flex)`
|
||
margin-bottom: 12px;
|
||
opacity: 0.85;
|
||
transition: opacity 100ms ease-in-out;
|
||
overflow-y: hidden;
|
||
overflow-x: auto;
|
||
padding: 8px 0;
|
||
|
||
${breakpoint("tablet")`
|
||
padding: 0;
|
||
`};
|
||
|
||
&:hover {
|
||
opacity: 1;
|
||
}
|
||
`;
|
||
|
||
export default withTranslation()<Search>(
|
||
withRouter(inject("documents", "auth", "policies")(Search))
|
||
);
|