Sortable
v1.15.3
Sortierbar ist eine JavaScript-Bibliothek für neu abgestellte Drag-and-Drop-Listen.
Demo: http://sortablejs.github.io/sortable/
@types/sortablejsInstallieren Sie mit NPM:
npm install sortablejs --saveMit Bower installieren:
bower install --save sortablejsIn Ihr Projekt importieren:
// Default SortableJS
import Sortable from 'sortablejs' ;
// Core SortableJS (without default plugins)
import Sortable from 'sortablejs/modular/sortable.core.esm.js' ;
// Complete SortableJS (with all plugins)
import Sortable from 'sortablejs/modular/sortable.complete.esm.js' ;Cherrypick -Plugins:
// Cherrypick extra plugins
import Sortable , { MultiDrag , Swap } from 'sortablejs' ;
Sortable . mount ( new MultiDrag ( ) , new Swap ( ) ) ;
// Cherrypick default plugins
import Sortable , { AutoScroll } from 'sortablejs/modular/sortable.core.esm.js' ;
Sortable . mount ( new AutoScroll ( ) ) ; < ul id =" items " >
< li > item 1 </ li >
< li > item 2 </ li >
< li > item 3 </ li >
</ ul > var el = document . getElementById ( 'items' ) ;
var sortable = Sortable . create ( el ) ; Sie können jedes Element für die Liste und ihre Elemente verwenden, nicht nur ul / li . Hier ist ein Beispiel mit div .
var sortable = new Sortable ( el , {
group : "name" , // or { name: "...", pull: [true, false, 'clone', array], put: [true, false, array] }
sort : true , // sorting inside list
delay : 0 , // time in milliseconds to define when the sorting should start
delayOnTouchOnly : false , // only delay if user is using touch
touchStartThreshold : 0 , // px, how many pixels the point should move before cancelling a delayed drag event
disabled : false , // Disables the sortable if set to true.
store : null , // @see Store
animation : 150 , // ms, animation speed moving items when sorting, `0` — without animation
easing : "cubic-bezier(1, 0, 0, 1)" , // Easing for animation. Defaults to null. See https://easings.net/ for examples.
handle : ".my-handle" , // Drag handle selector within list items
filter : ".ignore-elements" , // Selectors that do not lead to dragging (String or Function)
preventOnFilter : true , // Call `event.preventDefault()` when triggered `filter`
draggable : ".item" , // Specifies which items inside the element should be draggable
dataIdAttr : 'data-id' , // HTML attribute that is used by the `toArray()` method
ghostClass : "sortable-ghost" , // Class name for the drop placeholder
chosenClass : "sortable-chosen" , // Class name for the chosen item
dragClass : "sortable-drag" , // Class name for the dragging item
swapThreshold : 1 , // Threshold of the swap zone
invertSwap : false , // Will always use inverted swap zone if set to true
invertedSwapThreshold : 1 , // Threshold of the inverted swap zone (will be set to swapThreshold value by default)
direction : 'horizontal' , // Direction of Sortable (will be detected automatically if not given)
forceFallback : false , // ignore the HTML5 DnD behaviour and force the fallback to kick in
fallbackClass : "sortable-fallback" , // Class name for the cloned DOM Element when using forceFallback
fallbackOnBody : false , // Appends the cloned DOM Element into the Document's Body
fallbackTolerance : 0 , // Specify in pixels how far the mouse should move before it's considered as a drag.
dragoverBubble : false ,
removeCloneOnHide : true , // Remove the clone element when it is not showing, rather than just hiding it
emptyInsertThreshold : 5 , // px, distance mouse must be from empty sortable to insert drag element into it
setData : function ( /** DataTransfer */ dataTransfer , /** HTMLElement*/ dragEl ) {
dataTransfer . setData ( 'Text' , dragEl . textContent ) ; // `dataTransfer` object of HTML5 DragEvent
} ,
// Element is chosen
onChoose : function ( /**Event*/ evt ) {
evt . oldIndex ; // element index within parent
} ,
// Element is unchosen
onUnchoose : function ( /**Event*/ evt ) {
// same properties as onEnd
} ,
// Element dragging started
onStart : function ( /**Event*/ evt ) {
evt . oldIndex ; // element index within parent
} ,
// Element dragging ended
onEnd : function ( /**Event*/ evt ) {
var itemEl = evt . item ; // dragged HTMLElement
evt . to ; // target list
evt . from ; // previous list
evt . oldIndex ; // element's old index within old parent
evt . newIndex ; // element's new index within new parent
evt . oldDraggableIndex ; // element's old index within old parent, only counting draggable elements
evt . newDraggableIndex ; // element's new index within new parent, only counting draggable elements
evt . clone // the clone element
evt . pullMode ; // when item is in another sortable: `"clone"` if cloning, `true` if moving
} ,
// Element is dropped into the list from another list
onAdd : function ( /**Event*/ evt ) {
// same properties as onEnd
} ,
// Changed sorting within list
onUpdate : function ( /**Event*/ evt ) {
// same properties as onEnd
} ,
// Called by any change to the list (add / update / remove)
onSort : function ( /**Event*/ evt ) {
// same properties as onEnd
} ,
// Element is removed from the list into another list
onRemove : function ( /**Event*/ evt ) {
// same properties as onEnd
} ,
// Attempt to drag a filtered element
onFilter : function ( /**Event*/ evt ) {
var itemEl = evt . item ; // HTMLElement receiving the `mousedown|tapstart` event.
} ,
// Event when you move an item in the list or between lists
onMove : function ( /**Event*/ evt , /**Event*/ originalEvent ) {
// Example: https://jsbin.com/nawahef/edit?js,output
evt . dragged ; // dragged HTMLElement
evt . draggedRect ; // DOMRect {left, top, right, bottom}
evt . related ; // HTMLElement on which have guided
evt . relatedRect ; // DOMRect
evt . willInsertAfter ; // Boolean that is true if Sortable will insert drag element after target by default
originalEvent . clientY ; // mouse position
// return false; — for cancel
// return -1; — insert before target
// return 1; — insert after target
// return true; — keep default insertion point based on the direction
// return void; — keep default insertion point based on the direction
} ,
// Called when creating a clone of element
onClone : function ( /**Event*/ evt ) {
var origEl = evt . item ;
var cloneEl = evt . clone ;
} ,
// Called when dragging element changes position
onChange : function ( /**Event*/ evt ) {
evt . newIndex // most likely why this event is used is to get the dragging element's current index
// same properties as onEnd
}
} ) ; group Um Elemente aus einer Liste in eine andere zu ziehen, müssen beide Listen den gleichen group haben. Sie können auch definieren, ob Listen eine Kopie verschenken, geben und aufbewahren können ( clone ) und Elemente empfangen können.
String - Gruppennametrue|false|["foo", "bar"]|'clone'|function - Fähigkeit, sich aus der Liste zu bewegen. clone - Kopieren Sie den Artikel anstatt sich zu bewegen. Oder eine Reihe von Gruppennamen, die die Elemente eingegeben werden können. true .true|false|["baz", "qux"]|function - ob Elemente aus anderen Listen hinzugefügt werden können oder ein Array von Gruppennamen, aus denen Elemente hinzugefügt werden können.boolean - Nach dem Umzug in eine andere Liste das geklonte Element in die Anfangsposition zurückkehren.Demo:
pull und putrevertClone: true sortErmöglichen Sie die Sortierung in der Liste.
Demo: https://jsbin.com/jayedig/edit?js, output
delayZeit in Millisekunden zu definieren, wann die Sortierung beginnen sollte. Leider ist die Verzögerung aufgrund von Browserbeschränkungen bei IE oder Kante mit nativem Drag & Drop nicht möglich.
Demo: https://jsbin.com/zosiwah/edit?js, output
delayOnTouchOnly Option Ob die Verzögerung nur angewendet werden sollte oder nicht, wenn der Benutzer Touch verwendet (z. B. auf einem mobilen Gerät). In einem anderen Fall wird keine Verzögerung angewendet. Standardmäßig false .
swapThreshold -Option Prozentsatz des Ziels, dass die Tauschzone als Schwimmer zwischen 0 und 1 in Anspruch nimmt.
Mehr lesen
Demo: http://sortablejs.github.io/sortable#thresholds
invertSwap -Option Setzen Sie auf true , um die Tauschzone auf die Seiten des Ziels zu setzen, um den Effekt der Sortierung "zwischen" zwischen "Elementen" zu sortieren.
Mehr lesen
Demo: http://sortablejs.github.io/sortable#thresholds
invertedSwapThreshold Option Prozentsatz des Ziels, dass die umgekehrte Tauschzone als Schwimmer zwischen 0 und 1 in Anspruch nimmt. Wenn nicht gegeben, wird die swapThreshold standardmäßig.
Mehr lesen
direction Richtung, in die die sortierbare sortiert werden sollte. Kann auf 'vertical' , 'horizontal' oder eine Funktion eingestellt werden, die aufgerufen wird, wenn ein Ziel übergezogen wird. Muss 'vertical' oder 'horizontal' zurückkehren.
Mehr lesen
Beispiel für die Richtungserkennung für vertikale Liste, die vollständige Spalten und halbe Spaltenelemente enthält:
Sortable . create ( el , {
direction : function ( evt , target , dragEl ) {
if ( target !== null && target . className . includes ( 'half-column' ) && dragEl . className . includes ( 'half-column' ) ) {
return 'horizontal' ;
}
return 'vertical' ;
}
} ) ; touchStartThreshold -Option Diese Option ähnelt der Option fallbackTolerance .
Wenn die delay festgelegt ist, werden einige Telefone mit sehr empfindlichen Touchs wie das Samsung Galaxy S8 unerwünschte Touchmove -Ereignisse abfeuern, selbst wenn sich Ihr Finger nicht bewegt, was dazu führt, dass die Sortierung nicht ausgelöst wird.
Diese Option legt die minimale Zeigerbewegung fest, die auftreten muss, bevor die verzögerte Sortierung storniert wird.
Die Werte zwischen 3 und 5 sind gut.
disabled Optionen Deaktiviert die sortierbare, wenn sie auf true gesetzt werden.
Demo: https://jsbin.com/sewokud/edit?js, output
var sortable = Sortable . create ( list ) ;
document . getElementById ( "switcher" ) . onclick = function ( ) {
var state = sortable . option ( "disabled" ) ; // get
sortable . option ( "disabled" , ! state ) ; // set
} ; handleUm Listenelemente zu erstellen, dragable, sortierbar deaktiviert die Textauswahl durch den Benutzer. Das ist nicht immer wünschenswert. Definieren Sie einen Drag -Handler, der ein Bereich jedes Listenelements darstellt, um sich umzog.
Demo: https://jsbin.com/numakuh/edit?html.js,output
Sortable . create ( el , {
handle : ".my-handle"
} ) ; < ul >
< li > < span class =" my-handle " > :: </ span > list item text one
< li > < span class =" my-handle " > :: </ span > list item text two
</ ul > . my-handle {
cursor : move;
cursor : -webkit-grabbing;
}filter Sortable . create ( list , {
filter : ".js-remove, .js-edit" ,
onFilter : function ( evt ) {
var item = evt . item ,
ctrl = evt . target ;
if ( Sortable . utils . is ( ctrl , ".js-remove" ) ) { // Click on remove button
item . parentNode . removeChild ( item ) ; // remove sortable item
}
else if ( Sortable . utils . is ( ctrl , ".js-edit" ) ) { // Click on edit link
// ...
}
}
} ) ghostClass Klassenname für den Drop-Platzhalter (Standard sortable-ghost ).
Demo: https://jsbin.com/henuyiw/edit?css.js, output
. ghost {
opacity : 0.4 ;
} Sortable . create ( list , {
ghostClass : "ghost"
} ) ; chosenClass -Option Klassenname für das ausgewählte Element (Standard sortable-chosen ).
Demo: https://jsbin.com/hoqufox/edit?css.js,output
. chosen {
color : # fff ;
background-color : # c00 ;
} Sortable . create ( list , {
delay : 500 ,
chosenClass : "chosen"
} ) ; forceFallback -Option Wenn sie auf true gesetzt sind, wird der Fallback für Non -HTML5 -Browser verwendet, auch wenn wir einen HTML5 -Browser verwenden. Dies gibt uns die Möglichkeit, das Verhalten für ältere Browser auch im neueren Browser zu testen oder das Drag' -N -Drop -Dropfen zwischen Desktop, Mobile und alten Browsern konsistenter zu fühlen.
Darüber hinaus generiert der Fallback immer eine Kopie dieses DOM -Elements und findet die in den Optionen definierte fallbackClass an. Dieses Verhalten steuert das Aussehen dieses "gezogenen" Elements.
Demo: https://jsbin.com/sibiput/edit?html,css.js,output
fallbackToleranceEmuliert die einheimische Dragschwelle. Geben Sie in Pixeln an, wie weit sich die Maus bewegen sollte, bevor sie als Drag betrachtet wird. Nützlich, wenn die Elemente wie in einer Liste von Links auch klickbar sind.
Wenn der Benutzer in ein sortierbares Element klickt, ist es nicht ungewöhnlich, dass sich Ihre Hand zwischen der Zeit, in der Sie drücken, und der Zeit, in der Sie veröffentlichen, ein wenig bewegen können. Das Ziehen beginnt nur, wenn Sie den Zeiger an einer bestimmten Toleranz hinaus verschieben, damit Sie nicht jedes Mal, wenn Sie klicken, versehentlich anfangen.
3 bis 5 sind wahrscheinlich gute Werte.
dragoverBubble -Option Wenn auf true gesetzt, sprudelt das Dragover -Ereignis zu übergeordneten Sortables. Arbeitet sowohl zum Fallback als auch zum nativen Dragover -Event. Standardmäßig ist es falsch, aber sortierbar hört es nur zu, das Ereignis zu sprudeln, sobald das Element in ein übergeordnetes sortierbares Sortierbar eingefügt wurde oder in ein übergeordnetes sortierbares Sortierbar eingefügt werden kann , aber nicht zu dieser bestimmten Zeit (aufgrund von Animation usw.) nicht .
Seit 1.8.0 möchten Sie diese Option wahrscheinlich als falsch hinterlassen. Vor 1.8.0 müssen true geschachtelte sortierbare zu funktionieren.
removeCloneOnHide Option Wenn der Klon auf false gesetzt ist, wird der Klon versteckt, indem seine CSS display auf none festgelegt ist. Standardmäßig ist diese Option true , was bedeutet, dass sortierbar das geklonte Element aus dem DOM entfernt wird, wenn es versteckt sein soll.
emptyInsertThreshold -Option Die Entfernung (in Pixeln) Die Maus muss von einem leeren sortierbaren Sortierbar erfolgen, während das Dragelement in diese sortierbare Einfügung eingefügt wird. Standardeinstellung auf 5 . Setzen Sie auf 0 um diese Funktion zu deaktivieren.
Demo: https://jsbin.com/becavoj/edit?js, output
Eine Alternative zu dieser Option wäre, eine Polsterung auf Ihre Liste zu setzen, wenn sie leer ist.
Zum Beispiel:
ul : empty {
padding-bottom : 20 px ;
} WARNUNG: Für :empty um zu arbeiten, muss es keinen Knoten im Inneren haben (sogar Text eins).
Demo: https://jsbin.com/yunakeg/edit?html,css.js,output
HTMLElement - Liste, in dem sich das Element bewegtHTMLElement - vorherige ListeHTMLElement - Ziehte ElementHTMLElementNumber|undefined - Old Index innerhalb der ElternNumber|undefined - neuer Index innerhalb der übergeordnetenNumber|undefined - alter Index innerhalb der Eltern, nur draggable Elemente zählenNumber|undefined - neuer Index innerhalb der Eltern, nur draggable Elemente zählenString|Boolean|undefined - Zugmodus, wenn Sie in ein anderes sortierbares Ziehen ( "clone" , true oder false ), ansonsten undefiniertes Ziehen moveHTMLElementHTMLElementHTMLElementDOMRectHTMLElement - Element, auf dem geführt wurdeDOMRectBoolean - true , wenn Element nach dem Ziel eingefügt wird (oder false , wenn zuvor)String [, Wert: * ]): *Holen Sie sich die Option oder setzen Sie die Option.
HTMLElement [, Selektor: String ]): HTMLElement|nullHolen Sie sich für jedes Element im Satz das erste Element, das dem Selektor entspricht, indem Sie das Element selbst testen und durch seine Vorfahren im Dom -Baum fahren.
String[] Serialisiert die sortierbare Elementdaten data-id ( dataIdAttr -Option) in ein Array von String.
String[] , useanimation: Boolean )Sortiert die Elemente nach dem Array.
var order = sortable . toArray ( ) ;
sortable . sort ( order . reverse ( ) , true ) ; // apply Speichern Sie die aktuelle Sortierung (siehe Store)
Entfernt die sortierbare Funktionalität vollständig.
Speichern und Wiederherstellen der Art.
< ul >
< li data-id =" 1 " > order </ li >
< li data-id =" 2 " > save </ li >
< li data-id =" 3 " > restore </ li >
</ ul > Sortable . create ( el , {
group : "localStorage-example" ,
store : {
/**
* Get the order of elements. Called once during initialization.
* @param {Sortable} sortable
* @returns {Array}
*/
get : function ( sortable ) {
var order = localStorage . getItem ( sortable . options . group . name ) ;
return order ? order . split ( '|' ) : [ ] ;
} ,
/**
* Save the order of elements. Called onEnd (when the item is dropped).
* @param {Sortable} sortable
*/
set : function ( sortable ) {
var order = sortable . toArray ( ) ;
localStorage . setItem ( sortable . options . group . name , order . join ( '|' ) ) ;
}
}
} )Demo: https://jsbin.com/visimub/edit?html,js,output
<!-- Latest compiled and minified CSS -->
< link rel =" stylesheet " href =" https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css "/>
<!-- Latest Sortable -->
< script src =" http://SortableJS.github.io/Sortable/Sortable.js " > </ script >
<!-- Simple List -->
< ul id =" simpleList " class =" list-group " >
< li class =" list-group-item " > This is < a href =" http://SortableJS.github.io/Sortable/ " > Sortable </ a > </ li >
< li class =" list-group-item " > It works with Bootstrap... </ li >
< li class =" list-group-item " > ...out of the box. </ li >
< li class =" list-group-item " > It has support for touch devices. </ li >
< li class =" list-group-item " > Just drag some elements around. </ li >
</ ul >
< script >
// Simple list
Sortable . create ( simpleList , { /* options */ } ) ;
</ script >HTMLElement [, Optionen: Object ]): SortableNeue Instanz erstellen.
SortableDie aktive sortierbare Instanz.
HTMLElementDas Element wird gezogen.
HTMLElementDas Geisterelement.
HTMLElementDas Klonelement.
HTMLElement ): SortableHolen Sie sich die sortierbare Instanz auf ein Element.
...SortablePlugin|SortablePlugin[] )Montiert ein Plugin an sortierbar.
:HTMLElement , Ereignis :String , FN :Function ) - Anhängen einer Ereignishandlerfunktion:HTMLElement , Ereignis :String , FN :Function ) - Entfernen Sie einen Ereignishandler:HTMLElement ) :Object - Erhalten Sie die Werte aller CSS -Eigenschaften:HTMLElement :String :Mixed:HTMLElement , Requisite :String , Wert :String ) - Stellen Sie eine CSS -Eigenschaften fest:HTMLElement , Requisiten :Object ) - Setzen Sie mehr CSS -Eigenschaften:HTMLElement , tagname :String [, Iterator :Function ]) :Array - Elemente nach Tag -Name abrufen:Mixed , fn :Function ) :Function - nimmt eine Funktion und gibt eine neue zurück, die immer einen bestimmten Kontext hat:HTMLElement , Selector :String ) :Boolean - Überprüfen Sie den aktuellen übereinstimmenden Elementsatz gegen einen Selektor:HTMLElement , Selector :String [, CTX :HTMLElement ]) :HTMLElement|Null - Für jedes Element im Set erhalten Sie das erste Element, das dem Selektor entspricht, indem Sie das Element selbst testen und durch seine Vorfahren in der DOM durchqueren Baum:HTMLElement ) :HTMLElement - Erstellen Sie eine tiefe Kopie des Satzes der übereinstimmten Elemente:HTMLElement , Name :String , Status :Boolean ) - Fügen Sie einen Klassen aus jedem Element hinzu oder entfernen Sie sie:HTMLElement ) :String - Erkennen Sie automatisch die Richtung des Elements als 'vertical' oder 'horizontal':HTMLElement , Selektor :String ) :Number - Index des Elements innerhalb seines übergeordneten für einen ausgewählten Satz von Elementen:HTMLElement , Childnum :Number , Optionen :Object , inklusive ragel :Boolean ): HTMLElement - Holen Sie sich das draggable Element bei einem bestimmten Index von draggierbaren Elementen innerhalb einer sortierbaren Instanz:String - Explosion -Eigenschaftsname für den internen Gebrauch, SortableListelement [Expino] Gibt die sortierbare Instanz dieses Elemenet zurück <!-- jsDelivr :: Sortable :: Latest (https://www.jsdelivr.com/package/npm/sortablejs) -->
< script src =" https://cdn.jsdelivr.net/npm/sortablejs@latest/Sortable.min.js " > </ script >Bitte lesen Sie das.
Dieses Projekt besteht dank aller Menschen, die einen Beitrag leisten. [Beitragen].
Werden Sie ein finanzieller Mitwirkender und helfen Sie uns, unsere Gemeinschaft aufrechtzuerhalten. [Beitragen]
Unterstützen Sie dieses Projekt mit Ihrer Organisation. Ihr Logo wird hier mit einem Link zu Ihrer Website angezeigt. [Beitragen]
Die Erlaubnis wird hiermit kostenlos an eine Person erteilt, die eine Kopie dieser Software und zugehörigen Dokumentationsdateien ("Software") erhält, um die Software ohne Einschränkung zu behandeln, einschließlich ohne Einschränkung der Rechte zu verwenden, zu kopieren, zu modifizieren, zu verschmelzen, verschmelzen , veröffentlichen, vertreiben, unterlizenzieren und/oder Kopien der Software verkaufen und Personen, denen die Software dazu bereitgestellt wird, unter den folgenden Bedingungen ermöglicht:
Die oben genannte Copyright -Mitteilung und diese Erlaubnisbekanntmachung müssen in alle Kopien oder wesentlichen Teile der Software enthalten sein.
Die Software wird "wie es ist" ohne Garantie jeglicher Art, ausdrücklich oder stillschweigend bereitgestellt, einschließlich, aber nicht beschränkt auf die Gewährleistung der Handelsfähigkeit, die Eignung für einen bestimmten Zweck und die Nichtverletzung. In keinem Fall haftet die Autoren oder Urheberrechtsinhaber für Ansprüche, Schäden oder andere Haftungen, sei es in einer Vertragsklage, unerlaubter Handlung oder anderweitig, aus oder im Zusammenhang mit der Software oder anderen Geschäften in der SOFTWARE.
