draggable README

The project's README from github.com/Shopify/draggable. As one markdown file: README.md.

npm version CI PRs Welcome Bundle size

Development

Draggable is no longer maintained by its original authors. Maintenance of this repo has been passed on to new collaborators and is no longer worked on by anyone at Shopify.

We are still looking for more maintainers! If anyone is interested in answering / triaging issues, reviewing / rejecting / approving PRs, and authoring code for bug fixes / new features — please send an email to max.hoffmann (at) shopify (dot) com. You may be asked a few questions before obtaining collaboration permission, but if everything checks out, we will happily add you as a collaborator.

Get complete control over drag and drop behaviour with Draggable! Draggable abstracts native browser events into a comprehensive API to create a custom drag and drop experience. Draggable comes with additional modules: Sortable, Droppable, Swappable. Draggable itself does not perform any sorting behaviour while dragging, but does the heavy lifting, e.g. creates mirror, emits events, manages sensor events, makes elements draggable.

The additional modules are built on top of Draggable and therefore provide a similar API interface, for more information read the documentation below.

Features

Table of Contents

Install

You can install the library via npm.

npm install @shopify/draggable --save

or via yarn:

yarn add @shopify/draggable

or via CDN

<!-- Entire bundle -->
<script type="module">
  import {
    Draggable,
    Sortable,
    Droppable,
    Swappable,
  } from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/index.mjs';
</script>
<!-- Draggable only -->
<script type="module">
  import Draggable from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/Draggable/Draggable.mjs';
</script>
<!-- Sortable only -->
<script type="module">
  import Sortable from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/Sortable/Sortable.mjs';
</script>
<!-- Droppable only -->
<script type="module">
  import Droppable from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/Droppable/Droppable.mjs';
</script>
<!-- Swappable only -->
<script type="module">
  import Swappable from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/Swappable/Swappable.mjs';
</script>
<!-- Plugins only -->
<script type="module">
  import * as Plugins from 'https://cdn.jsdelivr.net/npm/@shopify/draggable/build/esm/Plugins/index.mjs';
</script>
<!-- UMD browser -->
<script src="https://cdn.jsdelivr.net/npm/@shopify/draggable/build/umd/index.min.js"></script>
<script>
  console.log(window.Draggable);
</script>

Browser Compatibility

Check the "browserlist" property in package.json for more info

Chrome Firefox Opera Safari Edge
Last 3 versions ✔ Last 3 versions ✔ Last 3 versions ✔ Last 3 versions ✔ Last 3 versions ✔

Documentation

You can find the documentation for each module within their respective directories.

TypeScript

Draggable includes TypeScript definitions.

Documentation

Running examples

To run the examples project locally, simply run the following from the draggable root:

yarn && yarn start

This will start a server that hosts the contents of examples/. It also watches for file changes from both src/ and examples/src and reloads the browser.

Contributing

Contributions are more than welcome, the code base is still new and needs more love.

For more information, please checkout the contributing document.

Copyright (c) 2018-present Shopify. See LICENSE.md for further details.

draggable (Shopify/draggable)

Searching Database…

18.5K ·GitHub
Draggable
archived
Что это такое?Draggable — это открытая JavaScript-библиотека для drag & drop от Shopify. Она оборачивает нативные события браузера в удобный API, чтобы вы могли создавать полностью собственные механизмы перетаскивания в браузере.
Это фреймворк, под который придётся подстраиваться, или обычная библиотека?Обычная фронтенд-библиотека, написанная в первую очередь на ES6 — фреймворк не нужен. В комплекте есть типы для TypeScript, а дополнительные модули (Sortable, Droppable, Swappable) построены поверх ядра.
Как добавить её в проект?Установите через npm install @shopify/draggable (или yarn add, или тегом скрипта с CDN), затем через API привяжите её к элементам, которые хотите перетаскивать. Документация каждого модуля лежит в отдельной папке в репозитории.
Проект ещё развивается?Нет — репозиторий заархивирован, и Shopify больше им не занимается. Поддержку передали внешним соавторам, которые правят баги и рассматривают пул-реквесты, и они всё ещё ищут новых мейнтейнеров.
Можно сначала попробовать её, не добавляя в свой проект?Да — в репозитории есть проект examples. Запустите скрипт start из корня репозитория, и папка examples/ откроется в браузере, автоматически обновляясь при изменении исходников библиотеки или файлов примеров.
Насколько гибко настраивается поведение перетаскивания?Весьма гибко: можно подключаться к жизненному циклу событий Draggable, чтобы расширять перетаскивание, добавлять сенсоры для новых способов ввода и включать плагины вроде Mirror, Scrollable, Collidable, ResizeMirror, Snappable, SwapAnimation, SortAnimation, Announcement и Focusable.
Есть ли что-то для тех, кто пользуется фреймворками?В README среди связанных материалов указаны community-шимы для Ember CLI (на GitHub и npm). Само ядро не зависит от фреймворков, а для проектов с типами в комплекте есть определения TypeScript.
What are similar projects?Sortable, muuri, moveable, interact.js, mojs, dragula, dropzone, iscroll
Which topics is it in?draggable, es6, drag-and-drop, javascript-library, animation, deprecated, browser, mobile, ui, web-development, frontend, library
Creator
Shopify
Size
5.9 MB
Stars
18.5K
Updated
CommitOct 22Releasev1.2.1Oct 22
Age
9y
Commits · 90 Days