jQuery UI API - Widget Droppable (Droppable Widget)

Categoría

Interacciones (Interactions)

Uso

Descripción:Crea un objetivo para los widgets arrastrables.

Nuevo en la versión:1.0

Dependencias:

Notas:El complemento Droppable de jQuery UI hace que los elementos seleccionados sean droppable (es decir, aceptan que se suelte un elemento sobre ellos después de arrastrarlo). Puede especificar individualmente qué draggable será aceptado.

Navegación rápida

Opciones Métodos Eventos

Opciones Tipo Descripción Valor por defecto
accept Selector o Function() Controla qué elemento draggable (arrastrable) puede ser aceptado por el droppable.

Admite múltiples tipos:

  • SelectorSelector: un selector que especifica qué elemento draggable puede ser aceptado por el droppable.
  • Function()Función: una función que se invocará para cada draggable de la página (pasada como primer argumento a la función). Si el draggable es aceptado, la función debe devolvertrue。

Ejemplo de código:

Inicialice el droppable con laacceptopción especificada:

$( ".selector" ).droppable({ accept: ".special" });
    

Después de la inicialización, obtenga o establezca laacceptopción:

// getter
var accept = $( ".selector" ).droppable( "option", "accept" );
 
// setter
$( ".selector" ).droppable( "option", "accept", ".special" );
    
"*"
activeClass String Si se especifica esta opción, cuando un draggable aceptable esté siendo arrastrado, la clase se agregará al droppable.

Ejemplo de código:

Inicialice el droppable con laactiveClassopción especificada:

$( ".selector" ).droppable({ activeClass: "ui-state-highlight" });
    

Después de la inicialización, obtenga o establezca laactiveClassopción:

// getter
var activeClass = $( ".selector" ).droppable( "option", "activeClass" );
 
// setter
$( ".selector" ).droppable( "option", "activeClass", "ui-state-highlight" );
    
false
addClasses Boolean Si se establece enfalse, se evitará queui-droppablela clase se agregue. Esto, cuando se invoca en cientos de elementos,.droppable()ayuda a optimizar el rendimiento.

Ejemplo de código:

Inicialice el droppable con laaddClassesopción especificada:

$( ".selector" ).droppable({ addClasses: false });
    

Después de la inicialización, obtenga o establezca laaddClassesopción:

// getter
var addClasses = $( ".selector" ).droppable( "option", "addClasses" );
 
// setter
$( ".selector" ).droppable( "option", "addClasses", false );
    
true
disabled Boolean Si se establece entrue, se deshabilita el droppable.

Ejemplo de código:

Inicialice el droppable con ladisabledopción especificada:

$( ".selector" ).droppable({ disabled: true });
    

Después de la inicialización, obtenga o establezca ladisabledopción:

// getter
var disabled = $( ".selector" ).droppable( "option", "disabled" );
 
// setter
$( ".selector" ).droppable( "option", "disabled", true );
    
false
greedy Boolean De forma predeterminada, cuando un elemento se suelta sobre un droppable anidado, cada droppable recibirá el elemento. Sin embargo, al establecer esta opción entrue, ningún droppable padre podrá recibir el elemento.dropLos eventos se seguirán disparando normalmente, pero se comprobaráevent.targetpara ver qué droppable recibe el elemento draggable.

Ejemplo de código:

Inicialice el droppable con lagreedyopción especificada:

$( ".selector" ).droppable({ greedy: true });
    

Después de la inicialización, obtenga o establezca lagreedyopción:

// getter
var greedy = $( ".selector" ).droppable( "option", "greedy" );
 
// setter
$( ".selector" ).droppable( "option", "greedy", true );
    
false
hoverClass String Si se especifica esta opción, cuando un draggable aceptable se superponga al droppable, la clase se agregará al droppable.

Ejemplo de código:

Inicialice el droppable con lahoverClassopción especificada:

$( ".selector" ).droppable({ hoverClass: "drop-hover" });
    

Después de la inicialización, obtenga o establezca lahoverClassopción:

// getter
var hoverClass = $( ".selector" ).droppable( "option", "hoverClass" );
 
// setter
$( ".selector" ).droppable( "option", "hoverClass", "drop-hover" );
    
false
scope String Se utiliza para agrupar elementos draggable y droppable emparejados, además de laacceptopción del droppable.scopeUn draggable que tenga el mismo

valor que el droppable será aceptado por este droppable.

Ejemplo de código:scopeInicialice el droppable con la

$( ".selector" ).droppable({ scope: "tasks" });
    

