@okendo/shopify-hydrogen 0.0.4 → 0.0.5
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 +21 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -48,7 +48,9 @@ The purpose of this documentation is to guide you on the following:
|
|
|
48
48
|
|
|
49
49
|
<br/>
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
<a name="configurehydrogenapp"></a>
|
|
52
|
+
|
|
53
|
+
## 1. Configure Hydrogen app config
|
|
52
54
|
|
|
53
55
|
1. Open **hydrogen.config.js** in your project.
|
|
54
56
|
2. Make the following changes and save the file:
|
|
@@ -57,7 +59,9 @@ The purpose of this documentation is to guide you on the following:
|
|
|
57
59
|
|
|
58
60
|
<br/>
|
|
59
61
|
|
|
60
|
-
|
|
62
|
+
<a name="exposemetafields"></a>
|
|
63
|
+
|
|
64
|
+
## 2. Expose Shopify Metafields
|
|
61
65
|
|
|
62
66
|
Okendo Reviews utilise Product and Shop specific [metafields](https://shopify.dev/api/examples/metafields) in order to function and provide a seamless user experience. You will need to expose these metafields so that they can be retrieved by your Hydrogen app.
|
|
63
67
|
|
|
@@ -289,10 +293,12 @@ mutation {
|
|
|
289
293
|
[https://shopify.dev/api/examples/metafields#step-1-expose-metafields](https://shopify.dev/api/examples/metafields#step-1-expose-metafields)
|
|
290
294
|
[https://shopify.dev/api/admin-graphql/2022-04/mutations/metafieldstorefrontvisibilitycreate](https://shopify.dev/api/admin-graphql/2022-04/mutations/metafieldstorefrontvisibilitycreate)
|
|
291
295
|
</details>
|
|
292
|
-
<br/>
|
|
293
|
-
<br/>
|
|
294
296
|
|
|
295
|
-
|
|
297
|
+
<br/><br/>
|
|
298
|
+
|
|
299
|
+
<a name="okendohydrogencomponentsusage"></a>
|
|
300
|
+
|
|
301
|
+
## 3. How to Use Okendo Hydrogen Components In Your Hydrogen App
|
|
296
302
|
|
|
297
303
|
### Installation
|
|
298
304
|
|
|
@@ -329,7 +335,7 @@ mutation {
|
|
|
329
335
|
return (
|
|
330
336
|
<Suspense fallback={<LoadingFallback />}>
|
|
331
337
|
<ShopifyProvider>
|
|
332
|
-
|
|
338
|
+
<!-- *** Include OkendoProvider HERE *** -->
|
|
333
339
|
<OkendoProvider subscriberId={okendo_subscriber_id} />
|
|
334
340
|
<ServerCartProvider>
|
|
335
341
|
<DefaultSeo />
|
|
@@ -367,7 +373,9 @@ const okendoStarRating = <OkendoStarRating productId={product.id} />;
|
|
|
367
373
|
|
|
368
374
|
---
|
|
369
375
|
|
|
370
|
-
|
|
376
|
+
<a name="componentprops"></a>
|
|
377
|
+
|
|
378
|
+
## Component Props
|
|
371
379
|
|
|
372
380
|
<br/>
|
|
373
381
|
|
|
@@ -402,7 +410,9 @@ const okendoStarRating = <OkendoStarRating productId={product.id} />;
|
|
|
402
410
|
|
|
403
411
|
<br/>
|
|
404
412
|
|
|
405
|
-
|
|
413
|
+
<a name="npmdefinitions"></a>
|
|
414
|
+
|
|
415
|
+
## NPM Component Definitions
|
|
406
416
|
|
|
407
417
|
### OkendoProvider.server
|
|
408
418
|
|
|
@@ -436,7 +446,9 @@ This is the server-side rendered Reviews List widget - It then invokes the clien
|
|
|
436
446
|
|
|
437
447
|
<br/>
|
|
438
448
|
|
|
439
|
-
|
|
449
|
+
<a name="learnmore"></a>
|
|
450
|
+
|
|
451
|
+
## View Our Okendo Sample Hydrogen App
|
|
440
452
|
|
|
441
453
|
We have created a Shopify Hydrogen sample application with our widgets pre-installed.
|
|
442
454
|
|