Options

We provide several options for the customisation of the BidJS functionality.

info

All options are defined within the BidJS configuration you added in the installation process.

General Behaviour

Custom Scroll Position on navigation

Some of our customers prefer the page to scroll to a certain position as the user navigates.

By default, BidJS will scroll to the top of the BidJS container on navigation between the different BidJS pages.

Should you wish to adjust this, you can pass in the ID of any element on your site, which you wish the page to scroll to. E.g. if your navigation has an ID of #main-navigation and you wish to scroll to this, the following configuration may be applied

window.bidjs = {
config: {
...
},
modules: {
...
},
options: {
scrollOnNavigationElementId: 'main-navigation'
}
}

Image Display Options

It's possible to customise how imagery is displayed on your BidJS installation.

Cropping

You are able to change how images are cropped / resized

window.bidjs = {
config: {
...
},
modules: {
...
},
options: {
imageCropMode: 'fill'
}
}

Available options:

  • fill - The image fills the space, and crops any part of the image which won't fit in this space
  • fit - The image fills the space as much as possible without any cropping. This will mean images could appear inconsistently sized when next to each other
  • pad - (Default) Similar to fit, the image fills the space as much as possible. However, any empty space is "padded" with colour, to ensure all images are sized consistently.
  • scale - Stretches / squashes the image to fit

Note that with pad you are also able to define the padColor, as below:

window.bidjs = {
config: {
...
},
modules: {
...
},
options: {
imageCropMode: 'pad',
padColor: 'rgb:3c3c3c'
}
}

Unsupported Browser Message

By default, we display the following message to unsupported browsers

Your browser is not supported. Please use a browser such as Google Chrome or Microsoft Edge to ensure full functionality

Should you wish, you can adjust this by adding the following

window.bidjs = {
config: {
...
},
modules: {
...
},
options: {
unsupportedBrowserMessage: 'Please use a newer browser'
}
}

SEO

Dynamic Page Title & Meta Description

BidJS can update the page title and meta descriptions dynamically, if you allow it.

This is recommended, and may result in your items being ranked higher with Google Search results.

window.bidjs = {
config: {
...
},
modules: {
...
},
options: {
allowMetaDescriptionChange: true,
allowTitleChange: true
}
}

Google Analytics Tracking

If you have Google Analytics on your site, you can plug this in, to pass more information on BidJS usage to your analytics account.

window.bidjs = {
config: {
...
},
modules: {
...
},
options: {
analyticsCode: 'UA-1234567-1'
}
}

If you've initialised Google Analytics with a custom namespace, you can also pass this in

window.bidjs = {
config: {
...
},
modules: {
...
},
options: {
analyticsCode: 'UA-1234567-1',
analyticsNamespace: 'myCustomGANamespace'
}
}

Webcast Functionality

Video-Centric Webcast View

Some webcast auctioneers use the video as their primary way of displaying the listings.

In this case, it can be useful to enable this option, to prioritise the webcast video over the listing imagery.

window.bidjs = {
config: {
...
},
modules: {
...
},
options: {
isWebcastVideoCentric: true
}
}

Here is an example of this view alt text