Драг-н-дроп для загрузки файлов

Будем загружать файлы простым перетаскиванием без кликов.

Время чтения: 11 мин

Задача

Секция статьи "Задача"

Загрузка пользователем файлов на сервер — часто встречающаяся задача при создании сайтов и приложений. Текущие возможности JavaScript позволяют нам выбирать нужный файл простым его перетаскиванием в установленную область страницы браузера.

Широкую поддержку событий перетаскивания обеспечивают современные десктопные браузеры, среди мобильных браузеров такая поддержка пока низкая. Поэтому, если необходимо реализовать передачу файла на сервер также и для пользователей мобильных устройств, стоит добавлять возможность выбрать файл с использованием элемента <input type="file">.

В статье будет рассматриваться вариант выбора файла с использованием перетаскивания.

Загрузка файла на сервер состоит из трёх частей:

  1. Выбор пользователем файла на своём устройстве.
  2. Проверка параметров обработки файла и формирование данных с обращением к серверу.
  3. Обработка данных на сервере и отправка ответа клиенту.

Организовать полный процесс загрузки файла возможно только с использованием серверной части, реализация которой выходит за рамки данной статьи. Поэтому далее будет рассмотрена организация отправки файла на стороне клиента: HTML-разметка, стилизация элементов и JS-код для передачи файла на сервер.

Сама же серверная часть для обмена файлами может быть реализована на разных языках программирования. Например, про обработку файлов на стороне сервера с использованием PHP можно подробнее узнать в документации PHP.

Решение для загрузки файла

Секция статьи "Решение для загрузки файла"

На странице разместим HTML-разметку с необходимыми элементами:

        
          
          <div class="demo-wrapper">  <div id="dropFile_Zone" class="upload-zone">    <div id="uploadFile_Loader" class="upload-loader">      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" class="upload-loader__image">        <path fill="#fff" d="M73 50c0-12.7-10.3-23-23-23S27 37.3 27 50m3.9 0c0-10.5 8.5-19.1 19.1-19.1S69.1 39.5 69.1 50">          <animateTransform attributeName="transform" attributeType="XML" type="rotate" dur="1s" from="0 50 50" to="360 50 50" repeatCount="indefinite"/>        </path>      </svg>    </div>    <p id="uploadFile_Hint" class="upload-hint upload-hint_visible">Для загрузки изображения перетащите его в эту область</p>    <p id="uploadFile_Status" class="upload-status"></p>  </div></div>
          <div class="demo-wrapper">
  <div id="dropFile_Zone" class="upload-zone">
    <div id="uploadFile_Loader" class="upload-loader">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" class="upload-loader__image">
        <path fill="#fff" d="M73 50c0-12.7-10.3-23-23-23S27 37.3 27 50m3.9 0c0-10.5 8.5-19.1 19.1-19.1S69.1 39.5 69.1 50">
          <animateTransform attributeName="transform" attributeType="XML" type="rotate" dur="1s" from="0 50 50" to="360 50 50" repeatCount="indefinite"/>
        </path>
      </svg>
    </div>
    <p id="uploadFile_Hint" class="upload-hint upload-hint_visible">Для загрузки изображения перетащите его в эту область</p>
    <p id="uploadFile_Status" class="upload-status"></p>
  </div>
</div>

        
        
          
        
      

