react-beautiful-dnd README

The project's README from github.com/atlassian/react-beautiful-dnd. As one markdown file: README.md.

🔒 Archived

This project is now archived and is deprecated on npm. If you are still using react-beautiful-dnd, we have put together some resources to help you move forward. To see our ongoing work in the drag and drop problem space, head to Pragmatic drag and drop.

We are so grateful to everybody who contributed in big and small ways to this project.

Cheers



react beautiful dnd logo

react-beautiful-dnd (rbd)

Beautiful and accessible drag and drop for lists with React

CircleCI branch npm

quote application example

Play with this example if you want!

Core characteristics

Get started 👩‍🏫

We have created a free course on egghead.io 🥚 to help you get started with react-beautiful-dnd as quickly as possible.

course-logo

Currently supported feature set ✅

Motivation 🤔

react-beautiful-dnd exists to create beautiful drag and drop for lists that anyone can use - even people who cannot see. For a good overview of the history and motivations of the project you can take a look at these external resources:

Not for everyone ✌️

There are a lot of libraries out there that allow for drag and drop interactions within React. Most notable of these is the amazing react-dnd. It does an incredible job at providing a great set of drag and drop primitives which work especially well with the wildly inconsistent html5 drag and drop feature. react-beautiful-dnd is a higher level abstraction specifically built for lists (vertical, horizontal, movement between lists, nested lists and so on). Within that subset of functionality react-beautiful-dnd offers a powerful, natural and beautiful drag and drop experience. However, it does not provide the breadth of functionality offered by react-dnd. So react-beautiful-dnd might not be for you depending on what your use case is.

Documentation 📖

About 👋

Sensors 🔉

The ways in which somebody can start and control a drag

API 🏋️‍

diagram

Guides 🗺

Patterns 👷‍

Support 👩‍⚕️

Read this in other languages 🌎

Creator ✍️

Alex Reardon @alexandereardon

Alex is no longer personally maintaining this project. The other wonderful maintainers are carrying this project forward.

Maintainers

Collaborators 🤝

react-beautiful-dnd (atlassian/react-beautiful-dnd)

Searching Database…

33.9K ·GitHub
archived
Что это?Библиотека React для создания красивых и доступных взаимодействий перетаскивания для списков: поддерживаются вертикальные и горизонтальные списки, перемещение между списками и вложенные списки.
Это универсальный набор для перетаскивания или что-то более узкое?Это абстракция более высокого уровня, созданная специально для списков, а не универсальная библиотека базовых примитивов перетаскивания вроде react-dnd.
Как добавить это в проект?Установите как зависимость npm/yarn и оберните части приложения, которым нужно перетаскивание, компонентами DragDropContext, Droppable и Draggable; также есть бесплатный курс на egghead.io, с которого можно начать.
От чего это зависит внутри?Построено на React и внутри опирается на вспомогательные пакеты, такие как css-box-model, memoize-one, redux и react-redux.
Можно ли использовать это в новом проекте?Нет: проект заархивирован и помечен как устаревший на npm; команда рекомендует для дальнейшей работы перейти на Pragmatic drag and drop.
Для кого это создавалось?Для фронтенд-разработчиков, которые создают React-приложения со списками, где можно менять порядок элементов, включая тех, кому важна поддержка программ для чтения с экрана и управления с клавиатуры.
Какие способы ввода для перетаскивания поддерживаются?Из коробки поддерживаются мышь, клавиатура и сенсорный экран, включая автопрокрутку при перетаскивании с клавиатуры.
Справится ли это с действительно большими списками?Да, поддерживаются виртуальные списки, что позволяет работать с 10 000 элементов при 60 кадрах в секунду.
Можно ли перетаскивать сразу несколько элементов?Да, перетаскивание нескольких элементов входит в набор возможностей наряду с объединением элементов и условным перетаскиванием и сбросом.
Почему бы мне не взять react-dnd вместо этого?react-dnd предлагает более широкий набор низкоуровневых примитивов перетаскивания, а react-beautiful-dnd жертвует этой широтой ради более отточенного, естественного и доступного взаимодействия, специально заточенного под изменение порядка в списках.
Creator
atlassian
Size
14.5 MB
Stars
33.9K
Age
9y
Commits · 90 Days