As parts of BidJS are migrated to modules, the list of modules here will grow. Each module has 3 possible values:
- true - the module should be loaded on this page, in the modules container when the URL matches the module name
- false - the module is disabled, and any links / references to this module should not display
- "url" - the location where this module is hosted. If on the same page in the traditional BidJS application, this should be the "hashbang" URL. If on another page, it should be the address of the relevant page.
See the list of Current Modules below, as reference. This list will expand as more pages are migrated to modules.
|auctionsArchived||Archived Auctions||Displays a searchable list of all archived auctions for all your auctioneers|
|mySales||My Sales||Displays a history of sales per auction to your lot vendors|
|invoices||Invoices||Displays invoices to users|
|webcast||Webcast||Newly designed modular webcast view|
|analyticsCode||The Google Analytics UA tracking code on which you wish for BidJS pageviews to be recorded||false||1.1+|
|analyticsNamespace||If your Google Analytics has already been initialised on your parent website and it has a specific namespace, you can specify that here to prevent conflicts. This is unlikely to be required in most situations.||false||1.1+|
The name of the module to be loaded at the "base url" of the current page.
If using modules on a page with the main BidJS application, then this is likely to be "empty".
If you are using modules on an independent page, you can specify which the default should be, e.g. "auctionsArchived"
|standalone||Defines whether BidJS Modules are on their own page, i.e. "true", or whether they are featured on a page where BidJS is already embedded, i.e. "false".||false||false||1.0+|
Should be either "hash" or "pushState".
Using "hash" will cause your module URLs to look like www.yourwebsite.com/yourpage#!/moduleKey
Using "pushState" will cause your module URLs to look like www.yourwebsite.com/yourpage/moduleKey
Will display an alert to users of Internet Explorer 11 and below with this content.
This should only be used if Modules are used on a separate page to BidJS, as BidJS will already display a message.
This implements the first BidJS Module, a new concept which is covered in detail within the Technical Documentation
The module implemented is: Archived Auctions
No change is necessary for clients unless they implement this or future modules, in which case the documentation should be followed.