wp-calypso/client/devdocs/main.jsx

import { Card } from '@automattic/components';
import debug from 'debug';
import PropTypes from 'prop-types';
import { Component } from 'react';
import DocumentHead from 'calypso/components/data/document-head';
import Main from 'calypso/components/main';
import SearchCard from 'calypso/components/search-card';
import DocService from './service';
import './style.scss';

/**
 * Constants
 */

const DEFAULT_FILES = [
	'docs/guide/index.md',
	'README.md',
	'docs/CONTRIBUTING.md',
	'docs/coding-guidelines.md',
	'docs/coding-guidelines/javascript.md',
	'docs/coding-guidelines/css.md',
	'docs/coding-guidelines/html.md',
	'docs/accessibility.md',
];

/**
 * Module variables
 */

const log = debug( 'calypso:devdocs' );

export default class Devdocs extends Component {
	static displayName = 'Devdocs';

	static propTypes = {
		term: PropTypes.string,
	};

	static defaultProps = {
		term: '',
	};

	state = {
		term: this.props.term,
		results: [],
		defaultResults: [],
		inputValue: '',
		searching: false,
	};

	// load default files if not already cached
	loadDefaultFiles = () => {
		if ( this.state.defaultResults.length ) {
			return;
		}

		DocService.list( DEFAULT_FILES, ( err, results ) => {
			if ( ! err ) {
				this.setState( {
					defaultResults: results,
				} );
			}
		} );
	};

	componentDidMount() {
		const { term } = this.state;
		this.loadDefaultFiles();
		if ( ! term ) {
			return;
		}
		this.onSearchChange( this.state.term );
		this.onSearch( this.state.term );
	}

	componentDidUpdate( prevProps, prevState ) {
		if ( typeof this.props.onSearchChange === 'function' && prevState.term !== this.state.term ) {
			this.props.onSearchChange( this.state.term );
		}
	}

	notFound = () => {
		return (
			this.state.inputValue &&
			this.state.term &&
			! this.state.results.length &&
			! this.state.searching
		);
	};

	onSearchChange = ( term ) => {
		this.setState( {
			inputValue: term,
			term: term,
			searching: !! term,
		} );
	};

	onSearch = ( term ) => {
		if ( ! term ) {
			return;
		}
		DocService.search( term, ( err, results ) => {
			if ( err ) {
				log( 'search error: %o', err );
			}

			this.setState( {
				results,
				searching: false,
			} );
		} );
	};

	results = () => {
		if ( this.notFound() ) {
			return <p>Not Found</p>;
		}

		const searchResults = this.state.inputValue ? this.state.results : this.state.defaultResults;
		return searchResults.map( function ( result ) {
			let url = '/devdocs/' + result.path;

			if ( this.state.term ) {
				url += '?term=' + encodeURIComponent( this.state.term );
			}

			return (
				<Card compact className="devdocs__result" key={ result.path }>
					<header className="devdocs__result-header">
						<h1 className="devdocs__result-title">
							<a className="devdocs__result-link" href={ url }>
								{ result.title }
							</a>
						</h1>
						<h2 className="devdocs__result-path">{ result.path }</h2>
					</header>
					{ this.snippet( result ) }
				</Card>
			);
		}, this );
	};

	snippet = ( result ) => {
		// split around <mark> tags to avoid setting unescaped inner HTML
		const parts = result.snippet.split( /(<mark>.*?<\/mark>)/ );

		return (
			<div className="devdocs__result-snippet" key={ 'snippet' + result.path }>
				{ parts.map( function ( part, i ) {
					const markMatch = part.match( /<mark>(.*?)<\/mark>/ );
					if ( markMatch ) {
						return <mark key={ 'mark' + i }>{ markMatch[ 1 ] }</mark>;
					}
					return part;
				} ) }
			</div>
		);
	};

	render() {
		return (
			<Main className="devdocs devdocs__search">
				<DocumentHead title="Calypso Docs" />

				<SearchCard
					autoFocus // eslint-disable-line jsx-a11y/no-autofocus
					placeholder="Search documentation…"
					analyticsGroup="Docs"
					initialValue={ this.state.term }
					delaySearch
					onSearchChange={ this.onSearchChange }
					onSearch={ this.onSearch }
				/>
				<div className="devdocs__results">{ this.results() }</div>
			</Main>
		);
	}
}