Для внешнего оформления элементов создадим следующие CSS-правила:

        
          
          p {  text-align: center;}.upload-zone {  position: relative;  display: flex;  flex-direction: column;  justify-content: center;  align-items: center;  width: 100%;  height: 250px;  padding: 55px 40px;  overflow: hidden;  background-color: #C56FFF;  color: #000000;  font-size: 24px;  font-weight: 500;}.upload-zone_dragover {  background-color: #593273;}.upload-hint {  display: none;}.upload-hint_visible {  display: block;  pointer-events: none;}.upload-loader {  display: none;  position: absolute;  top: 0;  left: 0;  width: 100%;  height: 100%;}.upload-loader_visible {  display: flex;  justify-content: center;  align-items: center;  background-color: #593273;}.upload-loader__image {  width: 150px;  height: 150px;}
          p {
  text-align: center;
}

.upload-zone {
  position: relative;
  display: flex;
  flex-direction: column;
  justify-content: center;
  align-items: center;
  width: 100%;
  height: 250px;
  padding: 55px 40px;
  overflow: hidden;
  background-color: #C56FFF;
  color: #000000;
  font-size: 24px;
  font-weight: 500;
}

.upload-zone_dragover {
  background-color: #593273;
}

.upload-hint {
  display: none;
}

.upload-hint_visible {
  display: block;
  pointer-events: none;
}

.upload-loader {
  display: none;
  position: absolute;
  top: 0;
  left: 0;
  width: 100%;
  height: 100%;
}

.upload-loader_visible {
  display: flex;
  justify-content: center;
  align-items: center;
  background-color: #593273;
}

.upload-loader__image {
  width: 150px;
  height: 150px;
}

        
        
          
        
      

В конце HTML-страницы или в отдельном JS-файле добавим код, который обеспечит связь между пользователем и сервером:

        
          
          const BYTES_IN_MB = 1048576const dropFileZone = document.getElementById('dropFile_Zone')const hintText = document.getElementById('uploadFile_Hint')const outputText = document.getElementById('uploadFile_Status')const loaderImage = document.getElementById('uploadFile_Loader')let fileInstance['dragover', 'drop'].forEach(function(event) {  document.addEventListener(event, function(evt) {    evt.preventDefault()    return false  })})dropFileZone.addEventListener('dragenter', function(event) {  dropFileZone.classList.add('upload-zone_dragover')})dropFileZone.addEventListener('dragleave', function(event) {  dropFileZone.classList.remove('upload-zone_dragover')})dropFileZone.addEventListener('drop', function(event) {  fileInstance = event.dataTransfer.files[0]  if (fileInstance.size > 5 * BYTES_IN_MB) {    alert('Принимается файл до 5 МБ')    return false  }  if (fileInstance.type.startsWith('image/')) {    processingUploadFile(fileInstance)  } else {    alert('Можно загружать только изображения')    return false  }})function processingUploadFile(fileInstanceUpload) {  if(fileInstanceUpload != undefined) {    const dropZoneData = new FormData()    const xhr = new XMLHttpRequest()    dropZoneData.append('file', fileInstanceUpload)    xhr.upload.addEventListener('progress', function() {      hintText.classList.remove('upload-hint_visible')      loaderImage.classList.add('upload-loader_visible')    })    xhr.open('POST', 'upload_processing.php', true)    xhr.send(dropZoneData)    xhr.onload = function (event){      if (xhr.status == 200) {        loaderImage.classList.remove('upload-loader_visible')        outputText.textContent = `Файл «${fileInstanceUpload.name}» загружен успешно`      } else {        loaderImage.classList.remove('upload-loader_visible')        outputText.textContent = `Файл не загружен. Ошибка ${xhr.status} при загрузке файла.`      }    }  }}
          const BYTES_IN_MB = 1048576

const dropFileZone = document.getElementById('dropFile_Zone')
const hintText = document.getElementById('uploadFile_Hint')
const outputText = document.getElementById('uploadFile_Status')
const loaderImage = document.getElementById('uploadFile_Loader')
let fileInstance

['dragover', 'drop'].forEach(function(event) {
  document.addEventListener(event, function(evt) {
    evt.preventDefault()
    return false
  })
})

dropFileZone.addEventListener('dragenter', function(event) {
  dropFileZone.classList.add('upload-zone_dragover')
})

dropFileZone.addEventListener('dragleave', function(event) {
  dropFileZone.classList.remove('upload-zone_dragover')
})

dropFileZone.addEventListener('drop', function(event) {
  fileInstance = event.dataTransfer.files[0]
  if (fileInstance.size > 5 * BYTES_IN_MB) {
    alert('Принимается файл до 5 МБ')
    return false
  }
  if (fileInstance.type.startsWith('image/')) {
    processingUploadFile(fileInstance)
  } else {
    alert('Можно загружать только изображения')
    return false
  }
})

function processingUploadFile(fileInstanceUpload) {
  if(fileInstanceUpload != undefined) {
    const dropZoneData = new FormData()
    const xhr = new XMLHttpRequest()

    dropZoneData.append('file', fileInstanceUpload)

    xhr.upload.addEventListener('progress', function() {
      hintText.classList.remove('upload-hint_visible')
      loaderImage.classList.add('upload-loader_visible')
    })

    xhr.open('POST', 'upload_processing.php', true)

    xhr.send(dropZoneData)

    xhr.onload = function (event){
      if (xhr.status == 200) {
        loaderImage.classList.remove('upload-loader_visible')
        outputText.textContent = `Файл «${fileInstanceUpload.name}» загружен успешно`
      } else {
        loaderImage.classList.remove('upload-loader_visible')
        outputText.textContent = `Файл не загружен. Ошибка ${xhr.status} при загрузке файла.`
      }
    }
  }
}

        
        
          
        
      
Открыть демо в новой вкладке

Полный вариант загрузки файла с его сохранением на сервере выглядит так:

Разбор решения

Секция статьи "Разбор решения"

Разметка

Секция статьи "Разметка"

Для обработки файла используется контейнер с идентификатором dropFile_Zone. Внутри этого блока помещаются вспомогательные элементы, которые обеспечивают информационное взаимодействие с пользователем:

  • анимированный svg-элемент в качестве индикатора обработки файла;
  • текстовый элемент с идентификатором uploadFile_Status, который покажет информацию о результате загрузки.

Для каждого элемента, который участвует в процессе обработки файла, указывается атрибут id — это позволит JS-коду обращаться к нужным элементам для выполнения необходимых действий.

        
          
          <div class="demo-wrapper">  <div id="dropFile_Zone" class="upload-zone">    <div id="uploadFile_Loader" class="upload-loader">      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" class="upload-loader__image">        <path fill="#fff" d="M73 50c0-12.7-10.3-23-23-23S27 37.3 27 50m3.9 0c0-10.5 8.5-19.1 19.1-19.1S69.1 39.5 69.1 50">          <animateTransform attributeName="transform" attributeType="XML" type="rotate" dur="1s" from="0 50 50" to="360 50 50" repeatCount="indefinite"/>        </path>      </svg>    </div>    <p id="uploadFile_Hint" class="upload-hint upload-hint_visible">Для загрузки изображения перетащите его в эту область</p>    <p id="uploadFile_Status" class="upload-status"></p>  </div></div>
          <div class="demo-wrapper">
  <div id="dropFile_Zone" class="upload-zone">
    <div id="uploadFile_Loader" class="upload-loader">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" class="upload-loader__image">
        <path fill="#fff" d="M73 50c0-12.7-10.3-23-23-23S27 37.3 27 50m3.9 0c0-10.5 8.5-19.1 19.1-19.1S69.1 39.5 69.1 50">
          <animateTransform attributeName="transform" attributeType="XML" type="rotate" dur="1s" from="0 50 50" to="360 50 50" repeatCount="indefinite"/>
        </path>
      </svg>
    </div>
    <p id="uploadFile_Hint" class="upload-hint upload-hint_visible">Для загрузки изображения перетащите его в эту область</p>
    <p id="uploadFile_Status" class="upload-status"></p>
  </div>
</div>

        
        
          
        
      

Для показа процесса выполнения загрузки файла также можно использовать специальный элемент <progress> — этот вариант подробно рассмотрен в рецепте «Загрузка файла с прогресс-баром».

Стили

Секция статьи "Стили"

Область для загрузки файла выделим фоновым цветом и укажем фиксированную высоту:

        
          
          .upload-zone {  position: relative;  display: flex;  flex-direction: column;  justify-content: center;  align-items: center;  width: 100%;  height: 250px;  padding: 55px 40px;  overflow: hidden;  background-color: #C56FFF;  color: #000000;  font-size: 24px;  font-weight: 500;}
          .upload-zone {
  position: relative;
  display: flex;
  flex-direction: column;
  justify-content: center;
  align-items: center;
  width: 100%;
  height: 250px;
  padding: 55px 40px;
  overflow: hidden;
  background-color: #C56FFF;
  color: #000000;
  font-size: 24px;
  font-weight: 500;
}

        
        
          
        
      

При перетаскивании файла в область загрузки будем менять фоновый цвет при помощи дополнительного класса:

        
          
          .upload-zone_dragover {  background-color: #593273;}
          .upload-zone_dragover {
  background-color: #593273;
}

        
        
          
        
      

Контейнер с индикатором обработки файла изначально скрыт и с абсолютным позиционированием занимает весь родительский блок:

        
          
          .upload-loader {  display: none;  position: absolute;  top: 0;  left: 0;  width: 100%;  height: 100%;}
          .upload-loader {
  display: none;
  position: absolute;
  top: 0;
  left: 0;
  width: 100%;
  height: 100%;
}

        
        
          
        
      

После появления файла в области загрузки и до конца его обработки, индикатор будет показываться с использованием дополнительного класса:

        
          
          .upload-loader_visible {  display: flex;  justify-content: center;  align-items: center;  background-color: #593273;}.upload-loader__image {  width: 150px;  height: 150px;}
          .upload-loader_visible {
  display: flex;
  justify-content: center;
  align-items: center;
  background-color: #593273;
}

.upload-loader__image {
  width: 150px;
  height: 150px;
}

        
        
          
        
      

JavaScript

Секция статьи "JavaScript"

Для начала объявим переменные и получим все необходимые элементы DOM-дерева, чтобы подписываться на события:

  • переменная BYTES_IN_MB, в которой указывается количество байтов в одном мегабайте, будет использоваться при вычислении размера файла;
  • dropFileZone устанавливает область обработки выбранного файла;
  • hintText указывает на подсказку о загрузке файла;
  • в переменной outputText указывается элемент, в котором будет показан полученный от сервера ответ;
  • переменная loaderImage определяет графический элемент индикатора обработки файла;
  • в переменной fileInstance будут храниться данные выбранного файла.
        
          
          const BYTES_IN_MB = 1048576const dropFileZone = document.getElementById('dropFile_Zone')const hintText = document.getElementById('uploadFile_Hint')const outputText = document.getElementById('uploadFile_Status')const loaderImage = document.getElementById('uploadFile_Loader')let fileInstance
          const BYTES_IN_MB = 1048576

const dropFileZone = document.getElementById('dropFile_Zone')
const hintText = document.getElementById('uploadFile_Hint')
const outputText = document.getElementById('uploadFile_Status')
const loaderImage = document.getElementById('uploadFile_Loader')
let fileInstance

        
        
          
        
      

Поскольку переменная fileInstance объявляется без присвоения значения, используется ключевое слово let. Об отличиях переменных и принципах работы с ними более развёрнуто рассказывается в статье «Переменные const, let и var».

При отслеживании перетаскивания файла будут использоваться следующие события:

  • dragover выполняется во время перемещения файла над областью обработки файла;
  • dragenter срабатывает, когда файл входит в область обработки файла;
  • dragleave срабатывает, если файл покидает область обработки, но ещё не «сброшен»;
  • drop выполняется в тот момент, когда пользователь отпустил кнопку мыши и выбранный файл был помещён («сброшен») в заданную область.

Когда при перетаскивании выбранный файл будет находиться в пределах активной страницы, браузер его откроет. Чтобы файл был обработан в назначенной для этого области, необходимо отменить стандартное поведение браузера для событий dragover и drop путём вызова метода preventDefault():

        
          
          ['dragover', 'drop'].forEach(function(event) {  document.addEventListener(event, function(evt) {    evt.preventDefault()    return false  })})dropFileZone.addEventListener('dragenter', function(event) {  dropFileZone.classList.add('upload-zone_dragover')})dropFileZone.addEventListener('dragleave', function(event) {  dropFileZone.classList.remove('upload-zone_dragover')})
          ['dragover', 'drop'].forEach(function(event) {
  document.addEventListener(event, function(evt) {
    evt.preventDefault()
    return false
  })
})

dropFileZone.addEventListener('dragenter', function(event) {
  dropFileZone.classList.add('upload-zone_dragover')
})

dropFileZone.addEventListener('dragleave', function(event) {
  dropFileZone.classList.remove('upload-zone_dragover')
})

        
        
          
        
      

Загрузка файлов большого размера увеличивает нагрузку на сервер, поэтому установим максимальный размер файла в 5 МБ. Проверку размера файла выполним на этапе его помещения в область загрузки. Для этого получим информацию о файле с помощью объекта dataTransfer, который хранит данные о событии перетаскивания. Также зададим условие, что загружать можно будет только изображения.

        
          
          dropFileZone.addEventListener('drop', function uploadFile(event) {  fileInstance = event.dataTransfer.files[0]  if (fileInstance.size > 5 * BYTES_IN_MB) {    alert('Принимается файл до 5 МБ')    return false  }  if (fileInstance.type.startsWith('image/')) {    processingUploadFile(fileInstance)  } else {    alert('Можно загружать только изображения')    return false  }})
          dropFileZone.addEventListener('drop', function uploadFile(event) {
  fileInstance = event.dataTransfer.files[0]
  if (fileInstance.size > 5 * BYTES_IN_MB) {
    alert('Принимается файл до 5 МБ')
    return false
  }
  if (fileInstance.type.startsWith('image/')) {
    processingUploadFile(fileInstance)
  } else {
    alert('Можно загружать только изображения')
    return false
  }
})

        
        
          
        
      

Чтобы отправить файл на сервер без перезагрузки страницы, воспользуемся XMLHttpRequest — набором механизмов для обмена данными между клиентом и сервером без перезагрузки страницы. Подробней о нём можно почитать на MDN.

Основную работу будет выполнять функция processingUploadFile(), которая принимает выбранный пользователем файл fileInstanceUpload и отправляет его на сервер:

        
          
          function processingUploadFile(fileInstanceUpload) {  if(fileInstanceUpload != undefined) {    // код функции рассматривается ниже  }}
          function processingUploadFile(fileInstanceUpload) {
  if(fileInstanceUpload != undefined) {
    // код функции рассматривается ниже
  }
}

        
        
          
        
      

Первым делом объявляем переменные:

  • dropZoneData, в которой с использованием объекта FormData будут храниться данные для отправки на сервер;
  • xhr для обращения к серверу с использованием XMLHttpRequest.
        
          
          const dropZoneData = new FormData()const xhr = new XMLHttpRequest()
          const dropZoneData = new FormData()
const xhr = new XMLHttpRequest()

        
        
          
        
      

После этого указываем последовательность работы XMLHttpRequest при передаче файла на сервер:

  1. Выбранный файл сохраняется для отправки.
  2. Для XMLHttpRequest добавляется обработчик события progress, который отслеживает процесс загрузки файла. Чтобы показать скрытый графический элемент индикатора загрузки, ему добавляется класс upload-loader_visible, а подсказка о загрузке скрывается через удаление класса upload-hint_visible.
  3. Метод open() выполняет POST-запрос к управляющему файлу, который хранится на сервере.
  4. Выбранный пользователем файл передаётся на сервер.
  5. Для XMLHttpRequest выполняется обработка события загрузки файла:
    • если файл сохранён на сервере, индикатор загрузки скрывается и пользователю показывается сообщение об успешной загрузке файла;
    • если файл не принят сервером, индикатор загрузки скрывается и пользователю показывается сообщение об ошибке.
        
          
          dropZoneData.append('file', fileInstanceUpload)xhr.upload.addEventListener('progress', function() {  hintText.classList.remove('upload-hint_visible')  loaderImage.classList.add('upload-loader_visible')})xhr.open('POST', 'upload_processing.php', true)xhr.send(dropZoneData)xhr.onload = function (event){  if (xhr.status == 200) {    loaderImage.classList.remove('upload-loader_visible')    outputText.textContent = `Файл «${fileInstanceUpload.name}» загружен успешно`  } else {    loaderImage.classList.remove('upload-loader_visible')    outputText.textContent = `Файл не загружен. Ошибка ${xhr.status} при загрузке файла.`  }}
          dropZoneData.append('file', fileInstanceUpload)

xhr.upload.addEventListener('progress', function() {
  hintText.classList.remove('upload-hint_visible')
  loaderImage.classList.add('upload-loader_visible')
})

xhr.open('POST', 'upload_processing.php', true)

xhr.send(dropZoneData)

xhr.onload = function (event){
  if (xhr.status == 200) {
    loaderImage.classList.remove('upload-loader_visible')
    outputText.textContent = `Файл «${fileInstanceUpload.name}» загружен успешно`
  } else {
    loaderImage.classList.remove('upload-loader_visible')
    outputText.textContent = `Файл не загружен. Ошибка ${xhr.status} при загрузке файла.`
  }
}

        
        
          
        
      
Открыть демо в новой вкладке