Skip to content

Commit

Permalink
Rename react-beautiful-dnd to @react-forked/dnd (#2)
Browse files Browse the repository at this point in the history
* Rename react-beautiful-dnd to react-forked-dnd

* rbd -> rfd

* Rename compressed logo

* Fix typo

* Fix upgrading markdown

* Keep origial article title case

* Fix article link

* Adjust types guide

* Keep link to original issue

* Fix egghead link

* Add typescript warning

* Add properly name @react-forked/dnd

* Change dist file name

* Update build size
  • Loading branch information
100terres authored Dec 15, 2020
1 parent 0cab172 commit a494494
Show file tree
Hide file tree
Showing 71 changed files with 226 additions and 210 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ labels: "unconfirmed-bug, untriaged"
We have created a common setup issues guide to help you troubleshoot common setup problems:
https://github.com/atlassian/react-beautiful-dnd/blob/master/docs/guides/common-setup-issues.md
https://github.com/react-forked/dnd/blob/master/docs/guides/common-setup-issues.md
## Check your console
In development builds we log warnings to the console for common setup issues. Please have a look to see if it can give you information in overcoming your issue
## Are you new to rbd?
If you are new to `react-beautiful-dnd` we recommend taking at look at our getting started course: https://egghead.io/courses/beautiful-and-accessible-drag-and-drop-with-react-beautiful-dnd
## Are you new to rfd?
If you are new to `@react-forked/dnd` we recommend taking at look at our getting started course: https://egghead.io/courses/beautiful-and-accessible-drag-and-drop-with-react-beautiful-dnd (This is using [react-beautiful-dnd](https://github.com/atlassian/react-beautiful-dnd))
It will give you a good base understanding of how everything fits together. This can often be the best help in overcoming your issue.
Expand All @@ -25,7 +25,7 @@ It will give you a good base understanding of how everything fits together. This
Before raising a feature request or bug please search through our open and closed issues to see if there is something similar. If you do find one similar you can show it is important to you by adding a reaction (such as 👍) to the issue
Open and closed issues:
https://github.com/atlassian/react-beautiful-dnd/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aclosed%20is%3Aissue%20
https://github.com/react-forked/dnd/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aclosed%20is%3Aissue%20
-->

### Expected behavior
Expand All @@ -48,7 +48,7 @@ https://github.com/atlassian/react-beautiful-dnd/issues?utf8=%E2%9C%93&q=is%3Aop
Ensure that it satisfies our peer dependency version - see our package.json. (Currently it is "^16.8.0")
-->

### What version of `react-beautiful-dnd` are you running?
### What version of `@react-forked/dnd` are you running?

<!--
We will only look into issues that are effecting the latest version. At this stage we are not releasing fixes for previous releases
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This is not a general purpose drag and drop library and is attempting to create
Before raising a new feature please ensure that it falls within the philosophy of the library.
https://github.com/atlassian/react-beautiful-dnd/blob/master/docs/about/design-principles.md#foundational-idea-physicality
https://github.com/react-forked/dnd/blob/master/docs/about/design-principles.md#foundational-idea-physicality
All features need to have a clear and generally applicable keyboard interaction pattern in order for us to deliver on our core goal of being highly accessible.
-->
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/tree-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ labels: 'wontfix ☠️'

Please head to the [`@atlaskit/tree` issue tracker](https://ecosystem.atlassian.net/servicedesk/customer/portal/24/create/236).

We do not track `@atlaskit/tree` issues in the `react-beautiful-dnd` project
We do not track `@atlaskit/tree` issues in the `@react-forked/dnd` project
20 changes: 10 additions & 10 deletions .size-snapshot.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"dist/react-beautiful-dnd.js": {
"bundled": 364998,
"minified": 133574,
"gzipped": 39437
"dist/dnd.js": {
"bundled": 364949,
"minified": 133514,
"gzipped": 39479
},
"dist/react-beautiful-dnd.min.js": {
"dist/dnd.min.js": {
"bundled": 306810,
"minified": 108365,
"gzipped": 31340
"gzipped": 31339
},
"dist/react-beautiful-dnd.esm.js": {
"bundled": 240910,
"minified": 125371,
"gzipped": 32650,
"dist/dnd.esm.js": {
"bundled": 240861,
"minified": 125322,
"gzipped": 32669,
"treeshaked": {
"rollup": {
"code": 21121,
Expand Down
File renamed without changes
22 changes: 11 additions & 11 deletions .storybook/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ import GlobalStylesDecorator from './custom-decorators/global-styles';
// adding css reset - storybook includes a css loader
import '@atlaskit/css-reset';
import { colors } from '@atlaskit/theme';
import logo from './compressed-logo-rbd.svg';
import logo from './compressed-logo-rfd.svg';
import { version } from '../package.json';

const theme = create({
brandImage: logo,
brandName: 'react-beautiful-dnd',
brandUrl: 'https://github.com/atlassian/react-beautiful-dnd',
brandName: '@react-forked/dnd',
brandUrl: 'https://github.com/react-forked/dnd',
});

addParameters({
Expand Down Expand Up @@ -41,15 +41,15 @@ const table = Object.prototype.hasOwnProperty.call(console, 'table')
? console.table
: console.log;

// Generated by: http://patorjk.com/software/taag/#p=display&f=ANSI%20Shadow&t=rbd
// Generated by: http://patorjk.com/software/taag/#p=display&f=ANSI%20Shadow&t=rfd
console.log(
`%c
██████╗ ████████████╗
██╔══██╗██╔══██╗██╔══██╗
██████╔╝██████╔╝██║ ██║
██╔══██╗██╔══██╗██║ ██║
██║ ██║██████╔╝██████╔╝
╚═╝ ╚═╝╚═════╝ ╚═════╝
██████╗ ███████╗██████╗
██╔══██╗██╔════╝██╔══██╗
██████╔╝███████║ ██║
██╔══██╗██╔══██║ ██║
██║ ██║████████╔╝
╚═╝ ╚═╝╚═ ╚═════╝
%cBeautiful and accessible drag and drop
`,
Expand All @@ -58,7 +58,7 @@ console.log(
);

table([
['react-beautiful-dnd version', version],
['@react-forked/dnd version', version],
['react version', React.version],
['process.env.NODE_ENV', process.env.NODE_ENV],
]);
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Changelog

This project adheres to [Semantic Versioning 2.0](http://semver.org/).
All release notes and upgrade notes can be found on our [Github Releases](https://github.com/atlassian/react-beautiful-dnd/releases) page.
All release notes and upgrade notes can be found on our [Github Releases](https://github.com/react-forked/dnd/releases) page.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

Thanks for considering contributing to `react-beautiful-dnd`! ❤️
Thanks for considering contributing to `@react-forked/dnd`! ❤️

There are a few categories of contribution so we'll go through them individually.

Expand All @@ -17,15 +17,15 @@ If you spot a bug you are welcome to raise it on our issue page. You are also we
If you would like to see a feature added to the library, here is what you do:

1. Have a read of `README.md` to understand the motivations of this library. It is fairly opinionated and is not intended to be a universal drag and drop library. As such, it will not support every drag and drop interaction.
2. Have a search through the [open and closed issues](https://github.com/atlassian/react-beautiful-dnd/issues?utf8=%E2%9C%93&q=is%3Aissue) to see if the feature you are requesting as already been requested.
2. Have a search through the [open and closed issues](https://github.com/react-forked/dnd/issues?utf8=%E2%9C%93&q=is%3Aissue) to see if the feature you are requesting as already been requested.
3. Have a clear and general purpose keyboard story for any feature request
4. Please [create an issue](https://github.com/atlassian/react-beautiful-dnd/issues/new) to discuss it.
4. Please [create an issue](https://github.com/react-forked/dnd/issues/new) to discuss it.

**Please do not raise a pull request directly**. There may be reasons why we will not add every feature to this library.

## Large contributions

If you are interested in making a large contribution to this library there is some recommended reading / training we suggest. There is a large amount of different libraries, techniques and tools used in `react-beautiful-dnd` and we have created a list with resources about them. Not everything in the list will be applicable to everyone. But it is a great reference and starting point for those who do not know where to start.
If you are interested in making a large contribution to this library there is some recommended reading / training we suggest. There is a large amount of different libraries, techniques and tools used in `@react-forked/dnd` and we have created a list with resources about them. Not everything in the list will be applicable to everyone. But it is a great reference and starting point for those who do not know where to start.

The online courses listed are no free - feel free to seek out alternatives if you want to. We recommend the egghead.io courses because they are quite comprehensive.

Expand Down Expand Up @@ -92,8 +92,8 @@ Here is some general reading about html5 drag and drop. It is worth having a rea

#### Prior work

It is worth looking at other libraries out there to see how they do drag and drop. Things to look at is their philosophy and api. `react-beautiful-dnd` is an opinionated, higher level abstraction than most drag and drop libraries. We do not need to support every use case. We need to find the right level of control while still maintaining a beautiful experience for the user, flexibility of use and a clean, powerful api.
It is worth looking at other libraries out there to see how they do drag and drop. Things to look at is their philosophy and api. `@react-forked/dnd` is an opinionated, higher level abstraction than most drag and drop libraries. We do not need to support every use case. We need to find the right level of control while still maintaining a beautiful experience for the user, flexibility of use and a clean, powerful api.

- [`react-dnd`](https://react-dnd.github.io/react-dnd/) - `react-beautiful-dnd` draws a fair amount of inspiration from `react-dnd`. Something to keep in mind is that `react-dnd` is designed to provide a set of drag and drop primitives which is a different set of goals to this project.
- [`react-sortable-hoc`](https://github.com/clauderic/react-sortable-hoc/) - on the surface this library looks similar to `react-beautiful-dnd`. I created a [comparison blog](https://medium.com/@alexandereardon/thanks-for-reaching-out-dimitar-nestorov-8c0bf9abe19) that explains the differences
- [`react-dnd`](https://react-dnd.github.io/react-dnd/) - `@react-forked/dnd` draws a fair amount of inspiration from `react-dnd`. Something to keep in mind is that `react-dnd` is designed to provide a set of drag and drop primitives which is a different set of goals to this project.
- [`react-sortable-hoc`](https://github.com/clauderic/react-sortable-hoc/) - on the surface this library looks similar to `@react-forked/dnd`. Alex Reardon created a [comparison blog](https://medium.com/@alexandereardon/thanks-for-reaching-out-dimitar-nestorov-8c0bf9abe19) that explains the differences
- [`jQuery sortable`](http://jqueryui.com/sortable/) - the king of drag and drop for a long time
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<p align="center">
<img src="https://user-images.githubusercontent.com/2182637/53611918-54c1ff80-3c24-11e9-9917-66ac3cef513d.png" alt="react beautiful dnd logo" />
</p>
<h1 align="center">react-beautiful-dnd <small><sup>(rbd)</sup></small></h1>
<h1 align="center">@react-forked/dnd <small><sup>(rfd)</sup></small></h1>

<div align="center">

**Beautiful** and **accessible** drag and drop for lists with [`React`](https://facebook.github.io/react/)

[![CircleCI branch](https://img.shields.io/circleci/project/github/atlassian/react-beautiful-dnd/master.svg)](https://circleci.com/gh/atlassian/react-beautiful-dnd/tree/master)
[![npm](https://img.shields.io/npm/v/react-beautiful-dnd.svg)](https://www.npmjs.com/package/react-beautiful-dnd)
[![CircleCI branch](https://img.shields.io/circleci/project/github/react-forked/dnd/master.svg)](https://circleci.com/gh/react-forked/dnd/tree/master)
[![npm](https://img.shields.io/npm/v/@react-forked/dnd.svg)](https://www.npmjs.com/package/@react-forked/dnd)

![quote application example](https://user-images.githubusercontent.com/2182637/53614150-efbed780-3c2c-11e9-9204-a5d2e746faca.gif)

[Play with this example if you want!](https://react-beautiful-dnd.netlify.com/iframe.html?selectedKind=board&selectedStory=simple)
[Play with this example if you want!](https://react-forked-dnd.netlify.com/iframe.html?selectedKind=board&selectedStory=simple)

</div>

Expand All @@ -28,7 +28,7 @@

## Get started 👩‍🏫

We have created [a free course on `egghead.io` 🥚](https://egghead.io/courses/beautiful-and-accessible-drag-and-drop-with-react-beautiful-dnd) to help you get started with `react-beautiful-dnd` as quickly as possible.
Alex Reardon has created [a free course on `egghead.io` 🥚](https://egghead.io/courses/beautiful-and-accessible-drag-and-drop-with-react-beautiful-dnd) (using [react-beautiful-dnd](https://github.com/atlassian/react-beautiful-dnd)) to help you get started with `@react-forked/dnd` as quickly as possible.

[![course-logo](https://user-images.githubusercontent.com/2182637/43372837-8c72d3f8-93e8-11e8-9d92-a82adde7718f.png)](https://egghead.io/courses/beautiful-and-accessible-drag-and-drop-with-react-beautiful-dnd)

Expand Down Expand Up @@ -60,22 +60,22 @@ We have created [a free course on `egghead.io` 🥚](https://egghead.io/courses/

## 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:
`@react-forked/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:

- 📖 [Rethinking drag and drop](https://medium.com/@alexandereardon/rethinking-drag-and-drop-d9f5770b4e6b)
- 🎧 [React podcast: fast, accessible and beautiful drag and drop](https://reactpodcast.simplecast.fm/17)

## 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`](https://github.com/react-dnd/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](https://www.quirksmode.org/blog/archives/2009/09/the_html5_drag.html) 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.
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`](https://github.com/react-dnd/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](https://www.quirksmode.org/blog/archives/2009/09/the_html5_drag.html) html5 drag and drop feature. `@react-forked/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-forked/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-forked/dnd` might not be for you depending on what your use case is.

## Documentation 📖

### About 👋

- [Installation](/docs/about/installation.md)
- [Examples and samples](/docs/about/examples.md)
- [Get started](https://egghead.io/courses/beautiful-and-accessible-drag-and-drop-with-react-beautiful-dnd)
- [Get started](https://egghead.io/courses/beautiful-and-accessible-drag-and-drop-with-react-beautiful-dnd) (This is using [react-beautiful-dnd](https://github.com/atlassian/react-beautiful-dnd))
- [Design principles](/docs/about/design-principles.md)
- [Animations](/docs/about/animations.md)
- [Accessibility](/docs/about/accessibility.md)
Expand Down Expand Up @@ -117,7 +117,7 @@ There are a lot of libraries out there that allow for drag and drop interactions
- [Avoiding image flickering](/docs/guides/avoiding-image-flickering.md)
- [Non-visible preset styles](/docs/guides/preset-styles.md)
- [How we detect scroll containers](/docs/guides/how-we-detect-scroll-containers.md)
- [How we use dom events](/docs/guides/how-we-use-dom-events.md) - _Useful if you need to build on top of `react-beautiful-dnd`_
- [How we use dom events](/docs/guides/how-we-use-dom-events.md) - _Useful if you need to build on top of `@react-forked/dnd`_
- [Adding `<Draggable />`s during a drag (11.x behaviour)](/docs/guides/changes-while-dragging.md) - _⚠️ Advanced_
- [Setting up Content Security Policy](/docs/guides/content-security-policy.md)

Expand All @@ -132,13 +132,15 @@ There are a lot of libraries out there that allow for drag and drop interactions

- [Engineering health](/docs/support/engineering-health.md)
- [Community and addons](/docs/support/community-and-addons.md)
- [Release notes and changelog](https://github.com/atlassian/react-beautiful-dnd/releases)
- [Release notes and changelog](https://github.com/react-forked/dnd/releases)
- [Upgrading](/docs/support/upgrading.md)
- [Road map](https://github.com/atlassian/react-beautiful-dnd/issues)
- [Road map](https://github.com/react-forked/dnd/issues)
- [Media](/docs/support/media.md)

## Read this in other languages 🌎

⚠️ These following translations are based on [react-beautiful-dnd](https://github.com/atlassian/react-beautiful-dnd).

- [![kr](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/South-Korea.png) **한글/Korean**](https://github.com/LeeHyungGeun/react-beautiful-dnd-kr)
- [![ru](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Russia.png) **На русском/Russian**](https://github.com/vtereshyn/react-beautiful-dnd-ru)
- [![pt](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Brazil.png) **Português/Portuguese**](https://github.com/dudestein/react-beautiful-dnd-pt)
Expand Down
Loading

0 comments on commit a494494

Please sign in to comment.