opción especificada:scopeDespués de la inicialización, obtenga o establezca la

// getter
var scope = $( ".selector" ).droppable( "option", "scope" );
 
// setter
$( ".selector" ).droppable( "option", "scope", "tasks" );
    
"default"
tolerance String opción:
  • "fit"Especifica el modo que se utiliza para comprobar si un draggable se superpone a un droppable. Valores posibles:
  • "intersect": el draggable se superpone completamente al droppable.
  • "pointer": el draggable se superpone al droppable en al menos un 50% en ambas direcciones.
  • "touch": el puntero del mouse se superpone al droppable.

: el draggable se superpone al droppable en cualquier cantidad.

Ejemplo de código:toleranceInicialice el droppable con la

$( ".selector" ).droppable({ tolerance: "fit" });
    

opción especificada:toleranceDespués de la inicialización, obtenga o establezca la

// getter
var tolerance = $( ".selector" ).droppable( "option", "tolerance" );
 
// setter
$( ".selector" ).droppable( "option", "tolerance", "fit" );
    
"intersect"

opción: Métodos Devuelve
destroy() jQuery (plugin only) Descripción
  • Elimina por completo la funcionalidad droppable. Esto devuelve el elemento a su estado previo a la inicialización.

Este método no acepta ningún argumento.

Ejemplo de código:

$( ".selector" ).droppable( "destroy" );
    
disable() jQuery (plugin only) Llamar al método destroy:
  • Deshabilita el droppable.

Este método no acepta ningún argumento.

Ejemplo de código:

$( ".selector" ).droppable( "disable" );
    
enable() jQuery (plugin only) Llamar al método disable:
  • Habilita el droppable.

Este método no acepta ningún argumento.

Ejemplo de código:

$( ".selector" ).droppable( "enable" );
    
option( optionName ) Object Llamar al método enable:optionNameObtiene el valor actualmente asociado con la
  • optionName
    opción especificada.
    Tipo: String

Descripción: el nombre de la opción que se va a obtener.

Ejemplo de código:

var isDisabled = $( ".selector" ).droppable( "option", "disabled" );
    
option() PlainObject Llamar a este método:
  • Obtiene un objeto con pares clave/valor que representan el hash de opciones actual del droppable.

Este método no acepta ningún argumento.

Ejemplo de código:

var options = $( ".selector" ).droppable( "option" );
    
option( optionName, value ) jQuery (plugin only) Llamar a este método:optionNameEstablece el valor de la opción droppable asociada con la
  • optionName
    opción especificada.
    Tipo: String
  • value
    Descripción: el nombre de la opción que se va a establecer.
    Tipo: Object

Descripción: el valor que se va a establecer para la opción.

Ejemplo de código:

$( ".selector" ).droppable( "option", "disabled", true );
    
option( options ) jQuery (plugin only) Llamar a este método:
  • options
    Establece una o más opciones para el droppable.
    Tipo: Object

Descripción: pares de opción-valor que se van a establecer.

Ejemplo de código:

$( ".selector" ).droppable( "option", { disabled: true } );
    
widget() jQuery Llamar a este método:jQueryDevuelve un
  • objeto jQuery que contiene el elemento droppable.

Este método no acepta ningún argumento.

Ejemplo de código:

var widget = $( ".selector" ).droppable( "widget" );
    

Llamar al método widget: Eventos Tipo
activate( event, ui ) dropactivate Descripción
  • event
    Se dispara cuando un draggable aceptable comienza a ser arrastrado. Si desea que el droppable se "ilumine" cuando se suelte un elemento sobre él, esta opción resulta útil.
  • ui
    Tipo: Event
    • draggable
      Tipo: Object
      Tipo: jQuery
    • helper
      Descripción: objeto jQuery que representa el elemento draggable.
      Tipo: jQuery
    • position
      Descripción: objeto jQuery que representa el helper (ayudante) que se está arrastrando.
      Tipo: Object{ top, left }Descripción: la posición CSS actual del helper del draggable, por ejemplo, un
    • offset
      objeto.
      Tipo: Object{ top, left }Descripción: la posición de offset actual del helper del draggable, por ejemplo, un

objeto.

Ejemplo de código:

$( ".selector" ).droppable({
  activate: function( event, ui ) {}
});
    

Inicialice el droppable con el callback activate especificado:

$( ".selector" ).on( "dropactivate", function( event, ui ) {} );
    
create( event, ui ) dropcreate Vincule un detector de eventos al evento dropactivate:
  • event
    Se dispara cuando se crea el droppable.
  • ui
    Tipo: Event

