Interface SearchAndListingSubControllers<P, S>

interface SearchAndListingSubControllers<
    P extends Parameters,
    S extends SummaryState,
> {
    breadcrumbManager(): BreadcrumbManager;
    facetGenerator(): FacetGenerator;
    interactiveProduct(props: InteractiveProductProps): InteractiveProduct;
    pagination(props?: PaginationProps): Pagination;
    parameterManager(props?: ParameterManagerProps<P>): ParameterManager<P>;
    sort(props?: SortProps): Sort;
    summary(): Summary<S>;
    urlManager(props: UrlManagerProps): UrlManager;
}

Type Parameters

P extends Parameters
S extends SummaryState

Hierarchy (View Summary)

BaseSolutionTypeSubControllers<S>
- SearchAndListingSubControllers

Index

Methods

breadcrumbManager facetGenerator interactiveProduct pagination parameterManager sort summary urlManager

Methods

breadcrumbManager

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

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

facetGenerator

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

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

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 BaseSolutionTypeSubControllers.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 BaseSolutionTypeSubControllers.pagination
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:79

parameterManager

parameterManager(props?: ParameterManagerProps<P>): ParameterManager<P>
Creates a ParameterManager sub-controller with the specified properties.
Parameters
- Optionalprops: ParameterManagerProps<P>
  Properties for the ParameterManager sub-controller.
Returns ParameterManager<P>
A ParameterManager sub-controller.
- 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.
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:97

summary

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

Returns Summary<S>
A Summary sub-controller.
Inherited from BaseSolutionTypeSubControllers.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.
- Defined in packages/headless/src/controllers/commerce/core/sub-controller/headless-sub-controller.ts:116