Start using Sledge and Webflow

Prior using all Sledge's widgets, follow the steps below to start integrating Sledge into your Webflow storefront.

Quickstart

Setup Sledge Core

First, copy this code and paste it later inside the <head> tag

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/@sledge-app/js@latest/dist/style.css"
/>
 
<script
  type="module"
  data-api-key=""
  data-instant-search-api-key=""
  data-user-id=""
  data-user-email=""
  data-user-fullname=""
  id="sledge-embed-script"
  src="https://cdn.jsdelivr.net/npm/@sledge-app/js@latest/dist/sledge.min.js"
></script>

sledge-embed-script Parameters

Let's look on list of all available parameters:


ParameterTypeDescription
data-api-keystring (required)

To get the `data-api-key`, go to :
Shopify Admin › Apps › Sledge › General › API Key › API Key.

See Backend for more information.

data-instant-search-api-keystring (required)

To get the `data-instant-search-api-key`, go to :
Shopify Admin › Apps › Sledge › General › API Key ›
Instant Search Key.

See Backend for more information.

data-user-idnumber

Fill with your own user logined data,
You can check out here

data-user-emailstring

Fill with your own user logined data,
You can check out here

data-user-fullnamestring

Fill with your own user logined data,
You can check out here

Place embed code above to your project

You can paste it inside <head> tag

sledge-image-docs

Create a element

Example below using Div Block

sledge-image-docssledge-image-docs

Implement widget

You can use a sledge's widget by add the attribute into your element

sledge-image-docssledge-image-docs

Or you can place this code in custom code webflow, see the documentation about custom code embed at webflow

<div
  data-component="instant-search-product-filter-widget"
  data-query-keyword="q"
  data-collection-id=""
  data-collection-name=""
></div>

instant-search-product-filter-widget Parameters

Let's look on list of all available parameters:


ParameterTypeDescription
data-query-keywordstring

Fill up your unique data-query-keyword.
e.g: https://your-online-store.com/collection/all?q=hoodie

Default: q

data-collection-idnumber (required)

Fill with your own collection id,
You can check out here

data-collection-namestring (required)

Fill with your own collection name,
You can check out here

Widget completely running

Sledge's product filters widget is now ready to be used.

sledge-image-docs

Learn more

Congratulations! Now that the installation is complete, you can use all Sledge's widgets and start integrating to your Webflow storefront.