Nota:uiEl objeto está vacío; se incluye aquí para mantener la coherencia con otros eventos.

Ejemplo de código:

Inicializar un droppable con el callback create especificado:

$( ".selector" ).droppable({
  create: function( event, ui ) {}
});
    

Vincular un detector de eventos al evento dropcreate:

$( ".selector" ).on( "dropcreate", function( event, ui ) {} );
    
deactivate( event, ui ) dropdeactivate Se dispara cuando un draggable aceptable deja de arrastrarse.
  • event
    Tipo: Event
  • ui
    Tipo: Object
    • draggable
      Tipo: jQuery
      Descripción: Objeto jQuery que representa el elemento draggable.
    • helper
      Tipo: jQuery
      Descripción: Objeto jQuery que representa el helper arrastrado.
    • position
      Tipo: Object
      Descripción: Posición CSS actual del helper del draggable, como{ top, left }objeto.
    • offset
      Tipo: Object
      Descripción: Posición de desplazamiento actual del helper del draggable, como{ top, left }objeto.

Ejemplo de código:

Inicializar un droppable con el callback deactivate especificado:

$( ".selector" ).droppable({
  deactivate: function( event, ui ) {}
});
    

Vincular un detector de eventos al evento dropdeactivate:

$( ".selector" ).on( "dropdeactivate", function( event, ui ) {} );
    
drop( event, ui ) drop Se dispara cuando un draggable aceptable se coloca sobre el droppable (según latoleranceopción).
  • event
    Tipo: Event
  • ui
    Tipo: Object
    • draggable
      Tipo: jQuery
      Descripción: Objeto jQuery que representa el elemento draggable.
    • helper
      Tipo: jQuery
      Descripción: Objeto jQuery que representa el helper arrastrado.
    • position
      Tipo: Object
      Descripción: Posición CSS actual del helper del draggable, como{ top, left }objeto.
    • offset
      Tipo: Object
      Descripción: Posición de desplazamiento actual del helper del draggable, como{ top, left }objeto.

Ejemplo de código:

Inicializar un droppable con el callback drop especificado:

$( ".selector" ).droppable({
  drop: function( event, ui ) {}
});
    

Vincular un detector de eventos al evento drop:

$( ".selector" ).on( "drop", function( event, ui ) {} );
    
out( event, ui ) dropout Se dispara cuando un draggable es arrastrado fuera del droppable (según latoleranceopción).
  • event
    Tipo: Event
  • ui
    Tipo: Object

Nota:uiEl objeto está vacío; se incluye aquí para mantener la coherencia con otros eventos.

Ejemplo de código:

Inicializar un droppable con el callback out especificado:

$( ".selector" ).droppable({
  out: function( event, ui ) {}
});
    

Vincular un detector de eventos al evento dropout:

$( ".selector" ).on( "dropout", function( event, ui ) {} );
    
over( event, ui ) dropover Se dispara cuando un draggable aceptable es arrastrado sobre el droppable (según latoleranceopción).
  • event
    Tipo: Event
  • ui
    Tipo: Object
    • draggable
      Tipo: jQuery
      Descripción: Objeto jQuery que representa el elemento draggable.
    • helper
      Tipo: jQuery
      Descripción: Objeto jQuery que representa el helper arrastrado.
    • position
      Tipo: Object
      Descripción: Posición CSS actual del helper del draggable, como{ top, left }objeto.
    • offset
      Tipo: Object
      Descripción: Posición de desplazamiento actual del helper del draggable, como{ top, left }objeto.

Ejemplo de código:

Inicializar un droppable con el callback over especificado:

$( ".selector" ).droppable({
  over: function( event, ui ) {}
});
    

Vincular un detector de eventos al evento dropover:

$( ".selector" ).on( "dropover", function( event, ui ) {} );
    

Ejemplos

Un par de elementos draggable y droppable.

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>可放置小部件(Droppable Widget)演示</title>
  <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
  <style>
  #draggable {
    width: 100px;
    height: 100px;
    background: #ccc;
  }
  #droppable {
    position: absolute;
    left: 250px;
    top: 0;
    width: 125px;
    height: 125px;
    background: #999;
    color: #fff;
    padding: 10px;
  }
  </style>
  <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>
 
<div id="droppable">请放置到这里!</div>
<div id="draggable">请拖拽我!</div>
 
<script>
$( "#draggable" ).draggable();
$( "#droppable" ).droppable({
  drop: function() {
    alert( "dropped" );
  }
});
</script>
 
</body>
</html>

Otras extensiones