Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bfwg/ngx-drag-scroll
A lightweight responsive Angular carousel library
https://github.com/bfwg/ngx-drag-scroll
angular angular7 carousel drag javascript typescript
Last synced: 5 days ago
JSON representation
A lightweight responsive Angular carousel library
- Host: GitHub
- URL: https://github.com/bfwg/ngx-drag-scroll
- Owner: bfwg
- License: mit
- Created: 2017-02-03T05:36:40.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-01-02T06:12:06.000Z (about 1 year ago)
- Last Synced: 2024-05-12T17:34:56.942Z (9 months ago)
- Topics: angular, angular7, carousel, drag, javascript, typescript
- Language: TypeScript
- Homepage: https://ngx-drag-scroll.fanjin.io
- Size: 13.4 MB
- Stars: 342
- Watchers: 9
- Forks: 95
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-angular-components - bfwg/ngx-drag-scroll - A lightweight responsive Angular carousel library (UI Components / Carousel)
- awesome-angular - ngx-drag-scroll - A lightweight responsive Angular carousel library. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-drag-scroll - A lightweight responsive Angular carousel library. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-drag-scroll - A lightweight responsive Angular carousel library. (Table of contents / Third Party Components)
README
# [Angular Draggable Carousel](https://bfwg.github.io/ngx-drag-scroll/)
Lightweight drag to scroll carousel for Angular
## Maintainers wanted
[](https://www.npmjs.com/package/ngx-drag-scroll)
[](https://www.npmjs.com/package/ngx-drag-scroll)
[](https://travis-ci.org/bfwg/ngx-drag-scroll)
[](https://github.com/bfwg/ngx-drag-scroll/blob/master/LICENSE)
_Scroll on drag!_
Try out the [demo](https://bfwg.github.io/ngx-drag-scroll/)!
# Install
You can get it on npm.
```shell
npm install ngx-drag-scroll --save
```
## Requirements
This project needs `Angular 5+` as dependencies though.
# Setup
Our component and directive are standalone now!
You'll need to import `DragScrollComponent` and/or `DragScrollItemDirective` to your application module or component.
## Module:
```typescript
import { DragScrollComponent, DragScrollItemDirective } from 'ngx-drag-scroll';
...
@NgModule({
declarations: [
AppComponent
],
imports: [
DragScrollComponent,
DragScrollItemDirective,
...
],
providers: [],
bootstrap: [ AppComponent ]
})
export class AppModule {
}
```
## Component:
```typescript
import { DragScrollComponent, DragScrollItemDirective } from 'ngx-drag-scroll';
@Component({
selector: 'sample',
template:`
`,
standalone: true,
imports: [
DragScrollComponent,
DragScrollItemDirective,
...
]
})
class Sample {}
```
Add the `drag-scroll` attribute to a scrollable element:
```typescript
@Component({
selector: 'sample',
template: ` Big text goes here... `,
styles: [
`
drag-scroll {
height: 50px
width: 100px
}
`
]
})
class SampleBigText {}
```
That's it! Now you can scroll it by dragging.
If you want to group items into a carousel, you will need to add `drag-scroll-item` to the carsousel items.
```typescript
@Component({
selector: 'sample',
template: `
`,
styles: [
`
drag-scroll {
height: 50px
width: 100px
}
img {
height: 50px
width: 50px
}
`
]
})
class SampleCarousel {}
```
## API REFERENCE
### DragScrollComponent
| Name | Type | Description | Default |
| ---------------------- | ------- | -------------------------------------------------------------------- | ------- |
| scrollbar-hidden | @Input | Whether the scroll bar for this element is hidden. | false |
| drag-scroll-disabled | @Input | Whether all draging and scrolling events is disabled. | false |
| drag-scroll-x-disabled | @Input | Whether horizontally dragging and scrolling events is disabled. | false |
| scroll-x-wheel-enabled | @Input | Whether scrolling horizontally with mouse wheel is enabled | false |
| drag-scroll-y-disabled | @Input | Whether vertically dragging and scrolling events is disabled. | false |
| drag-disabled | @Input | Whether draging is disabled. | false |
| snap-disabled | @Input | Whether snapping is disabled. | false |
| snap-offset | @Input | Pixels of previous element to show on snap or moving left and right. | 0 |
| snap-duration | @Input | Duration of snap animation in milliseconds. | 500 |
| reachesLeftBound | @Output | Whether reaching the left carousel bound. | n/a |
| reachesRightBound | @Output | Whether reaching the right carousel bound. | n/a |
| dragStart | @Output | Executes when drag start. | n/a |
| dragEnd | @Output | Executes when drag end. | n/a |
| snapAnimationFinished | @Output | The snap animation for the new selection has finished. | n/a |
| indexChanged | @Output | Executes when the current index of the carousel changes. | n/a |
| dsInitialized | @Output | Executes when the drag scroll component has been initialized. | n/a |
---
### DragScrollItemDirective
| Name | Type | Description | Default |
| ------------- | ------ | ---------------------------------------- | ------- |
| drag-disabled | @Input | Whether draging on the item is disabled. | false |
---
## Add navigation button
```typescript
@Component({
selector: 'sample',
template: `
Left
Right
Last
`
})
class Sample {
@ViewChild('nav', { read: DragScrollComponent }) ds: DragScrollComponent;
moveLeft() {
this.ds.moveLeft();
}
moveRight() {
this.ds.moveRight();
}
moveTo(index) {
this.ds.moveTo(index);
}
ngAfterViewInit() {
// Starting ngx-drag-scroll from specified index(3)
setTimeout(() => {
this.ds.moveTo(3);
}, 0);
}
}
```
### Contributing
Clone the repository, and run `npm install`, `npm run build ngx-drag-scroll`, `npm start`. The demo app will starts on port :4200. I usually do my development on the demo app.
I'll accept pretty much everything so feel free to open a Pull-Request.
We use commitlint for managing our commits. Check out [Contributing](CONTRIBUTING.md) for more details.
# License
[MIT](/LICENSE)