Migrating to v6

Introduction

This document will walk you through upgrading your RapidUI implementation from RapidUI v5to v6.

One of the biggest changes in v6 is the replacement of HawkSearch configuration object, v5 is initialized with

var HawkSearch = HawkSearch || {};

HawkSearch.config = {
  clientId: "xxxxxxxxxxxxxxxxxx",
  ...
};

where as v6 is initialised using an init function and addEventListener, as follows:

addEventListener('hawksearch:loaded', () => {
	HawkSearch.init({
    clientId: 'xxxxxxxxxxxxxxxxxx'
    ...
  });
});

So for the following implementations, v5 would look like this:

<!-- v5 -->
<script type="text/javascript">
  var HawkSearch = HawkSearch || {};

  HawkSearch.config = {
    clientId: 'xxxxxxxxxxxxxxxxxx',
    search: {
      url: ''
    },
    autocomplete: {
      recommendationsEnabled: true
    },
    urlPrefixes: {
      assets: '//dev.hawksearch.net',
      content: '//preview-dev.hawksearch.net/elasticdemo'
    }
  };
</script>

Becomes like this on v6:

<script type="text/javascript">
  addEventListener('hawksearch:loaded', () => {
    HawkSearch.init({
      clientId: 'xxxxxxxxxxxxxxxxxx',
      search: {
        url: ''
      },
      urlPrefixes: {
        assets: '//dev.hawksearch.net',
        content: '//preview-dev.hawksearch.net/elasticdemo'
      }
    });
  });
</script>