jQuery UI API - Widget Ordenable (Sortable Widget)
Categoría
Uso
Descripción:Permite ajustar el orden de los elementos en una lista o cuadrícula con el ratón.
Nuevo en la versión:1.0
Dependencias:
- Núcleo de UI (UI Core)
- Fábrica de widgets (Widget Factory)
- Interacción con el ratón (Mouse Interaction)
Nota:El complemento Sortable de jQuery UI permite ordenar los elementos seleccionados mediante arrastre con el ratón.
Nota:Para ordenar filas de tabla,tbodydebe ser sortable (ordenable), notable。
Navegación rápida
| Opciones | Métodos | Eventos |
|---|---|---|
| Opciones | Tipo | Descripción | Valor predeterminado |
|---|---|---|---|
| appendTo | jQuery o Element o Selector o String | Dónde se agrega el asistente (helper) que se mueve con el ratón durante el arrastre (por ejemplo, para resolver problemas de overlap/zIndex). Tipos admitidos:
Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ appendTo: document.body });
Después de la inicialización, obtener o establecer la // getter var appendTo = $( ".selector" ).sortable( "option", "appendTo" ); // setter $( ".selector" ).sortable( "option", "appendTo", document.body ); |
"parent" |
| axis | String | Si se define esta opción, los elementos solo se pueden arrastrar horizontal o verticalmente. Valores posibles:"x", "y"。Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ axis: "x" });
Después de la inicialización, obtener o establecer la // getter var axis = $( ".selector" ).sortable( "option", "axis" ); // setter $( ".selector" ).sortable( "option", "axis", "x" ); |
false |
| cancel | Selector | Evita que la ordenación se inicie desde elementos que coinciden con el selector. Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ cancel: "a,button" });
Después de la inicialización, obtener o establecer la // getter var cancel = $( ".selector" ).sortable( "option", "cancel" ); // setter $( ".selector" ).sortable( "option", "cancel", "a,button" ); |
"input, textarea, button, select, option" |
| connectWith | Selector | Selector de otros elementos sortable a los que deben conectarse los elementos de la lista. Esta es una relación unidireccional; si desea que los elementos estén conectados en ambos sentidos, debe configurar laconnectWithopción.Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ connectWith: "#shopping-cart" });
Después de la inicialización, obtener o establecer la // getter var connectWith = $( ".selector" ).sortable( "option", "connectWith" ); // setter $( ".selector" ).sortable( "option", "connectWith", "#shopping-cart" ); |
false |
| containment | Element o Selector o String | Define los límites en los que se restringen los elementos sortable durante el arrastre. Nota: El elemento especificado para containment debe tener un ancho y una altura calculados (aunque no es necesario que sean explícitos). Por ejemplo, si tiene Tipos admitidos:
Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ containment: "parent" });
Después de la inicialización, obtener o establecer la // getter var containment = $( ".selector" ).sortable( "option", "containment" ); // setter $( ".selector" ).sortable( "option", "containment", "parent" ); |
false |
| cursor | String | Define el cursor que se muestra al ordenar. Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ cursor: "move" });
Después de la inicialización, obtener o establecer la // getter var cursor = $( ".selector" ).sortable( "option", "cursor" ); // setter $( ".selector" ).sortable( "option", "cursor", "move" ); |
"auto" |
| cursorAt | Object | Mueve el elemento ordenable o el asistente (helper) para que el cursor siempre aparezca y se pueda arrastrar desde la misma posición. Las coordenadas se pueden dar como un hash con una o dos claves:{ top, left, right, bottom }。Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ cursorAt: { left: 5 } });
Después de la inicialización, obtener o establecer la
// getter
var cursorAt = $( ".selector" ).sortable( "option", "cursorAt" );
// setter
$( ".selector" ).sortable( "option", "cursorAt", { left: 5 } );
|
false |
| delay | Integer | Tiempo en milisegundos desde que se presiona el botón del ratón hasta que comienza la ordenación. Esta opción puede evitar arrastres innecesarios al hacer clic en un elemento. Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ delay: 150 });
Después de la inicialización, obtener o establecer la // getter var delay = $( ".selector" ).sortable( "option", "delay" ); // setter $( ".selector" ).sortable( "option", "delay", 150 ); |
0 |
| disabled | Boolean | Si se establece entrue, el sortable se deshabilita.Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ disabled: true });
Después de la inicialización, obtener o establecer la // getter var disabled = $( ".selector" ).sortable( "option", "disabled" ); // setter $( ".selector" ).sortable( "option", "disabled", true ); |
false |
| distance | Number | Distancia en píxeles que el ratón debe moverse después de presionar el botón antes de que comience la ordenación. Si se especifica esta opción, la ordenación solo comienza cuando el ratón se ha arrastrado más allá de la distancia especificada. Esta opción puede usarse para permitir hacer clic en elementos dentro de un controlador (handle). Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ distance: 5 });
Después de la inicialización, obtener o establecer la // getter var distance = $( ".selector" ).sortable( "option", "distance" ); // setter $( ".selector" ).sortable( "option", "distance", 5 ); |
1 |
| dropOnEmpty | Boolean | Si esfalse, los elementos de este sortable no se pueden colocar en un sortable conectado vacío (consulte la opciónconnectWith).Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ dropOnEmpty: false });
Después de la inicialización, obtener o establecer la // getter var dropOnEmpty = $( ".selector" ).sortable( "option", "dropOnEmpty" ); // setter $( ".selector" ).sortable( "option", "dropOnEmpty", false ); |
true |
| forceHelperSize | Boolean | Si estrue, el asistente (helper) adquiere un tamaño forzado.Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ forceHelperSize: true });
Después de la inicialización, obtener o establecer la // getter var forceHelperSize = $( ".selector" ).sortable( "option", "forceHelperSize" ); // setter $( ".selector" ).sortable( "option", "forceHelperSize", true ); |
false |
| forcePlaceholderSize | Boolean | Si estrue, el marcador de posición (placeholder) adquiere un tamaño forzado.Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ forcePlaceholderSize: true });
Después de la inicialización, obtener o establecer la // getter var forcePlaceholderSize = $( ".selector" ).sortable( "option", "forcePlaceholderSize" ); // setter $( ".selector" ).sortable( "option", "forcePlaceholderSize", true ); |
false |
| grid | Array | Alinea los elementos ordenables o el asistente (helper) a una cuadrícula de x e y píxeles. El array debe tener la forma[ x, y ]。Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ grid: [ 20, 10 ] });
Después de la inicialización, obtener o establecer la // getter var grid = $( ".selector" ).sortable( "option", "grid" ); // setter $( ".selector" ).sortable( "option", "grid", [ 20, 10 ] ); |
false |
| handle | Selector o Element | Si se especifica esta opción, la ordenación se limita a iniciarse en el elemento especificado. Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ handle: ".handle" });
Después de la inicialización, obtener o establecer la // getter var handle = $( ".selector" ).sortable( "option", "handle" ); // setter $( ".selector" ).sortable( "option", "handle", ".handle" ); |
false |
| helper | String o Function() | Permite que se use un elemento helper para la visualización durante el arrastre. Tipos admitidos:
Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ helper: "clone" });
Después de la inicialización, obtener o establecer la // getter var helper = $( ".selector" ).sortable( "option", "helper" ); // setter $( ".selector" ).sortable( "option", "helper", "clone" ); |
"original" |
| items | Selector | Especifica qué elementos dentro del elemento deben ser sortable. Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ items: "> li" });
Después de la inicialización, obtener o establecer la // getter var items = $( ".selector" ).sortable( "option", "items" ); // setter $( ".selector" ).sortable( "option", "items", "> li" ); |
"> *" |
| opacity | Number | La opacidad del asistente (helper) durante la ordenación. De0.01llegar1。Ejemplo de código: Inicializar el sortable con la
$( ".selector" ).sortable({ opacity: 0.5 });
Después de la inicialización, obtener o establecer la // getter var opacity = $( ".selector" ).sortable( "option", "opacity" ); // setter $( ".selector" ).sortable( "option", "opacity", 0.5 ); |
false |
| placeholder | String | El nombre de la class que se aplicará; de lo contrario, será un espacio en blanco. Ejemplo de código: Inicializar con las opciones especificadas
$( ".selector" ).sortable({ placeholder: "sortable-placeholder" });
Después de la inicialización, obtener o establecer // getter var placeholder = $( ".selector" ).sortable( "option", "placeholder" ); // setter $( ".selector" ).sortable( "option", "placeholder", "sortable-placeholder" ); |
false |
| revert | Boolean o Number | Si el elemento sortable usa una animación fluida para volver a su nueva posición. Admite varios tipos:
Ejemplo de código: Inicializar con las opciones especificadas
$( ".selector" ).sortable({ revert: true });
Después de la inicialización, obtener o establecer // getter var revert = $( ".selector" ).sortable( "option", "revert" ); // setter $( ".selector" ).sortable( "option", "revert", true ); |
false |
| scroll | Boolean | Si se establece entrue, la página se desplazará cuando se alcance el borde.Ejemplo de código: Inicializar con las opciones especificadas
$( ".selector" ).sortable({ scroll: false });
Después de la inicialización, obtener o establecer // getter var scroll = $( ".selector" ).sortable( "option", "scroll" ); // setter $( ".selector" ).sortable( "option", "scroll", false ); |
true |
| scrollSensitivity | Number | Define a qué distancia del borde se encuentra el mouse para que comience el desplazamiento. Ejemplo de código: Inicializar con las opciones especificadas
$( ".selector" ).sortable({ scrollSensitivity: 10 });
Después de la inicialización, obtener o establecer // getter var scrollSensitivity = $( ".selector" ).sortable( "option", "scrollSensitivity" ); // setter $( ".selector" ).sortable( "option", "scrollSensitivity", 10 ); |
20 |
| scrollSpeed | Number | Cuando el puntero del mouse se encuentra ascrollSensitivitydistancia, la velocidad de desplazamiento de la ventana. Siscrollla opción esfalsese ignora.Ejemplo de código: Inicializar con las opciones especificadas
$( ".selector" ).sortable({ scrollSpeed: 40 });
Después de la inicialización, obtener o establecer // getter var scrollSpeed = $( ".selector" ).sortable( "option", "scrollSpeed" ); // setter $( ".selector" ).sortable( "option", "scrollSpeed", 40 ); |
20 |
| tolerance | String | Especifica el modo utilizado para probar si el elemento se superpone a otro elemento al moverse. Valores posibles:
Ejemplo de código: Inicializar con las opciones especificadas
$( ".selector" ).sortable({ tolerance: "pointer" });
Después de la inicialización, obtener o establecer // getter var tolerance = $( ".selector" ).sortable( "option", "tolerance" ); // setter $( ".selector" ).sortable( "option", "tolerance", "pointer" ); |
"intersect" |
| zIndex | Integer | El índice Z del elemento/ayudante (helper) cuando se está ordenando. Ejemplo de código: Inicializar con las opciones especificadas
$( ".selector" ).sortable({ zIndex: 9999 });
Después de la inicialización, obtener o establecer // getter var zIndex = $( ".selector" ).sortable( "option", "zIndex" ); // setter $( ".selector" ).sortable( "option", "zIndex", 9999 ); |
1000 |
| Métodos | Devuelve | Descripción |
|---|---|---|
| cancel() | jQuery (plugin only) | Al comenzar la ordenación actual, cancela un cambio en el sortable actual y restaura el estado anterior. Es muy útil en las funciones de devolución de llamada stop y receive.
Ejemplo de código: Llamar al método cancel: $( ".selector" ).sortable( "cancel" ); |
| destroy() | jQuery (plugin only) | Elimina por completo la funcionalidad de sortable. Esto devuelve el elemento a su estado previo a la inicialización.
Ejemplo de código: Llamar al método destroy: $( ".selector" ).sortable( "destroy" ); |
| disable() | jQuery (plugin only) | Deshabilita sortable.
Ejemplo de código: Llamar al método disable: $( ".selector" ).sortable( "disable" ); |
| enable() | jQuery (plugin only) | Habilita sortable.
Ejemplo de código: Llamar al método enable: $( ".selector" ).sortable( "enable" ); |
| option( optionName ) | Object | Obtiene el valor actual asociado con laoptionNameespecificada.
Ejemplo de código: Llamar a este método: var isDisabled = $( ".selector" ).sortable( "option", "disabled" ); |
| option() | PlainObject | Obtiene un objeto que contiene pares clave/valor que representan el hash de opciones actual de draggable.
Ejemplo de código: Llamar a este método: var options = $( ".selector" ).sortable( "option" ); |
| option( optionName, value ) | jQuery (plugin only) | Establece el valor de la opción de sortable asociada con laoptionNameespecificada.
Ejemplo de código: Llamar a este método: $( ".selector" ).sortable( "option", "disabled", true ); |
| option( options ) | jQuery (plugin only) | Establece una o más opciones para el sortable.
Ejemplo de código: Llamar a este método:
$( ".selector" ).sortable( "option", { disabled: true } );
|
| refresh() | jQuery (plugin only) | Actualiza los elementos de sortable. Hace que todos los elementos de sortable se recarguen, lo que permite que se reconozcan los nuevos elementos.
Ejemplo de código: Llamar al método refresh: $( ".selector" ).sortable( "refresh" ); |
| refreshPositions() | jQuery (plugin only) | Actualiza las posiciones en caché de los elementos de sortable. Llamar a este método actualiza las posiciones de los elementos en caché de todos los sortables.
Ejemplo de código: Llamar al método refreshPositions: $( ".selector" ).sortable( "refreshPositions" ); |
| serialize( options ) | String | Serializa los elementos de sortableiden una cadena que se puede enviar mediante form/ajax. Llamar a este método genera un hash que se puede añadir a cualquier URL para enviar fácilmente el nuevo orden de los elementos de vuelta al servidor.Por defecto, funciona a través del Nota: si la serialización devuelve una cadena vacía, asegúrese de que el
Ejemplo de código: Llamar al método serialize:
var sorted = $( ".selector" ).sortable( "serialize", { key: "sort" } );
|
| toArray( options ) | Array | Serializa los elementos de sortableiden un arreglo de cadenas.
Ejemplo de código: Llamar al método toArray: var sortedIDs = $( ".selector" ).sortable( "toArray" ); |
| widget() | jQuery | Devuelve unjQueryobjeto que contiene los elementos de sortable.
Ejemplo de código: Llamar al método widget: var widget = $( ".selector" ).sortable( "widget" ); |
| Eventos | Tipo | Descripción |
|---|---|---|
| activate( event, ui ) | sortactivate | Este evento se activa cuando se utilizan listas conectadas; cada lista conectada lo recibe al comenzar el arrastre.
Ejemplo de código: Inicializar el sortable con la devolución de llamada activate especificada:
$( ".selector" ).sortable({
activate: function( event, ui ) {}
});
Vincular un detector de eventos al evento sortactivate:
$( ".selector" ).on( "sortactivate", function( event, ui ) {} );
|
| beforeStop( event, ui ) | sortbeforestop | Este evento se activa cuando la ordenación se detiene, excepto cuando el marcador de posición (placeholder)/ayudante (helper) todavía está disponible.
Ejemplo de código: Inicialice un sortable con el callback beforeStop especificado:
$( ".selector" ).sortable({
beforeStop: function( event, ui ) {}
});
Vincule un detector de eventos al evento sortbeforestop:
$( ".selector" ).on( "sortbeforestop", function( event, ui ) {} );
|
| change( event, ui ) | sortchange | Se activa durante la ordenación, excepto cuando cambia la posición en el DOM.
Ejemplo de código: Inicialice un sortable con el callback change especificado:
$( ".selector" ).sortable({
change: function( event, ui ) {}
});
Vincule un detector de eventos al evento sortchange:
$( ".selector" ).on( "sortchange", function( event, ui ) {} );
|
| create( event, ui ) | sortcreate | Se activa cuando se crea el droppable.
Nota: Ejemplo de código: Inicialice un sortable con el callback create especificado:
$( ".selector" ).sortable({
create: function( event, ui ) {}
});
Vincule un detector de eventos al evento sortcreate:
$( ".selector" ).on( "sortcreate", function( event, ui ) {} );
|
| deactivate( event, ui ) | sortdeactivate | Se activa cuando se detiene la ordenación y se propaga a todas las listas conectadas posibles.
Ejemplo de código: Inicialice un sortable con el callback deactivate especificado:
$( ".selector" ).sortable({
deactivate: function( event, ui ) {}
});
Vincule un detector de eventos al evento sortdeactivate:
$( ".selector" ).on( "sortdeactivate", function( event, ui ) {} );
|
| out( event, ui ) | sortout | Se activa cuando un elemento sortable se elimina de una lista sortable. Nota: Este evento también se activa cuando se deshace un elemento sortable.
Ejemplo de código: Inicialice un sortable con el callback out especificado:
$( ".selector" ).sortable({
out: function( event, ui ) {}
});
Vincule un detector de eventos al evento sortout:
$( ".selector" ).on( "sortout", function( event, ui ) {} );
|
| over( event, ui ) | sortover | Se activa cuando un elemento sortable se mueve a una lista sortable.
Ejemplo de código: Inicialice un sortable con el callback over especificado:
$( ".selector" ).sortable({
out: function( event, ui ) {}
});
Vincule un detector de eventos al evento sortover:
$( ".selector" ).on( "sortout", function( event, ui ) {} );
|
| receive( event, ui ) | sortreceive | Se activa cuando un elemento de una lista sortable conectada se coloca en otra lista. Esta última es el objetivo del evento.
Ejemplo de código: Inicialice un sortable con el callback receive especificado:
$( ".selector" ).sortable({
receive: function( event, ui ) {}
});
Vincule un detector de eventos al evento sortreceive:
$( ".selector" ).on( "sortreceive", function( event, ui ) {} );
|
| remove( event, ui ) | sortremove | Se activa cuando un elemento de una lista sortable conectada se coloca en otra lista. El primero es el objetivo del evento.
Ejemplo de código: Inicializar un sortable con el callback remove especificado:
$( ".selector" ).sortable({
remove: function( event, ui ) {}
});
Vincular un detector de eventos al evento sortremove:
$( ".selector" ).on( "sortremove", function( event, ui ) {} );
|
| sort( event, ui ) | sort | Este evento se dispara durante el ordenamiento.
Ejemplo de código: Inicializar un sortable con el callback sort especificado:
$( ".selector" ).sortable({
sort: function( event, ui ) {}
});
Vincular un detector de eventos al evento sort:
$( ".selector" ).on( "sort", function( event, ui ) {} );
|
| start( event, ui ) | sortstart | Este evento se dispara cuando comienza el ordenamiento.
Ejemplo de código: Inicializar un sortable con el callback start especificado:
$( ".selector" ).sortable({
start: function( event, ui ) {}
});
Vincular un detector de eventos al evento sortstart:
$( ".selector" ).on( "sortstart", function( event, ui ) {} );
|
| stop( event, ui ) | sortstop | Este evento se dispara cuando se detiene el ordenamiento.
Ejemplo de código: Inicializar un sortable con el callback stop especificado:
$( ".selector" ).sortable({
stop: function( event, ui ) {}
});
Vincular un detector de eventos al evento sortstop:
$( ".selector" ).on( "sortstop", function( event, ui ) {} );
|
| update( event, ui ) | sortupdate | Este evento se dispara cuando el usuario detiene el ordenamiento y la posición en el DOM ha cambiado.
Ejemplo de código: Inicializar un sortable con el callback update especificado:
$( ".selector" ).sortable({
update: function( event, ui ) {}
});
Vincular un detector de eventos al evento sortupdate:
$( ".selector" ).on( "sortupdate", function( event, ui ) {} );
|
Ejemplos
Un sencillo widget ordenable (Sortable Widget) de jQuery UI.
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>可排序小部件(Sortable Widget)演示</title>
<link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
<script src="//code.jquery.com/jquery-1.10.2.js"></script>
<script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script>
</head>
<body>
<ul id="sortable">
<li>Item 1</li>
<li>Item 2</li>
<li>Item 3</li>
<li>Item 4</li>
<li>Item 5</li>
</ul>
<script>$("#sortable").sortable();</script>
</body>
</html>
Otras extensiones