ReorderListComponent class
Provides a list that can reorder it's children using html5 drag&drop. A vertical reorder-list will use any component in its
reorderItems should be direct children of the reorder-list and, by
default, the entire element is a handle and may be dragged and dropped
to perfom reorder operations.
If a reorderItem component implements ReorderHandleProvider, the child
element marked with reorderHandle will be draggable for reorder
operations. This allows complex components to be reordered by a handle and
not have the entire component be listening to drag and drop events.
Attention: This component is not an implementation of the Material List reorder control from the Material Spec. There is currently no support for interactions on a mobile device.
User is responsible for listening to reorder events and updating order of elements accordingly
Warning: Reorder list does not work with a keyboard and so is not accessible.
- Annotations
-
- @Component(selector: 'reorder-list', templateUrl: 'reorder_list.html', styleUrls: ['reorder_list.scss.css'], visibility: Visibility.all)
Constructors
- ReorderListComponent(NgZone _ngZone)
Properties
-
delete
→ Stream<
int> -
Will emit int index of element to delete when delete is triggered.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
items
← List<
ReorderItemDirective> -
no getter
-
itemSelectionChanged
→ Stream<
ItemSelectionEvent> -
Will emit ItemSelectionEvent indexes of the newly selected elements.
no setter
- multiSelect ↔ bool
-
If true, enables selecting multiple items for drag and drop.
getter/setter pair
- placeholder ↔ HtmlElement?
-
getter/setter pair
-
reorder
→ Stream<
ReorderEvent> -
Will emit ReorderEvent after reordering has finished.
no setter
-
reorderAttempt
→ Stream<
ReorderEvent> -
Will emit ReorderEvent when the prospective reordering position has
changed.
no setter
-
reorderProgress
→ Stream<
ReorderEvent> -
Emits ReorderEvent with the source index and the currently hovered index
during a reorder.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showPlaceholder → bool
-
no setter
- verticalItems ↔ bool
-
If true (default), items are aligned vertically.
getter/setter pair
Methods
-
ngOnDestroy(
) → void - Executed before the directive is removed from the DOM and destroyed.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeAt(
int index) → void -
toString(
) → String -
A string representation of this object.
inherited
-
track(
HtmlElement element) → void - Starts listening to drag events for a child element.
-
unTrack(
HtmlElement element) → void
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- itemSelectedCssClass → String
-
final