Interface SearchSubControllers

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

Hierarchy (View Summary, Expand)

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

Index

Methods

breadcrumbManager didYouMean facetGenerator interactiveProduct pagination parameterManager sort summary urlManager

Methods

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:72

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:79

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:123

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:97

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:85

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:116

Interface SearchSubControllers

Hierarchy (View Summary, Expand)

Index

Methods

Methods

breadcrumbManager

Returns BreadcrumbManager

didYouMean

Returns DidYouMean

facetGenerator

Returns FacetGenerator

interactiveProduct

Parameters

Returns InteractiveProduct

pagination

Parameters

Returns Pagination

parameterManager

Parameters

Returns ParameterManager<CommerceSearchParameters>

sort

Parameters

Returns Sort

summary

Returns Summary<SearchSummaryState>

urlManager

Parameters

Returns UrlManager

Settings

On This Page