@liquidcommerce/elements-sdk 2.5.1 → 2.5.2-beta.2
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 +206 -0
- package/dist/index.esm.js +9169 -9169
- package/docs/CONFIGURATION.md +94 -0
- package/docs/DOCUMENTATION_INDEX.md +1 -0
- package/package.json +1 -1
- package/umd/elements.js +1 -1
package/docs/CONFIGURATION.md
CHANGED
|
@@ -494,6 +494,100 @@ data-product-2="00832889005513"
|
|
|
494
494
|
<div data-lce-product="00832889005513"></div>
|
|
495
495
|
```
|
|
496
496
|
|
|
497
|
+
### Product List Configuration
|
|
498
|
+
|
|
499
|
+
```html
|
|
500
|
+
<div data-liquid-commerce-elements-products-list
|
|
501
|
+
data-card="standard"
|
|
502
|
+
data-rows="3"
|
|
503
|
+
data-columns="4"
|
|
504
|
+
data-card-fill
|
|
505
|
+
data-filters="personalization,pre-order,delivery-options"
|
|
506
|
+
data-product-url="/product/{upc}">
|
|
507
|
+
</div>
|
|
508
|
+
```
|
|
509
|
+
|
|
510
|
+
**Attributes:**
|
|
511
|
+
|
|
512
|
+
##### `data-liquid-commerce-elements-products-list`
|
|
513
|
+
|
|
514
|
+
**Type:** flag (no value)
|
|
515
|
+
|
|
516
|
+
Enables product list on this div element.
|
|
517
|
+
|
|
518
|
+
##### `data-card`
|
|
519
|
+
|
|
520
|
+
**Type:** `'standard'`
|
|
521
|
+
**Default:** `'standard'`
|
|
522
|
+
|
|
523
|
+
Card variant style.
|
|
524
|
+
|
|
525
|
+
```html
|
|
526
|
+
data-card="standard"
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
##### `data-rows`
|
|
530
|
+
|
|
531
|
+
**Type:** `number`
|
|
532
|
+
**Default:** `3`
|
|
533
|
+
|
|
534
|
+
Number of rows to display per page.
|
|
535
|
+
|
|
536
|
+
```html
|
|
537
|
+
data-rows="4"
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
##### `data-columns`
|
|
541
|
+
|
|
542
|
+
**Type:** `number`
|
|
543
|
+
**Default:** `4`
|
|
544
|
+
|
|
545
|
+
Number of columns in the grid.
|
|
546
|
+
|
|
547
|
+
```html
|
|
548
|
+
data-columns="4"
|
|
549
|
+
```
|
|
550
|
+
|
|
551
|
+
##### `data-card-fill`
|
|
552
|
+
|
|
553
|
+
**Type:** flag (no value)
|
|
554
|
+
|
|
555
|
+
Whether cards should fill the whole card with white background color to match the image background color.
|
|
556
|
+
|
|
557
|
+
```html
|
|
558
|
+
data-card-fill
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
##### `data-filters`
|
|
562
|
+
|
|
563
|
+
**Type:** `string` (comma-separated)
|
|
564
|
+
|
|
565
|
+
Filter types to enable: `personalization`, `pre-order`, `delivery-options`.
|
|
566
|
+
|
|
567
|
+
```html
|
|
568
|
+
data-filters="personalization,pre-order,delivery-options"
|
|
569
|
+
```
|
|
570
|
+
|
|
571
|
+
**Available filters:**
|
|
572
|
+
- `personalization` - Show filter for personalized/engravable products
|
|
573
|
+
- `pre-order` - Show filter for pre-order products
|
|
574
|
+
- `delivery-options` - Show filter for delivery type (all, shipping, onDemand)
|
|
575
|
+
|
|
576
|
+
##### `data-product-url`
|
|
577
|
+
|
|
578
|
+
**Type:** `string`
|
|
579
|
+
|
|
580
|
+
Product detail page URL template. Use `{upc}` or `{grouping}` placeholder.
|
|
581
|
+
|
|
582
|
+
```html
|
|
583
|
+
data-product-url="/product/{upc}"
|
|
584
|
+
data-product-url="/products/{grouping}"
|
|
585
|
+
```
|
|
586
|
+
|
|
587
|
+
**Placeholders:**
|
|
588
|
+
- `{upc}` - Replaced with product UPC
|
|
589
|
+
- `{grouping}` - Replaced with Salsify grouping ID
|
|
590
|
+
|
|
497
591
|
### URL Parameter Configuration
|
|
498
592
|
|
|
499
593
|
#### `data-product-param`
|
|
@@ -237,6 +237,7 @@ docs/
|
|
|
237
237
|
|
|
238
238
|
### Features
|
|
239
239
|
- [Product Engraving](../README.md#product-engraving)
|
|
240
|
+
- [Product List](../README.md#product-list)
|
|
240
241
|
- [Gift Options](../README.md#gift-options)
|
|
241
242
|
- [Promo Codes](../README.md#promo-codes)
|
|
242
243
|
- [Gift Cards](../README.md#gift-cards)
|
package/package.json
CHANGED