File

Компонент для загрузки файлов. Позволяет загружать файлы в контент. Для дочерних ассоциаций поддерживается задание type/kind.

При добавлении нового компонента Файл на форме достаточно указать правильный Имя свойства/Property Name (или оставить по умолчанию _content, если подразумевается редактирование основного контента у документа). Все остальные настройки работают «из коробки».

Способ загрузки задаётся на вкладке Файл в поле Хранилище/Storage. Доступные значения формируются из зарегистрированных провайдеров хранилища, в том числе URL и Base64.

Настройка отображения названия файла

На вкладке Файл добавлена возможность настраивать отображение названий файлов в списке - настройка Отображаемое имя значения. Поле принимает javascript-выражение, в котором необходимо присвоить переменной disp строку, либо Promise.

Помимо стандартных переменных formio, доступных при написании javascript-выражений (data, instance, _ и т.д.) добавлены дополнительные:

  • originalFileName - содержит название файла по умолчанию

  • file - объект, содержащий различную информацию о файле

  • record — объект Records API, полученный через Records.get(recordRef), либо null, если ссылка не передана в вычисление имени. Метод record.load(...) может возвращать Promise. Наличие объекта record зависит от того, удалось ли извлечь и передать ссылку на запись в текущем режиме отображения файла.

Примеры использования настройки Value display name:

// Пример 1. Статическое название
disp = 'staticName.txt';
// Пример 2. Название, вычисленное асинхронно
disp = new Promise(resolve => {
  // какие-то асинхронные действия
  // ...
  resolve('Асинхронное название файла')
});
// Пример 3. Использование record
disp = record ? record.load('.disp').then(result => `${result}.pdf`) : originalFileName;

Настройка отображения отдельных элементов компонента

На вкладку Отображение добавлена дополнительная настройка Элементы отображения, которая позволяет задавать условия отображения отдельных элементов (например, кнопка удаления файла, upload-зона с кнопкой для добавления нового файла).

Поле принимает javascript-выражение, в котором необходимо присвоить переменной value объект с необязательными свойствами upload, delete. Если какое-то из свойств не указано, то компонент сам будет решать, отображать элемент или скрывать, в зависимости от ситуации.

value = {
    upload: false,
    delete: false
}
../../../../../_images/file_5.png

Действие при нажатии на файл

На вкладке Файл настройка Behaviour on file item click (onFileClick) определяет действие при нажатии на имя файла:

  • открытие карточки записи (openDashboard);

  • скачивание файла (download);

  • отсутствие действия (noop).

Бэкенд

Для корректной работы контрола в режиме редактирования у значения «контент» должен быть реализован метод getAs с аргументом content-data, который вернет структуру следующего содержания:

[
    {
        "url": "https://example.org/files/document.pdf",
        "name": "document.pdf",
        "size": 1024
    }
]

Синхронизация с виджетом документов

Для синхронизации с виджетом документов на форме контрола file в Имени свойства необходимо указать docs:documents:

../../../../../_images/file_6.png

На вкладке Файл указать тип(ы), с которыми следует загружать новые файлы (если файл загрузить без типа, то в виджете он не появится):

../../../../../_images/file_7.png