Top-level Configuration

customerId

Your customer ID, e.g. --customerId--.

area

The area you wish to fire against, production, staging, etc. If not specified, the Production area will be used (and if one doesn’t exist, an error will be returned).

collection

The product collection to use. If you don’t pass this parameter, it will default to default. This is case sensitive and should be same as your collection name.

For example:

collection: {
  options: ['faq', 'articles', 'mainProducts'],
  default: 'mainProducts',
}

The above configuration will search by default against the collection configured in default, and allow the user to switch into the other collection which will appear as an alternative option.

The collection switching is rendered by the <gb-collections> tag and the labels for the above collections are configured in tags under collections.

collections

The overrides to use for your collection count call to the search API. Please refer to SEARCH API for what parameters you can pass in here.

For example, we can override the area used:

collections: {
  overrides: {
    area: 'Production'
  }
}

You can also use a function that returns an object to set the overrides:

collections: {
  overrides: (currReq, prevReq) => {
    // do stuff
    return { ...currReq, area: 'Production' };
  }
}

details

The overrides to use for your details calls to the search API. Please refer to SEARCH API for what parameters you can pass in here.

For example, we can override the collection used:

details: {
  overrides: {
    collection: 'Main'
  }
}

You can also use a function that returns an object to set the overrides:

details: {
  overrides: (currReq, prevReq) => {
    // do stuff
    return { ...currReq, collection: 'Main' };
  }
}

refinements

The overrides to use for your more refinements calls to the refinements search API. Please refer to SEARCH API for what parameters you can pass in here. These overrides will be applied to the originalQuery object sent with the refinements call.

For example, we can override the originalQuery used:

refinements: {
  overrides: {
    query: 'dress'
  }
}

You can also use a function that returns an object to set the overrides:

refinements: {
  overrides: (currReq, prevReq) => {
    // do stuff
    return { ...currReq, query: 'dress' };
  }
}

bootstrap

An optional function which will be invoked at StoreFront instantiation time.

The bootstrap function – which is invoked with the StoreFront instance – can be used to perform synchronous operations before the StoreFront application is mounted.

...
bootstrap: (app) => {
  // Ensure the `myCoolId` element is present in the DOM.
  const selector = 'myCoolId';

  if (!document.getElementById(selector)) {
    const elem = document.createElement('section');
    elem.id = selector;
    document.body.appendChild(elem);
  }
},
...