Skip to main content

v5.0 Upgrade Guide

The following changes may be required for upgrading to v5.0.

Estimated Time to Upgrade: 0-2 hours

1 - Removed and Updated Dependencies​

Further to our previous work to optimise for performance and mobile devices, some additional dependencies have now been removed. This will reduce the amount of javascript and css required for BidJS to function on your site (by roughly 33%), particularly impacting mobile customers, as well as positively affecting Search Engine Optimisation results.

Please note the changed filenames for both the CSS and Javascript dependencies.

Previous (v4)
<script>
  window.bidjs = { ... } // your BidJS config goes here
</script>
<script defer src="<<APPLICATION_URL>>/static/<<VERSION>>/js/bid-dependencies.min.js"></script>
<script defer src="<<APPLICATION_URL>>/static/<<VERSION>>/js/hbs-bid.min.js"></script>
<script defer src="<<APPLICATION_URL>>/static/<<VERSION>>/js/bid.min.js"></script>
<script defer src="https://static.bidjs.com/<<VERSION>>/bootstrap3/js/bidjs-modules.chunk.js"></script>
<noscript><link href="<<APPLICATION_URL>>/static/<<VERSION>>/css/bid.min.css" rel="stylesheet" type="text/css"></noscript>
<link rel="preload" href="<<APPLICATION_URL>>/static/<<VERSION>>/css/bid.min.css" as="style" onload="this.onload=null;this.rel='stylesheet'">
Upgraded (v5)
<script>
  window.bidjs = { ... } // your BidJS config goes here
</script>
<script defer src="https://static.bidjs.com/<<VERSION>>/bootstrap3/js/bidjs.min.js"></script>
<noscript><link href="https://static.bidjs.com/<<VERSION>>/bootstrap3/css/bidjs--full.min.css" rel="stylesheet" type="text/css"></noscript>
<link rel="preload" href="https://static.bidjs.com/<<VERSION>>/bootstrap3/css/bidjs--full.min.css" as="style" onload="this.onload=null;this.rel='stylesheet'">

2 - Updated HTML Snippet​

Along with the previously mentioned dependency pruning, some associated HTML is no longer required.

Previous (v4)
<div class="container">
  <div id="bidlogix-app" class="bidlogix-app bidjs-app">
  </div>
</div>

<div class="bidlogix-app bidjs-app">
  <div id="bidlogix-modal"></div>
</div>

<div class="container bidlogix-app">
  <div id="bidjs" class="bidjs-app"></div>
</div>
Upgraded (v5)
<div class="bidlogix-app bidjs-app">
  <div id="bidlogix-modal"></div>
</div>

<div class="container bidlogix-app">
  <div id="bidjs" class="bidjs-app"></div>
</div>

3 - Navigation Removals​

Any navigation items on your site that refer to the BidJS search or myBids will no longer function.

The Search page has been replaced by a new component that can be placed anywhere on your site, even on pages without the rest of BidJS! As such, any navigation items or links to the existing #!/search page should be removed.

Please see the Search documentation for more information.

My Bids​

The functionality provided by "My Bids" has now been replaced with the filtering and starring options available at the auction level. This functionality has been implemented throughout the v4.x releases, and v5 officially removes the My Bids page.

Therefore, any navigation items or links to the existing #!/myBids page should be removed.

4 - Marketplace Update​

V5 marks the final phase in converting our legacy BidJS application to our "modules" architecture, improving performance and compatibility. The Marketplace is the final page to receive this treatment.

If you have any custom styles associated with Marketplace, they can now likely be removed. The Marketplace will now share the same structure and styles as Webcast Pre-bidding and Timed Auctions (e.g. the /#!/auctions/ layout).