@bikematrix/web-components 1.0.15 → 1.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -6
- package/dist/bm_core.es.js +743 -705
- package/dist/bm_core.js +7 -6
- package/dist/bm_core.umd.js +7 -6
- package/dist/types/bm_core.es.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -39,8 +39,8 @@ Alternatively, include the script directly in your HTML:
|
|
|
39
39
|
|
|
40
40
|
```html
|
|
41
41
|
<script
|
|
42
|
-
type="
|
|
43
|
-
src="https://cdn.jsdelivr.net/npm/@bikematrix/web-components"
|
|
42
|
+
type="text/javascript"
|
|
43
|
+
src="https://cdn.jsdelivr.net/npm/@bikematrix/web-components/dist/bm_core.js"
|
|
44
44
|
></script>
|
|
45
45
|
```
|
|
46
46
|
|
|
@@ -70,8 +70,8 @@ Include the script directly in your HTML:
|
|
|
70
70
|
|
|
71
71
|
```html
|
|
72
72
|
<script
|
|
73
|
-
type="
|
|
74
|
-
src="https://cdn.jsdelivr.net/npm/@bikematrix/web-components"
|
|
73
|
+
type="text/javascript"
|
|
74
|
+
src="https://cdn.jsdelivr.net/npm/@bikematrix/web-components/dist/bm_core.js"
|
|
75
75
|
></script>
|
|
76
76
|
```
|
|
77
77
|
|
|
@@ -82,7 +82,8 @@ Add the core configuration block to your HTML:
|
|
|
82
82
|
```html
|
|
83
83
|
<script type="application/json" data-bikematrix-config>
|
|
84
84
|
{
|
|
85
|
-
"apiUrl": "
|
|
85
|
+
"apiUrl": "https://api-staging.bikematrix.io/bike/v2/",
|
|
86
|
+
"apiKey": "YOUR_API_KEY",
|
|
86
87
|
"pageType": "collection",
|
|
87
88
|
"currentCollectionHandle": "brake-pads",
|
|
88
89
|
"collections": [
|
|
@@ -154,7 +155,8 @@ BikeMatrix is configured using a JSON configuration block in your HTML:
|
|
|
154
155
|
```html
|
|
155
156
|
<script type="application/json" data-bikematrix-config>
|
|
156
157
|
{
|
|
157
|
-
"apiUrl": "
|
|
158
|
+
"apiUrl": "https://api-staging.bikematrix.io/bike/v2/",
|
|
159
|
+
"apiKey": "YOUR_API_KEY",
|
|
158
160
|
"pageType": "collection",
|
|
159
161
|
"currentCollectionHandle": "brake-pads",
|
|
160
162
|
"collections": [
|
|
@@ -186,6 +188,7 @@ Configuration options for BikeMatrix components, organized by feature area.
|
|
|
186
188
|
| Option | Type | Default | Description |
|
|
187
189
|
| ------------------------- | ----------------------------------------------------------- | ------------ | ------------------------------------------------ |
|
|
188
190
|
| `apiUrl` | string | _(Required)_ | Your BikeMatrix API endpoint URL |
|
|
191
|
+
| `apiKey` | string | _(Required)_ | Your BikeMatrix API key |
|
|
189
192
|
| `pageType` | "collection" \| "product" \| "index" \| "search" | "index" | Current page type |
|
|
190
193
|
| `currentCollectionHandle` | string | "" | Handle of the current collection |
|
|
191
194
|
| `collections` | Array<{title: string, handle: string, url: string}> | [] | List of available collections with their details |
|