13.0.6 • Published 6 months ago

ngx-virtual-dnd-list v13.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

ngx-virtual-dnd-list

npm npm Software License

A virtual scrolling list component that can be sorted by dragging

Live demo

Simple usage

npm i ngx-virtual-dnd-list

virutal-list.module.ts

...
import { VirtualDndListModule } from 'ngx-virtual-dnd-list';

@NgModule({
  declarations: [
    ...
  ],
  imports: [
    ...
    VirtualDndListModule
  ],
  providers: []
})
export class VirtualListModule { }

virutal-list.component.ts

import { Component } from '@angular/core';

@Component({
  selector: 'virutal-list',
  template: `
    <div #scroller>
      <div
        virtual-dnd-list
        [scroller]="scroller"
        [dataKey]="'id'"
        [keeps]="30"
        [(ngModel)]="list"
        (ngModelChange)="onChange($event)"
      >
        <ng-template let-item let-index="index">
          <div class="list-item">
            <span>{{ index }}</span>
            <p>{{ item.text }}</p>
          </div>
        </ng-template>
      </div>
    </div>
  `,
  styles: [],
})
export class AppComponent {
  public list = [
    { id: 'a', text: 'aaa' },
    { id: 'b', text: 'bbb' },
    { id: 'c', text: 'ccc' },
    ...
  ];

  onChange(data) {
    // the data changes after the dragging ends
  }
}

EventEmitters

EventDescription
onTopscrolled to top
onBottomscrolled to bottom
onDragthe drag is started
onDropthe drag is completed
rangeChangetriggered when the range changes

Attributes

Required Attributes

PropTypeDescription
data-keyStringThe unique identifier of each piece of data, in the form of 'a.b.c'
scrollerHTMLElement \| DocumentVirtual list scrolling element

Optional Attributes

Commonly used

PropTypeDefaultDescription
keepsNumber30The number of lines rendered by the virtual scroll
sizeNumber-The estimated height of each piece of data, you can choose to pass it or not, it will be automatically calculated
handleFunction/String-Drag handle selector within list items
groupObject/String-string: 'name' or object: { name: 'group', put: true/false, pull: true/false/'clone', revertDrag: true/false }
directionvertical \| horizontalscroll direction
lockAxisx \| y-Axis on which dragging will be locked
tableModeBooleanfalseUsing Virtual Lists in Tabular Mode
keepOffsetBooleanfalseWhen scrolling up to load data, keep the same offset as the previous scroll
debounceTimeNumber0debounce time on scroll
throttleTimeNumber0throttle time on scroll

Uncommonly used

PropTypeDefaultDescription
wrapperHTMLElement-Virtual list wrapper
sortableBooleantrueAllow Sorting by Dragging
draggableString.virtual-dnd-list-itemSpecifies which items inside the element should be draggable. If does not set a value, the default list element can be dragged
itemClassStringvirtual-dnd-list-itemDefault item class
disabledBooleanfalseDisables the sortable if set to true
animationNumber150Animation speed moving items when sorting
autoScrollBooleantrueAutomatic scrolling when moving to the edge of the container
scrollSpeedObject{ x: 10, y: 10}Vertical&Horizontal scrolling speed (px)
scrollThresholdNumber55Threshold to trigger autoscroll
delayNumber0Time in milliseconds to define when the sorting should start
delayOnTouchOnlyBooleanfalseOnly delay on press if user is using touch
fallbackOnBodyBooleanfalseAppends the ghost element into the document's body
ghostClassString''The class of the mask element when dragging
ghostStyleObject{}The style of the mask element when dragging
chosenClassString''The class of the selected element when dragging
placeholderClassString''Class name for the drop placeholder

If a page has multiple virtual lists and the virtual lists are in the top-down structure, transfer the wrapper to avoid the situation that the page cannot be dragged.

Public Methods

MethodDescription
getSize(key)Get the size of the current item by unique key value
getOffset()Get the current scroll height
getClientSize()Get wrapper element client viewport size (width or height)
getScrollSize()Get all scroll size (scrollHeight or scrollWidth)
scrollToTop()Scroll to top of list
scrollToBottom()Scroll to bottom of list
scrollToKey(key)Scroll to the specified data-key position
scrollToIndex(index)Scroll to the specified index position
scrollToOffset(offset)Scroll to the specified offset

Usage

import { Component, ViewChild } from '@angular/core';
import { VirtualDndListComponent } from 'ngx-virtual-dnd-list';

@Component({
  selector: 'virutal-list',
  template: `
    <div #scroller>
      <virtual-dnd-list
        #virtualList
        ...
      >
        ...
      </virtual-dnd-list>
    </div>
    <button (click)="scrollToBottom()">scroll to bottom</button>
  `,
  styles: [],
})
export class VirtualListComponent {
  @ViewChild('virtualList') virtualList: VirtualDndListComponent;

  scrollToBottom() {
    this.virtualList.scrollToBottom();
  }
}
13.0.6

6 months ago

13.0.5

6 months ago

13.0.4

1 year ago

13.0.3

1 year ago

13.0.2

1 year ago

13.0.1

1 year ago

13.0.0

1 year ago