@coveo/headless
    Preparing search index...

    Interface RegisterFoldingActionCreatorPayload

    interface RegisterFoldingActionCreatorPayload {
        childField?: string;
        collectionField?: string;
        numberOfFoldedResults?: number;
        parentField?: string;
    }
    Index

    Properties

    childField? collectionField? numberOfFoldedResults? parentField?

    Properties

    childField?: string

    The name of the field that uniquely identifies a result within a collection.

    foldingchild

    collectionField?: string

    The name of the field on which to do the folding. The folded result list component will use the values of this field to resolve the collections of result items.

    foldingcollection

    numberOfFoldedResults?: number

    The number of child results to fold under the root collection element, before expansion.

    2

    parentField?: string

    The name of the field that determines whether a certain result is a top result containing other child results within a collection.

    foldingparent

    Settings

    Member Visibility

    On This Page

    Properties