Interface SearchSubControllers

interface SearchSubControllers {
    breadcrumbManager(): BreadcrumbManager;
    didYouMean(): DidYouMean;
    facetGenerator(): FacetGenerator;
    interactiveProduct(props: InteractiveProductProps): InteractiveProduct;
    interactiveSpotlightContent(
        props: InteractiveSpotlightContentProps,
    ): InteractiveSpotlightContent;
    pagination(props?: PaginationProps): Pagination;
    parameterManager(
        props?: ParameterManagerProps<CommerceSearchParameters>,
    ): ParameterManager<CommerceSearchParameters>;
    sort(props?: SortProps): Sort;
    summary(): Summary<SearchSummaryState>;
    urlManager(props: UrlManagerProps): UrlManager;
}

Hierarchy (View Summary)

SearchAndListingSubControllers<CommerceSearchParameters, SearchSummaryState>
- SearchSubControllers
  - Search
  - Search

Index

Methods

breadcrumbManager didYouMean facetGenerator interactiveProduct interactiveSpotlightContent pagination parameterManager sort summary urlManager

Methods

breadcrumbManager

breadcrumbManager(): BreadcrumbManager
Creates a BreadcrumbManager sub-controller.

Returns BreadcrumbManager
A BreadcrumbManager sub-controller.
Inherited from SearchAndListingSubControllers.breadcrumbManager
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:114

didYouMean

didYouMean(): DidYouMean
Creates a DidYouMean sub-controller.

Returns DidYouMean
A DidYouMean sub-controller.
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:149

facetGenerator

facetGenerator(): FacetGenerator
Creates a FacetGenerator sub-controller.

Returns FacetGenerator
A FacetGenerator sub-controller.
Inherited from SearchAndListingSubControllers.facetGenerator
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:108

interactiveProduct

interactiveProduct(props: InteractiveProductProps): InteractiveProduct
Creates an InteractiveProduct sub-controller.
Parameters
- props: InteractiveProductProps
  The properties for the InteractiveProduct sub-controller.
Returns InteractiveProduct
An InteractiveProduct sub-controller.
Inherited from SearchAndListingSubControllers.interactiveProduct
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:77

interactiveSpotlightContent

interactiveSpotlightContent(
props: InteractiveSpotlightContentProps,
): InteractiveSpotlightContent
Creates an InteractiveSpotlightContent sub-controller, for use when enableResults is set on the controller.
Parameters
- props: InteractiveSpotlightContentProps
  The properties for the InteractiveSpotlightContent sub-controller.
Returns InteractiveSpotlightContent
An InteractiveSpotlightContent sub-controller.
Inherited from SearchAndListingSubControllers.interactiveSpotlightContent
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:135

pagination

pagination(props?: PaginationProps): Pagination
Creates a Pagination sub-controller.
Parameters
- Optionalprops: PaginationProps
  The optional properties for the Pagination sub-controller.
Returns Pagination
A Pagination sub-controller.
Inherited from SearchAndListingSubControllers.pagination
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:84

parameterManager

parameterManager(
props?: ParameterManagerProps<CommerceSearchParameters>,
): ParameterManager<CommerceSearchParameters>
Creates a ParameterManager sub-controller with the specified properties.
Parameters
- Optionalprops: ParameterManagerProps<CommerceSearchParameters>
  Properties for the ParameterManager sub-controller.
Returns ParameterManager<CommerceSearchParameters>
A ParameterManager sub-controller.
Inherited from SearchAndListingSubControllers.parameterManager
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:128

sort

sort(props?: SortProps): Sort
Creates a Sort sub-controller.
Parameters
- Optionalprops: SortProps
  Optional properties for the Sort sub-controller.
Returns Sort
A Sort sub-controller.
Inherited from SearchAndListingSubControllers.sort
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:102

summary

summary(): Summary<SearchSummaryState>
Creates a Summary sub-controller.

Returns Summary<SearchSummaryState>
A Summary sub-controller.
Inherited from SearchAndListingSubControllers.summary
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:90

urlManager

urlManager(props: UrlManagerProps): UrlManager
Creates a UrlManager sub-controller with the specified properties.
Parameters
- props: UrlManagerProps
  Properties for the UrlManager sub-controller.
Returns UrlManager
A UrlManager sub-controller.
Inherited from SearchAndListingSubControllers.urlManager
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:121