@yext/search-ui-react/src/models/verticalConfig.ts

A library of React Components for powering Yext Search integrations

import { CardComponent } from './cardComponent';
import { DefaultRawDataType } from './DefaultRawDataType';
import { SectionComponent } from './sectionComponent';
import { VerticalLink } from './verticalLink';

/**
 * The configuration for a vertical.
 *
 * @public
 */
export interface VerticalConfig<T = DefaultRawDataType> {
  /** {@inheritDoc SectionComponent} */
  SectionComponent?: SectionComponent<T>,
  /** The card to use for this vertical. */
  CardComponent?: CardComponent<T>,
  /** The label for the vertical. */
  label?: string,
  /** Whether or not this vertical should show a button to view all results on the vertical page. */
  viewAllButton?: boolean,
  /**
   * A function to provide user defined url path for each vertical's view all link.
   *
   * @remarks
   * Defaults to "/[verticalKey]?query=[query]"
   */
  getViewAllUrl?: (data: VerticalLink) => string
}

/**
 * A map of verticalKey to a VerticalConfig.
 *
 * @public
 */
export type VerticalConfigMap<T = Record<string, DefaultRawDataType>> = {
  [K in keyof T]: VerticalConfig<T[K]>
};