Skip to content

Commit 4aebdc2

Browse files
🤖 Sync Liquid Docs Schema
1 parent a7d9fd1 commit 4aebdc2

File tree

3 files changed

+70
-18
lines changed

3 files changed

+70
-18
lines changed

‎data/filters.json

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4965,6 +4965,46 @@
49654965
"syntax": "number | pluralize: string, string",
49664966
"name": "pluralize"
49674967
},
4968+
{
4969+
"category": "format",
4970+
"deprecated": false,
4971+
"deprecation_reason": "",
4972+
"description": "",
4973+
"parameters": [],
4974+
"return_type": [
4975+
{
4976+
"type": "string",
4977+
"name": "",
4978+
"description": "",
4979+
"array_value": ""
4980+
}
4981+
],
4982+
"examples": [
4983+
{
4984+
"name": "",
4985+
"description": "",
4986+
"syntax": "",
4987+
"path": "/products/blue-mountain-flower",
4988+
"raw_liquid": "{%- assign variant = product.variants.first -%}\n\n{{ variant.unit_price | unit_price_with_measurement: variant.unit_price_measurement }}",
4989+
"parameter": false,
4990+
"display_type": "text",
4991+
"show_data_tab": true
4992+
},
4993+
{
4994+
"name": "Formatted unit price",
4995+
"description": "You can specify a formatted unit price using one of the [money filters](/docs/api/liquid/filters/payment_button#money-filters).",
4996+
"syntax": "string | unit_price_with_measurement: unit_price_measurement",
4997+
"path": "/products/blue-mountain-flower",
4998+
"raw_liquid": "{%- assign variant = product.variants.first -%}\n\n{{ variant.unit_price | money_with_currency | unit_price_with_measurement: variant.unit_price_measurement }}",
4999+
"parameter": true,
5000+
"display_type": "text",
5001+
"show_data_tab": true
5002+
}
5003+
],
5004+
"summary": "Formats a given unit price and measurement based on the store's [**HTML without currency** setting](https://help.shopify.com/manual/payments/currency-formatting).",
5005+
"syntax": "number | unit_price_with_measurement: unit_price_measurement",
5006+
"name": "unit_price_with_measurement"
5007+
},
49685008
{
49695009
"category": "media",
49705010
"deprecated": true,

‎data/objects.json

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7264,7 +7264,7 @@
72647264
{
72657265
"deprecated": false,
72667266
"deprecation_reason": "",
7267-
"description": "> Note:\n> Unit prices are available only to stores located in Germany or France.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).",
7267+
"description": "> Note:\n> Unit prices are available only to stores located in the European Union or Switzerland.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).\n\n> Tip:\n> Use the [`unit_price_with_measurement` filter](/docs/api/liquid/filters/unit_price_with_measurement) with the\n> `line_item.unit_price` property and this property to output a formatted unit price with measurement.",
72687268
"examples": [],
72697269
"return_type": [
72707270
{
@@ -7280,7 +7280,7 @@
72807280
{
72817281
"deprecated": false,
72827282
"deprecation_reason": "",
7283-
"description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Note:\n> Unit prices are available only to stores located in Germany and France.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
7283+
"description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Note:\n> Unit prices are available only to stores located in the European Union or Switzerland.\n\n> Tip:\n> Use the [`unit_price_with_measurement` filter](/docs/api/liquid/filters/unit_price_with_measurement) with this\n> property and the `line_item.unit_price_measurement` property to output a formatted unit price with measurement.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).",
72847284
"examples": [],
72857285
"return_type": [
72867286
{
@@ -7290,7 +7290,7 @@
72907290
"array_value": ""
72917291
}
72927292
],
7293-
"summary": "The [unit price](https://help.shopify.com/manual/intro-to-shopify/initial-setup/sell-in-france/price-per-unit#add-unit-prices-to-your-product)\n of the line item in the currency's subunit.",
7293+
"summary": "The [unit price](https://help.shopify.com/manual/products/details/product-pricing/unit-pricing#add-unit-prices-to-your-product)\n of the line item in the currency's subunit.",
72947294
"name": "unit_price"
72957295
},
72967296
{
@@ -10684,7 +10684,7 @@
1068410684
{
1068510685
"deprecated": false,
1068610686
"deprecation_reason": "",
10687-
"description": "",
10687+
"description": "Limited to 250.",
1068810688
"examples": [],
1068910689
"return_type": [
1069010690
{
@@ -10700,7 +10700,7 @@
1070010700
{
1070110701
"deprecated": false,
1070210702
"deprecation_reason": "",
10703-
"description": "For example, if you show 5 items per page and are on page 3, then the value of `paginate.current_offset` is 10.",
10703+
"description": "For example, if you show 5 items per page and are on page 3, then the value of `paginate.current_offset` is 10.\n\nLimited to 24,999 see [Pagination Limits](/themes/best-practices/performance/platform#pagination-limits) for more information.",
1070410704
"examples": [],
1070510705
"return_type": [
1070610706
{
@@ -10716,7 +10716,7 @@
1071610716
{
1071710717
"deprecated": false,
1071810718
"deprecation_reason": "",
10719-
"description": "",
10719+
"description": "Limited to 25,000 see [Pagination Limits](/themes/best-practices/performance/platform#pagination-limits) for more information.",
1072010720
"examples": [],
1072110721
"return_type": [
1072210722
{
@@ -10732,7 +10732,7 @@
1073210732
{
1073310733
"deprecated": false,
1073410734
"deprecation_reason": "",
10735-
"description": "For example, if you paginate a collection of 120 products, then the value of `paginate.items` is 120.",
10735+
"description": "For example, if you paginate a collection of 120 products, then the value of `paginate.items` is 120.\n\nLimited to 25,000 see [Pagination Limits](/themes/best-practices/performance/platform#pagination-limits) for more information.",
1073610736
"examples": [],
1073710737
"return_type": [
1073810738
{
@@ -10796,7 +10796,7 @@
1079610796
{
1079710797
"deprecated": false,
1079810798
"deprecation_reason": "",
10799-
"description": "",
10799+
"description": "Limited to 25,000 see [Pagination Limits](/themes/best-practices/performance/platform#pagination-limits) for more information.",
1080010800
"examples": [],
1080110801
"return_type": [
1080210802
{
@@ -12543,7 +12543,7 @@
1254312543
{
1254412544
"deprecated": false,
1254512545
"deprecation_reason": "",
12546-
"description": "> Note:\n> Unit prices are available only to stores located in Germany and France.",
12546+
"description": "> Note:\n> Unit prices are available only to stores located in the European Union or Switzerland.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).\n\n> Tip:\n> Use the [`unit_price_with_measurement` filter](/docs/api/liquid/filters/unit_price_with_measurement) with the\n> `variant.unit_price` property and this property to output a formatted unit price with measurement.",
1254712547
"examples": [],
1254812548
"return_type": [
1254912549
{
@@ -12559,7 +12559,7 @@
1255912559
{
1256012560
"deprecated": false,
1256112561
"deprecation_reason": "",
12562-
"description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Note:\n> Unit prices are available only to stores located in Germany and France.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
12562+
"description": "The price reflects any discounts that are applied to the line item. The value is output in the customer's local\n(presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Note:\n> Unit prices are available only to stores located in the European Union or Switzerland.\n\n> Tip:\n> Use the [`unit_price_with_measurement` filter](/docs/api/liquid/filters/unit_price_with_measurement) with this\n> property and the `variant.unit_price_measurement` property to output a formatted unit price with measurement.\n\nTo learn about how to display unit prices in your theme, refer to [Unit pricing](/themes/pricing-payments/unit-pricing).",
1256312563
"examples": [],
1256412564
"return_type": [
1256512565
{
@@ -12569,7 +12569,7 @@
1256912569
"array_value": ""
1257012570
}
1257112571
],
12572-
"summary": "The [unit price](https://help.shopify.com/manual/intro-to-shopify/initial-setup/sell-in-france/price-per-unit#add-unit-prices-to-your-product)\nof the variant in the currency's subunit.",
12572+
"summary": "The [unit price](https://help.shopify.com/manual/products/details/product-pricing/unit-pricing#add-unit-prices-to-your-product)\nof the variant in the currency's subunit.",
1257312573
"name": "unit_price"
1257412574
},
1257512575
{
@@ -16901,7 +16901,7 @@
1690116901
},
1690216902
"deprecated": false,
1690316903
"deprecation_reason": "",
16904-
"description": "> Note:\n> Unit prices are available only to stores located in Germany and France.",
16904+
"description": "> Note:\n> Unit prices are available only to stores located in the European Union or Switzerland.",
1690516905
"properties": [
1690616906
{
1690716907
"deprecated": false,
@@ -16923,7 +16923,19 @@
1692316923
},
1692416924
{
1692516925
"type": "string",
16926-
"name": "dimension",
16926+
"name": "length",
16927+
"description": "",
16928+
"array_value": ""
16929+
},
16930+
{
16931+
"type": "string",
16932+
"name": "area",
16933+
"description": "",
16934+
"array_value": ""
16935+
},
16936+
{
16937+
"type": "string",
16938+
"name": "count",
1692716939
"description": "",
1692816940
"array_value": ""
1692916941
}
@@ -16996,7 +17008,7 @@
1699617008
"name": "reference_unit"
1699717009
}
1699817010
],
16999-
"summary": "Information about how units of a product variant are measured. It's used to calculate\n[unit prices](https://help.shopify.com/manual/intro-to-shopify/initial-setup/sell-in-france/price-per-unit#add-unit-prices-to-your-product).",
17011+
"summary": "Information about how units of a product variant are measured. It's used to calculate\n[unit prices](https://help.shopify.com/manual/products/details/product-pricing/unit-pricing#add-unit-prices-to-your-product).",
1700017012
"name": "unit_price_measurement",
1700117013
"examples": [],
1700217014
"json_data": {

‎data/tags.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1008,15 +1008,15 @@
10081008
],
10091009
"summary": "Splits an array's items across multiple pages.",
10101010
"name": "paginate",
1011-
"syntax": "{% paginate array by page_size %}\n {% for item in array %}\n forloop_content\n {% endfor %}\n{% endpaginate %}",
1011+
"syntax": "{% paginate array by page_size %}\n {% for item in array %}\n forloop_content\n {% endfor %}\n{% endpaginate %}\n\nThe `paginate` tag allows the user to paginate to the 25,000'nth item in the array an no further. To reach items further in\nthe array the array should be filtered further before paginating. See\n[Pagination Limits](/themes/best-practices/performance/platform#pagination-limits) for more information.",
10121012
"syntax_keywords": [
10131013
{
10141014
"keyword": "array",
10151015
"description": "The array to be looped over."
10161016
},
10171017
{
10181018
"keyword": "page_size",
1019-
"description": "The number of array items to include per page, between 1 and 50."
1019+
"description": "The number of array items to include per page, between 1 and 250."
10201020
},
10211021
{
10221022
"keyword": "item",
@@ -1050,10 +1050,10 @@
10501050
},
10511051
{
10521052
"name": "Limit data fetching",
1053-
"description": "Limiting the number of iterations through an array with the `paginate` tag can be more performant than using the [`limit` parameter](/docs/api/liquid/tags/for#for-limit) of the `for` tag. The `limit` parameter sets the number of iterations executed, but not the amount of information fetched server-side.\n\nFor example, referencing `collection.products` will fetch information up to the first 50 products, regardless of the forloop's `limit` parameter. Use `paginate` and set a `page_size` to limit the amount of data fetched, and opt not to display any pagination controls.\n",
1053+
"description": "The [`limit` parameter](/docs/api/liquid/tags/for#for-limit) of the `for` tag controls the number of iterations, but not the amount of information fetched. Using the `paginate` tag with a matching `page_size` can reduce the data queried, leading to faster server response times. \n\nFor example, referencing `collection.products` will fetch up to 50 products by default, regardless of the forloop's `limit` parameter. Use `paginate` and set a `page_size` to limit the amount of data fetched, and opt not to display any pagination controls.\n\nMore data than requested in a specific section may be returned. Because of this, make sure to include both `paginate` and `limit` when using this technique.\n",
10541054
"syntax": "",
10551055
"path": "/collections/all",
1056-
"raw_liquid": "{% paginate collection.products by 4 %}\n {% for product in collection.products -%}\n {{ product.title }}\n {%- endfor %}\n{% endpaginate -%}\n\n<!-- Less performant method -->\n{% for product in collection.products limit: 4 -%}\n {{ product.title }}\n{%- endfor -%}",
1056+
"raw_liquid": "{% paginate collection.products by 4 %}\n {% for product in collection.products limit: 4 -%}\n {{ product.title }}\n {%- endfor %}\n{% endpaginate -%}\n\n<!-- Less performant method -->\n{% for product in collection.products limit: 4 -%}\n {{ product.title }}\n{%- endfor -%}",
10571057
"parameter": false,
10581058
"display_type": "text",
10591059
"show_data_tab": true

0 commit comments

Comments
 (0)