Ways to Build Search | Yext Hitchhikers Platform
What You’ll Learn
By the end of this unit, you will be able to:
- Recall the methods available to build on top of Search and their use cases
- Locate where to find more in-depth documentation for each method
- Recognize which method of building the Search frontend is right for you
Everyone who uses Yext Search will use the Search configuration to manage the backend, which we’ll cover in the rest of this track. There are several options to build the Search frontend, depending on whether you want to use an out-of-the-box solution with built-in templates or want to customize more on your own. We’ve listed the options starting at the core of Yext Search, the bottom layer in the diagram, and build up.
- Developer Options
- Search API: REST API at the core of Yext Search
- Search Core: a Search API Typescript client with functions for all Search API calls that doesn’t require access to the DOM
- Search UI React: React library that provides state management and hooks for building robust Search experiences. It also contains fully styled UI components to get up and running quickly
- Low-Code Option
- Hitchhikers Theme: low-code option for a quick out-of-the-box experience using customizable templates
We’ve outlined the options in more depth below. Building the frontend won’t be covered in this track, but once you choose the option you want to use, you can follow the links to guides and reference documents to get started.
Search Core is a Search API Typescript client that has functions for all the different Search API calls. Core is a networking layer on top of the API. Core doesn’t require access to the DOM, which means this library can fit most use cases, either in the browser or on a Node server, and is compatible with both CommonJS and ES6 imports.
This is a good option if you want the complete UI flexibility of using an API, but are not using React. It’s also a good option if you are looking to build your Search experience in a different framework (e.g., Vue or Angular).
Search UI React
The Search UI React library contains customizable UI components that are fully functional and stylized out of the box. Using this library provides developers the quickest way to get your Search experience up and running. It is built on top of the Search Headless React library, a series of React hooks for managing Search state. Search Headless hooks allow you to extend Search UI React functionality and build your own Search components.
Which Method is Right for You?
If you’re a not a developer, you’ll want to build with the Hitchhikers Theme using the Pages product UI to edit your frontend.