iwgt 2.3.0

package/dist/data/references/liquid-filters.json

@@ -0,0 +1,497 @@
+{
+    "meta": {
+        "source": "filters.html",
+        "description": "Liquid фильтры InSales",
+        "totalCategories": 7,
+        "totalFilters": 53,
+        "generatedAt": "2025-10-07T06:52:19.502Z"
+    },
+    "categories": [
+        {
+            "id": "collection--filtry-dlya-massivov",
+            "name": "Фильтры для массивов",
+            "description": "",
+            "filters": [
+                {
+                    "id": "size",
+                    "name": "size",
+                    "description": "Возвращает длинну массива",
+                    "parameters": [],
+                    "example": "{% assign string = 'wooden, deepsnow, season2006' %}{% assign array = string | split: ', ' | reverse %}{{ array | size }}#=> 3"
+                },
+                {
+                    "id": "first",
+                    "name": "first",
+                    "description": "Фильтр возвращает первый элемент из массива",
+                    "parameters": [
+                        "%"
+                    ],
+                    "example": "{% assign string = 'wooden, deepsnow, season2006' %}{% assign array = string | split: ', '%}{{ array | first }}#=> wooden"
+                },
+                {
+                    "id": "last",
+                    "name": "last",
+                    "description": "Фильтр возвращает последний элемент из массива",
+                    "parameters": [
+                        "%"
+                    ],
+                    "example": "{% assign string = 'wooden, deepsnow, season2006' %}{% assign array = string | split: ', '%}{{ array | last }}#=> season2006"
+                },
+                {
+                    "id": "split",
+                    "name": "split",
+                    "description": "Разбивает строку на массив подстрок по указанному разделителю",
+                    "parameters": [
+                        "%"
+                    ],
+                    "example": "{% assign string = 'wooden, deepsnow, season2006' %}{% assign array = string | split: ', '%}{{array[0]}} #=> wooden"
+                },
+                {
+                    "id": "join",
+                    "name": "join",
+                    "description": "Фильтр объединяет массив в строку, используя как разделитель элементов указанную последовательность символов.",
+                    "parameters": [
+                        "%"
+                    ],
+                    "example": "{% assign my_string = 'wooden, deepsnow, season2006' %}{% assign my_array = my_string | split: ', '%}{{ my_array | join: ', ' }}#=> wooden, deepsnow, season2006"
+                },
+                {
+                    "id": "reverse",
+                    "name": "reverse",
+                    "description": "Меняет порядок элементов в массиве.",
+                    "parameters": [],
+                    "example": "{% assign string = 'wooden, deepsnow, season2006' %}{% assign array = string | split: ', ' | reverse %}{{ array | first }}#=> season2006{{ array | last }}#=> wooden"
+                },
+                {
+                    "id": "sort",
+                    "name": "sort",
+                    "description": "Фильтр используется для сортировки массива. Второй параметр - необязательный.",
+                    "parameters": [
+                        "title %"
+                    ],
+                    "example": "{% assign products = collection.products | sort: 'title' %}{% for product in products %}  {{ product.title }}{% endfor %}\n#=> A B a b"
+                },
+                {
+                    "id": "map",
+                    "name": "map",
+                    "description": "Принимает атрибут элемента массива в качестве параметра и создает массив из значения каждого элемента массива.",
+                    "parameters": [
+                        "title %"
+                    ],
+                    "example": "{% assign collection_titles = collections | map: 'title' %}\n{% for collection_title in collection_titles %}  {{ collection_title }},{% endfor %}\n#=> каталог1,каталог2,каталог3,"
+                },
+                {
+                    "id": "where",
+                    "name": "where",
+                    "description": "Отфильтровать массив по полям и их значениям",
+                    "parameters": [
+                        "available",
+                        "false"
+                    ],
+                    "example": "{{ collections.all.products | where: \"available\", false | size }}"
+                },
+                {
+                    "id": "concat",
+                    "name": "concat",
+                    "description": "Объединение двух массивов в один",
+                    "parameters": [
+                        " %"
+                    ],
+                    "example": "{% assign fruits = \"apples, oranges, peaches, tomatoes\" | split: \", \" %}{% assign vegetables = \"broccoli, carrots, lettuce, tomatoes\" | split: \", \" %}\n{% assign plants = fruits | concat: vegetables %}\n=> [\"apples\",\"oranges\",\"peaches\",\"tomatoes\",\"tomatoes\",\"broccoli\",\"carrots\",\"lettuce\",\"tomatoes\"]"
+                },
+                {
+                    "id": "uniq",
+                    "name": "uniq",
+                    "description": "Убирает дубли элементов массива",
+                    "parameters": [],
+                    "example": "{% assign fruits = \"apples, oranges, peaches, tomatoes, tomatoes\" | split: \", \" | uniq | json  %} \n=> [apples, oranges, peaches, tomatoes]"
+                }
+            ]
+        },
+        {
+            "id": "collection--matematicheskie-filtry",
+            "name": "Математические фильтры",
+            "description": "",
+            "filters": [
+                {
+                    "id": "plus",
+                    "name": "plus",
+                    "description": "Фильтр возвращает результат сложения input и operand. Если это строки, то они приводятся к формату \"целое\" перед сложением.",
+                    "parameters": [
+                        "2"
+                    ],
+                    "example": "{% assign number = 2 %}{{ number | plus: 2 }}#=> 4"
+                },
+                {
+                    "id": "minus",
+                    "name": "minus",
+                    "description": "Фильтр возвращает результат вычитания operand из input. Если это строки, то они приводятся к формату \"целое\" перед вычитанием.",
+                    "parameters": [
+                        "2"
+                    ],
+                    "example": "{% assign number = 2 %}{{ number | minus: 2 }}#=> 0"
+                },
+                {
+                    "id": "times",
+                    "name": "times",
+                    "description": "Фильтр возвращает результат умножеия",
+                    "parameters": [
+                        "2"
+                    ],
+                    "example": "{{ 10 | times: 2 }}#=> 20"
+                },
+                {
+                    "id": "divided_by",
+                    "name": "divided_by",
+                    "description": "Фильтр возвращает результат деления",
+                    "parameters": [
+                        "2"
+                    ],
+                    "example": "{{ 10 | divided_by: 2 }} #=> 5"
+                },
+                {
+                    "id": "round",
+                    "name": "round",
+                    "description": "round(input, operand) Фильтр возвращает результат округления operand до input знаков после разделителя.",
+                    "parameters": [
+                        "0"
+                    ],
+                    "example": "{{ 4.6 | round: 0 }}{{ 4.3 | round: 0 }}{{ 4.5612 | round: 2 }}#=> 5#=> 4#=> 4.56"
+                },
+                {
+                    "id": "modulo",
+                    "name": "modulo",
+                    "description": "Модуль числа. Возвращает остаток после деления",
+                    "parameters": [
+                        "5"
+                    ],
+                    "example": "{{ 12 | modulo: 5 }} #=> 2"
+                },
+                {
+                    "id": "to_integer",
+                    "name": "to_integer",
+                    "description": "Привести строку к числу",
+                    "parameters": [],
+                    "example": ""
+                }
+            ]
+        },
+        {
+            "id": "collection--filtry-dlya-ssylok",
+            "name": "Фильтры для ссылок",
+            "description": "",
+            "filters": [
+                {
+                    "id": "asset_url",
+                    "name": "asset_url",
+                    "description": "Возвращает ссылку на файл из темы. Если файла в теме нет, ссылка всё равно сформируется и переход по ссылке вернет 404 статус.",
+                    "parameters": [],
+                    "example": "{{ 'shop.css' | asset_url }}=> //assets3.insales.ru/assets/1/7120/23504/v_1479117076/build/shop.css"
+                },
+                {
+                    "id": "asset_url_if_exists",
+                    "name": "asset_url_if_exists",
+                    "description": "Возвращает ссылку на файл из темы. Если файла в теме нет, возвращается пустая строка.",
+                    "parameters": [],
+                    "example": "{% assign path = \"image.png\" | asset_url_if_exists %}{% if path %}  {% else %}  Картинка отсутствует{% endif %}"
+                },
+                {
+                    "id": "file_url",
+                    "name": "file_url",
+                    "description": "Фильтр формирует полный путь до файла из раздела Сайт->Файлы",
+                    "parameters": [],
+                    "example": "{{ 'image.png' | file_url }}"
+                },
+                {
+                    "id": "add_param",
+                    "name": "add_param",
+                    "description": "Добавить гет параметр к ссылке",
+                    "parameters": [],
+                    "example": ""
+                },
+                {
+                    "id": "locale_url",
+                    "name": "locale_url",
+                    "description": "Фильтр преобразует URL с учетом текущего языка",
+                    "parameters": [],
+                    "example": ""
+                }
+            ]
+        },
+        {
+            "id": "collection--strokovye-filtry",
+            "name": "Строковые фильтры",
+            "description": "",
+            "filters": [
+                {
+                    "id": "money",
+                    "name": "money",
+                    "description": "Добавляет символ валюты к числу. В соответствии с настройками в бэк-офисе. Посмотреть или изменить настройки можно тут: Настройки -> Настройки магазина -> Валюты Фильтр обрабатывает только цифры.",
+                    "parameters": [],
+                    "example": "{{ product.price | money }}\n#=> 1 000 руб.\n{{ 1000 | money }}\n#=> 1 000 руб."
+                },
+                {
+                    "id": "append",
+                    "name": "append",
+                    "description": "Добавить символы к концу строки",
+                    "parameters": [
+                        ".jpg"
+                    ],
+                    "example": "{{ 'sales' | append: '.jpg' }}#=> sales.jpg"
+                },
+                {
+                    "id": "prepend",
+                    "name": "prepend",
+                    "description": "Добавить символы к началу строки",
+                    "parameters": [
+                        "Made a great "
+                    ],
+                    "example": "{{ 'sale' | prepend: 'Made a great ' }}\n#=> Made a great sale"
+                },
+                {
+                    "id": "capitalize",
+                    "name": "capitalize",
+                    "description": "Фильтр используется для преобразования первой буквы строки в заглавную",
+                    "parameters": [],
+                    "example": "{{ 'capitalize me' | capitalize }}#=> Capitalize me"
+                },
+                {
+                    "id": "replace",
+                    "name": "replace",
+                    "description": "Заменяет все вхождения строки с подстроки.",
+                    "parameters": [
+                        "Awesome",
+                        "Mega"
+                    ],
+                    "example": "{{ product.title | replace: 'Awesome', 'Mega' }}\n#=> Mega Shoes"
+                },
+                {
+                    "id": "upcase",
+                    "name": "upcase",
+                    "description": "Фильтр преобразовывает строку к верхнему регистру.",
+                    "parameters": [],
+                    "example": "{{ 'i want this to be uppercase' | upcase }}#=> I WANT THIS TO BE UPPERCASE"
+                },
+                {
+                    "id": "downcase",
+                    "name": "downcase",
+                    "description": "Фильтр преобразовывает строку к нижнему регистру.",
+                    "parameters": [],
+                    "example": "{{ 'UPPERCASE' | downcase }}#=> uppercase"
+                },
+                {
+                    "id": "escape",
+                    "name": "escape",
+                    "description": "Фильтр используется для преобразовывания специальных html символов",
+                    "parameters": [],
+                    "example": "{{ \"test \" | escape }}#=> <p>test</p> <div class='block'></div>"
+                },
+                {
+                    "id": "newline_to_br",
+                    "name": "newline_to_br",
+                    "description": "Фильтр добавляет тег конца строки перед каждым служебным символом \"Новая строка\" (символ, обозначаемый NL, \\n, имеющий код 0ah).",
+                    "parameters": [],
+                    "example": "{% capture var %}OneTwoThree{% endcapture %}{{ var | newline_to_br }}\n#=>\nOne \nTwo\nThree"
+                },
+                {
+                    "id": "strip_html",
+                    "name": "strip_html",
+                    "description": "Этот фильтр изымает из указанного текста все HTML-теги. Очень эффективен в сочетании с truncate.",
+                    "parameters": [
+                        "20"
+                    ],
+                    "example": "{{ 'Текст в теге  новая строка' | strip_html | truncate: 20 }}\n>> Текст в теге нов..."
+                },
+                {
+                    "id": "md5",
+                    "name": "md5",
+                    "description": "Преобразует строку в MD5 хеш.",
+                    "parameters": [],
+                    "example": "{{ 'test md5' | md5 }}\n#=> 0e4e3b2681e8931c067a23c583c878d5"
+                },
+                {
+                    "id": "remove",
+                    "name": "remove",
+                    "description": "Удаляет все вхождения подстроки из строки.",
+                    "parameters": [
+                        "world"
+                    ],
+                    "example": "{{ \"Hello, world. Goodbye, world.\" | remove: \"world\" }}#=> Hello, . Goodbye, ."
+                },
+                {
+                    "id": "remove_first",
+                    "name": "remove_first",
+                    "description": "Удаляет только первое вхождение подстроки из строки.",
+                    "parameters": [
+                        "world"
+                    ],
+                    "example": "{{ \"Hello, world. Goodbye, world.\" | remove_first: \"world\" }}#=> Hello, . Goodbye, world."
+                },
+                {
+                    "id": "lstrip",
+                    "name": "lstrip",
+                    "description": "Удалить табы, пробелы, переносы в начале строки",
+                    "parameters": [],
+                    "example": "{{ \" So much room for activities! \" | lstrip }} >> So much room for activities!"
+                },
+                {
+                    "id": "truncate",
+                    "name": "truncate",
+                    "description": "Фильтр укорачивает строки до указанного количества символов удалением конца строки.",
+                    "parameters": [
+                        "13"
+                    ],
+                    "example": "{{ \"The cat came back the very next day\" | truncate: 13 }}The cat ca...\n{{ \"ABCDEFGHIJKLMNOPQRSTUVWXYZ\" | truncate: 18, \", and so on\" }}ABCDEFG, and so on"
+                },
+                {
+                    "id": "truncatewords",
+                    "name": "truncatewords",
+                    "description": "Фильтр укорачивает строку до указанного количества символов удалением конца строки.",
+                    "parameters": [
+                        "4"
+                    ],
+                    "example": "{{ \"The cat came back the very next day\" | truncatewords: 4 }}The cat came back...{{ \"The cat came back the very next day\" | truncatewords: 4, \"--\" }}The cat came back--"
+                },
+                {
+                    "id": "strip_newlines",
+                    "name": "strip_newlines",
+                    "description": "Фильтр изымает из указанной последовательности символов служебный символ \"Новая строка\" (символ, обозначаемый NL, \\n, имеющий код 0ah).",
+                    "parameters": [],
+                    "example": ""
+                },
+                {
+                    "id": "url_encode",
+                    "name": "url_encode",
+                    "description": "",
+                    "parameters": [],
+                    "example": "{{ \"john@liquidhub.ru\" | url_encode }}\n=> john%40liquidhub.ru"
+                },
+                {
+                    "id": "url_decode",
+                    "name": "url_decode",
+                    "description": "",
+                    "parameters": [],
+                    "example": "{{ 'john%40liquidhub.ru' | url_decode }}\n=> john@liquidhub.ru"
+                },
+                {
+                    "id": "file_type_by_url",
+                    "name": "file_type_by_url",
+                    "description": "Получить тип и расширение файла. image/video/audio/document/archive",
+                    "parameters": [],
+                    "example": "{% assign file_type = 'https://example.com/image.jpg?v=123&size=large' | file_type_by_url %}\n{{ file_type.type }} => image\n{{ file_type.ext }} => jpg"
+                }
+            ]
+        },
+        {
+            "id": "collection--dopolnitelnye-filtry",
+            "name": "Дополнительные фильтры",
+            "description": "",
+            "filters": [
+                {
+                    "id": "default",
+                    "name": "default",
+                    "description": "Задать значение поумолчанию",
+                    "parameters": [
+                        "2.99"
+                    ],
+                    "example": "{{ product_price | default: 2.99 }} >> 2.99{% assign product_price = \"\" %} {{ product_price | default: 2.99 }} >> 2.99"
+                },
+                {
+                    "id": "date",
+                    "name": "date",
+                    "description": "Фильтр преобразует формат даты в указанный (все даты - григорианского календаря)",
+                    "parameters": [
+                        "%Y"
+                    ],
+                    "example": "{{ 'now' | date: \"%Y\" }}"
+                },
+                {
+                    "id": "json",
+                    "name": "json",
+                    "description": "Преобразует строку или Liquid переменную в JSON формат.",
+                    "parameters": [],
+                    "example": "var myObject = {    text: {{ 'Строка в html теге' | json }},    product: {{ product | json }}  }  console.log(myObject);"
+                },
+                {
+                    "id": "custom_json",
+                    "name": "custom_json",
+                    "description": "Получение полей liquid объектов в JSON формате",
+                    "parameters": [
+                        "title",
+                        "id",
+                        "author"
+                    ],
+                    "example": "var customArticle = {{ article | custom_json: 'title', 'id', 'author' }};"
+                },
+                {
+                    "id": "dark",
+                    "name": "dark?",
+                    "description": "Проверяет, темный цвет или нет. Принимает только hex.",
+                    "parameters": [],
+                    "example": ""
+                },
+                {
+                    "id": "change_lightness",
+                    "name": "change_lightness",
+                    "description": "Изменить яркость цвета",
+                    "parameters": [],
+                    "example": ""
+                }
+            ]
+        },
+        {
+            "id": "collection--filtry-dlya-izobrazheniy",
+            "name": "Фильтры для изображений",
+            "description": "",
+            "filters": [
+                {
+                    "id": "image_url",
+                    "name": "image_url",
+                    "description": "Фильтр для указания размера изображения.",
+                    "parameters": [],
+                    "example": ""
+                },
+                {
+                    "id": "webp_picture_tag",
+                    "name": "webp_picture_tag",
+                    "description": "Фильтр создает из объекта изображения тег picture, в который добавляет изображение в формате .webp, а так же тег img с исходным форматом.",
+                    "parameters": [
+                        "600",
+                        "class",
+                        "index",
+                        "alt",
+                        "title"
+                    ],
+                    "example": "{% assign image_title = product.title | escape %}{{ product.first_image | webp_picture_tag: 600, class: 'product-image', data-index: 1, alt: image_title, title: image_title }}\nНа выходе получаем =>\n---\n{{ collection.image | webp_picture_tag: 600 }}\nНа выходе получаем =>"
+                }
+            ]
+        },
+        {
+            "id": "collection--html-2",
+            "name": "HTML",
+            "description": "",
+            "filters": [
+                {
+                    "id": "select_option",
+                    "name": "select_option",
+                    "description": "Фильтр select_option создает HTML-элемент <option> для использования внутри тега <select>. Он автоматически устанавливает атрибут selected, если переданное значение совпадает с выбранным значением. ▎Параметры - value: Значение опции (будет использовано в атрибуте value).- selected: Текущее выбранное значение.- name: Отображаемое имя опции (текст внутри тега <option>). ▎Возвращаемое значение Возвращает строку, представляющую HTML-элемент <option>.",
+                    "parameters": [
+                        "current_value",
+                        "Опция 1"
+                    ],
+                    "example": "1. Базовое использование:\n{% assign current_value = \"2\" %}{{ \"1\" | select_option: current_value, \"Опция 1\" }}{{ \"2\" | select_option: current_value, \"Опция 2\" }}{{ \"3\" | select_option: current_value, \"Опция 3\" }}\nРезультат:Опция 1Опция 2Опция 3\nПример для селекта с выбором количества товаров на странице\n{{ \"24\" | select_option: page_size, \"24 товара\" }}        {{ \"48\" | select_option: page_size, \"48 товара\" }}        {{ \"72\" | select_option: page_size, \"72 товара\" }}"
+                },
+                {
+                    "id": "link_to",
+                    "name": "link_to",
+                    "description": "Фильтр link_to используется для создания HTML элемента ссылки (<a>) из заданного URL и текста ссылки. Кроме того, он допускает необязательный атрибут title для ссылки. Параметры link: Видимый текст ссылки (обязательно). url: URL, на который указывает ссылка (обязательно). title: Атрибут title ссылки (необязательно). Возвращаемое значениеВозвращает строку, представляющую собой HTML элемент <a>.",
+                    "parameters": [
+                        "cart_url",
+                        "Ваша корзина"
+                    ],
+                    "example": "{{ \"Перейти в корзину\" | link_to: cart_url, \"Ваша корзина\" }}Перейти в корзину"
+                }
+            ]
+        }
+    ]
+}