@ideal-postcodes/bigcommerce

Ideal Postcodes BigCommerce bindings

Usage no npm install needed!

<script type="module">
  import idealPostcodesBigcommerce from 'https://cdn.skypack.dev/@ideal-postcodes/bigcommerce';
</script>

README

Ideal Postcodes BigCommerce Integration

Add UK address search and validation to BigCommerce address forms

Dependency Status Release CI npm version

@ideal-postcodes/bigcommerce builds the integration code to enable UK address search and validation on BigCommerce address forms.

For installation, feature list and configuration see our guide.

BigCommerce introduced a breaking change? Contact support.

Links

Configuration Options

Upon loading, the script will exit unless a global configuration object (idpcConfig) is detected.

<script>
  window.idpcConfig = {
    apiKey: "iddqd",
  };
</script>

A list of configuration options can be found in our guide.

Screenshots

Address Autocomplete

Activate address autocompletion on your address collection forms.

Address Autocomplete

Postcode Lookup

Enable Postcode Lookup on your address collection forms.

Postcode Lookup

Test

# Build JavaScript bundle
npm run build

# Run Cypress test suite with API Key
CYPRESS_API_KEY='key' npm test