Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swimlane/ngx-dnd
🕶 Drag, Drop and Sorting Library for Angular2 and beyond!
https://github.com/swimlane/ngx-dnd
angular angular2 drag-and-drop hacktoberfest ngx sorting
Last synced: about 2 months ago
JSON representation
🕶 Drag, Drop and Sorting Library for Angular2 and beyond!
- Host: GitHub
- URL: https://github.com/swimlane/ngx-dnd
- Owner: swimlane
- License: mit
- Created: 2017-02-27T17:56:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-30T08:58:31.000Z (8 months ago)
- Last Synced: 2024-07-16T11:18:28.754Z (2 months ago)
- Topics: angular, angular2, drag-and-drop, hacktoberfest, ngx, sorting
- Language: TypeScript
- Homepage: https://swimlane.github.io/ngx-dnd/
- Size: 22.9 MB
- Stars: 574
- Watchers: 56
- Forks: 137
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - swimlane/ngx-dnd - 🕶 Drag, Drop and Sorting Library for Angular2 and beyond! (TypeScript)
README
# ngx-dnd
[](https://www.codacy.com/app/hypercubed/ngx-dnd?utm_source=github.com&utm_medium=referral&utm_content=swimlane/ngx-dnd&utm_campaign=Badge_Grade) [](https://npmjs.org/@swimlane/ngx-dnd)
🕶 Drag, Drop and Sorting Library for Angular6 and beyond!
_Note: The drag-and-drop directives in [angular/cdk](https://material.angular.io/cdk/drag-drop/overview) are great. Use that if you don't need nested DnD containers. We are investigating using angular/cdk directives internally_
## Features
- Drag and Drop
- Sorting
- Events (drag, drop, over, out)
- Nesting
- Touch support
- Templating
## Install
To use ngx-dnd in your project install it via [npm](https://www.npmjs.com/package/@swimlane/ngx-dnd):
- `npm i @swimlane/ngx-dnd @swimlane/dragula @types/dragula --save`
- Add `NgxDnDModule.forRoot()` to your application module.
- If using directives you will need to BYO styles or include `@swimlane/ngx-dnd/release/index.css`.
- You may need to add the following to your `polyfills.ts` file:
```js
if (typeof window['global'] === 'undefined') {
window['global'] = window;
}
```
## Quick intro and examples
### Directives
`ngx-dnd` provides a base set of directives to enable drag-and-drop. By default all children of a `ngxDroppable` element may be dragged and dropped. Add the `ngxDraggable` to restrict drag-and-drop to the parent container. In general prefer using the base directives to the help components introduced later.
```html
Item 1
Item 2
Item 3
```
Give multiple containers the same `dropZone` name to allow drag-and-drop between these containers.
```html
Item 1a
Item 2a
Item 3a
Item 1b
Item 2b
Item 3b
```
`ngxDraggable` items can be restricted to specific containers:
```html
Item 1a
Item 2a
Item 3a
Item 1b
Item 2b
Item 3b
```
### Components
`ngx-dnd` provides a set of helper components that encapsulates the directives mentioned and adds capability for data driven structures. In general you should prefer directives to components.
```js
orderableLists = [
['Item 1a', 'Item 2a', 'Item 3a'],
['Item 1b', 'Item 2b', 'Item 3b']
];
```
```html
```
This component is effectively equivalent to:
```html
{{item}}
```
Including nested containers:
```html
```
```js
nestedLists = [
{
label: 'Item 1',
children: []
},
{
label: 'Item 2',
children: [
{
label: 'Item 2a',
children: []
},
{
label: 'Item 2b',
children: []
},
{
label: 'Item 2c',
children: []
}
]
},
{
label: 'Item 3',
children: [
{
label: 'Item 3a',
children: []
},
{
label: 'Item 3b',
children: []
},
{
label: 'Item 3c',
children: []
}
]
}
];
```
See [https://swimlane.github.io/ngx-dnd/](https://swimlane.github.io/ngx-dnd/) for more lives examples. Demo code is at [https://github.com/swimlane/ngx-dnd/tree/master/src/](https://github.com/swimlane/ngx-dnd/tree/master/src/).
## Development
- `git clone [email protected]:swimlane/ngx-dnd.git`
- `cd ngx-dnd`
- `ng build @swimlane/ngx-dnd`
- `ng serve`
- Browse to [http://localhost:4200](http://localhost:4200)
### Development server
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
### Build
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
### Running unit tests
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
### Running end-to-end tests
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
### Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
## [CHANGELOG](https://github.com/swimlane/ngx-dnd/blob/master/CHANGELOG.md)
This project uses [heff/chg](https://github.com/heff/chg), a simple changelog/release history manager. When contributing to this project please add change notes (manually or using the [heff/chg](https://github.com/heff/chg) cli) to the `## HEAD (Unreleased)` section.
## Release
- Checkout master (`git checkout master`)
- Pull master (`git pull`)
- Clean and test (Optional)
- Run `rm -rf node_modules`
- Run `npm i`
- Run tests (`npm run test:ci`)
- Examine CHANGELOG.md to determine next version (X.Y.Z)
- Run `git checkout -b release/X.Y.Z`
- Update version using `npm version [ | major | minor | patch]`
- This will update `package.json` versions and `changelog.md`.
- Run `git push origin HEAD --tags`
- Run `npm run publish:lib`
- Run `npm run deploy`
- Submit PR
## Credits
`ngx-dnd` is a [Swimlane](http://swimlane.com) open-source project; we believe in giving back to the open-source community by sharing some of the projects we build for our application. Swimlane is an automated cyber security operations and incident response platform that enables cyber security teams to leverage threat intelligence, speed up incident response and automate security operations.