@coveo/headless-react
    Preparing search index...

    Interface ContextDefinition

    interface ContextDefinition {
        listing: true;
        recommendation: true;
        search: true;
        standalone: true;
        buildWithProps(
            engine: CommerceEngine,
            props?: ContextOptions,
            solutionType?: SolutionType,
        ): Context & ControllerWithKind;
    }

    Hierarchy

    Index

    Methods

    buildWithProps

    Properties

    listing recommendation search standalone

    Methods

    • Creates an instance of the given controller.

      Parameters

      • engine: CommerceEngine

        The search engine.

      • Optionalprops: ContextOptions

        The controller properties.

      • OptionalsolutionType: SolutionType

        The type of solution for which the controller should be built (e.g. search or listing). This option only applies to sub-controllers.

      Returns Context & ControllerWithKind

      The created controller instance.

    Properties

    listing: true
    recommendation: true
    search: true
    standalone: true

    Settings

    Member Visibility

    On This Page

    Methods
    Properties