Документация для разработчиков
Темная тема

BX.UI.Icons.Generator.FileIcon

Расширение создано для генерации SVG иконок файлов, с указанием любых расширений.

Класс имеет два метода возвращающих SVG иконку:

  • generate() вернет Dom элемент SVG
  • generateURI() Возвращает кодированный в URI исходник картинки для использования в качестве фона.

Конечно иконку можно кастомизировать, но ни один параметр не является обязательным, это означает что при вызове без параметров вы получите иконка «бланк»:

let myIcon = new BX.UI.Icons.Generator.FileIcon();

Параметры

Параметров, позволяющих кастомизировать иконку всего 4, давайте рассмотрим:

name {string}. Это опция для указания расширения, рекомендуется использовать до 5 символов. Класс имеет пресеты, поэтому, если вы укажите например RAR, иконка будет сгенерировано по параметрам определенным нашим дизайнером.

color {string} определяет цвет лейбла для подписи. Если опция name не задана, color не работает, т.к. красить нечего. Также эта опция переопределяет значение из пресета.

fileType в этой опции задается типа файла, всего их 3.

BX.UI.Icons.Generator.FileType.ARCHIVE
BX.UI.Icons.Generator.FileType.MEDIA
BX.UI.Icons.Generator.FileType.PICTURE

Также эта опция переопределяет значение из пресета, если таковое имеется.

size {number} здесь указывается ширина иконки в px. Если опция не задана, иконка займет 100% доступной ширины.


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх