OXBOX Help

Фильтры

Фильтр является частью модуля и предоставляют возможность модифицировать запрос для получения данных.

Базовая структура фильтра представляет из себя следующий объект:

{ title: string, type: string, settings: { size?: number, is_visible?: boolean, hook?: string } placeholder?: string }
  • title - заголовок фильтра.

  • type - тип фильтра. Типы аналогичны типам полей форм, но с ограниченным выбором. Предоставляется возможность выбрать следующие значения: list, date, price, integer, checkbox. Подробнее о типах ниже.

  • settings - стандартный расширяемый объект, содержащий следующие свойства:

    • size - размер фильтра. Допустимые значения от 1 до 4.

    • is_visible - видимость фильтра.

    • hook - вариативное свойство, позволяющее выполнять запрос при изменении значения фильтра.

  • placeholder - текст-подсказка.

В системе используются фильтры следующих типов:

  • list - выпадающий список. Объект settings расширен следующими свойствами:

    • donor_object - объект для запроса на выпадающий список

    • donor_property_title - свойство select при запросе на выпадающий список.

    • select_menu - часть запроса на выпадающий список.

    • is_search - свойство, необходимое для определения того, является ли список поисковым.

    • list - массив объектов со свойствами title и value. Используется для передачи списка в схеме страницы.

    • is_multi - предоставлять ли возможность выбирать несколько значений.

    • is_clearable - вариативное свойство, дающее возможность настраивать зачистку поля.

    • recepient_property - артикул поля.

{ settings: { donor_object: string, donor_property_title: string, select_menu?: string | Array<string>, is_search: boolean, list?: Array<{title: string, value: string | number}>, is_multi?: boolean is_clearable?: boolean, recipient_property: string, ... } ... }
  • date - календарь с возможностью выбора даты.

  • integer - числовое значение.

  • price - аналог integer, но с "маской".

  • checkbox - чекбокс для значений правда/ложь.

Объект settings данных типов фильтров расширен единственным свойством recipient_property, представляющим из себя артикул поля.

{ settings: { recipient_property: string, ... } ... }
15 мая 2025