jQuery UI API - Widget Seleccionable (Selectable Widget)

Categoría

Interacciones

Uso

Descripción:Use el mouse para seleccionar un solo elemento o un grupo de elementos.

Nuevo en la versión:1.0

Dependencias:

Notas:El complemento Selectable de jQuery UI permite seleccionar elementos arrastrando el mouse (a veces llamado un lazo). Puede hacer clic o arrastrar mientras mantiene presionada la tecla ctrl/meta para seleccionar varios elementos (no contiguos).

Notas adicionales:Este widget requiere algo de CSS funcional, de lo contrario no funcionará. Si crea un tema personalizado, use el archivo CSS específico del widget como punto de partida.

Navegación rápida

Opciones Métodos Eventos

Opciones Tipo Descripción Valor predeterminado
appendTo Selector El elemento al que se agregará el asistente de selección (el lazo).

Ejemplo de código:

Inicialice con la opción especificadaappendTodel draggable:

$( ".selector" ).selectable({ appendTo: "#someElem" });
    

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

// getter
var appendTo = $( ".selector" ).selectable( "option", "appendTo" );
 
// setter
$( ".selector" ).selectable( "option", "appendTo", "#someElem" );
    
"body"
autoRefresh Boolean Esta opción determina si se actualizan (recalculan) la posición y el tamaño de cada elemento seleccionable al inicio de cada operación de selección. Si tiene muchos elementos, es posible que desee establecer esta opción en false y llamar manualmente alrefresh()método.

Ejemplo de código:

Inicialice con la opción especificadaautoRefreshdel draggable:

$( ".selector" ).selectable({ autoRefresh: false });
    

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

// getter
var autoRefresh = $( ".selector" ).selectable( "option", "autoRefresh" );
 
// setter
$( ".selector" ).selectable( "option", "autoRefresh", false );
    
true
cancel Selector Evita que la selección comience desde elementos que coinciden con el selector.

Ejemplo de código:

Inicialice con la opción especificadacanceldel selectable:

$( ".selector" ).selectable({ cancel: "a,.cancel" });
    

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

// getter
var cancel = $( ".selector" ).selectable( "option", "cancel" );
 
// setter
$( ".selector" ).selectable( "option", "cancel", "a,.cancel" );
    
"input, textarea, button, select, option"
delay Number El tiempo en milisegundos desde que se presiona el mouse hasta que comienza la selección. Esta opción puede evitar selecciones no deseadas al hacer clic en un elemento.

Ejemplo de código:

Inicialice con la opción especificadadelaydel selectable:

$( ".selector" ).selectable({ delay: 150 });
    

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

// getter
var delay = $( ".selector" ).selectable( "option", "delay" );
 
// setter
$( ".selector" ).selectable( "option", "delay", 150 );
    
0
disabled Boolean Si se establece entrue, entonces el selectable se deshabilita.

Ejemplo de código:

Inicialice con la opción especificadadisableddel selectable:

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

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

// getter
var disabled = $( ".selector" ).selectable( "option", "disabled" );
 
// setter
$( ".selector" ).selectable( "option", "disabled", true );
    
false
distance Number La distancia en píxeles que el mouse debe moverse después de presionar y antes de que comience la selección. Si se especifica esta opción, la selección solo comenzará cuando el arrastre del mouse supere la distancia especificada. Esta opción puede evitar selecciones no deseadas al hacer clic en un elemento.

Ejemplo de código:

Inicialice con la opción especificadadistancedel selectable:

$( ".selector" ).selectable({ distance: 30 });
    

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

// getter
var distance = $( ".selector" ).selectable( "option", "distance" );
 
// setter
$( ".selector" ).selectable( "option", "distance", 30 );
    
0
filter Selector Los elementos secundarios coincidentes que se convertirán en seleccionables (que se pueden seleccionar).

Ejemplo de código:

Inicialice con la opción especificadafilterdel selectable:

$( ".selector" ).selectable({ filter: "li" });
    

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

// getter
var filter = $( ".selector" ).selectable( "option", "filter" );
 
// setter
$( ".selector" ).selectable( "option", "filter", "li" );
    
"*"
tolerance String Especifica el modo que se utiliza para probar si el lazo selecciona un elemento. Valores posibles:
  • "fit": El lazo se superpone completamente al elemento.
  • "touch": El lazo se superpone al elemento, en cualquier proporción.

Ejemplo de código:

Inicialice con la opción especificadatolerancedel selectable:

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

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

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

Métodos Devuelve Descripción
destroy() jQuery (plugin only) Elimina por completo la funcionalidad de selectable. Esto devuelve el elemento a su estado anterior a la inicialización.
  • Este método no acepta ningún parámetro.

Ejemplo de código:

Llame al método destroy:

$( ".selector" ).selectable( "destroy" );
    
disable() jQuery (plugin only) Deshabilita el selectable.
  • Este método no acepta ningún parámetro.

Ejemplo de código:

Llame al método disable:

$( ".selector" ).selectable( "disable" );
    
enable() jQuery (plugin only) Habilita el selectable.
  • Este método no acepta ningún parámetro.

Ejemplo de código:

Llame al método enable:

$( ".selector" ).selectable( "enable" );
    
option( optionName ) Object Obtiene el valor actual asociado con la opciónoptionNameespecificada.
  • optionName
    Tipo: String
    Descripción: el nombre de la opción a obtener.

Ejemplo de código:

Llame a este método:

var isDisabled = $( ".selector" ).selectable( "option", "disabled" );
    
option() PlainObject Obtiene un objeto que contiene pares de clave/valor que representan el hash de opciones actual de selectable.
  • Este método no acepta ningún parámetro.

Ejemplo de código:

Llame a este método:

var options = $( ".selector" ).selectable( "option" );
    
option( optionName, value ) jQuery (plugin only) Establece el valor de la opción de selectable asociado con la opciónoptionNameespecificada.
  • optionName
    Tipo: String
    Descripción: el nombre de la opción a establecer.
  • value
    Tipo: Object
    Descripción: el valor a establecer para la opción.

Ejemplo de código:

Llame a este método:

$( ".selector" ).selectable( "option", "disabled", true );
    
option( options ) jQuery (plugin only) Establece una o más opciones para selectable.
  • options
    Tipo: Object
    Descripción: pares de opción-valor a establecer.

Ejemplo de código:

Llame a este método:

$( ".selector" ).selectable( "option", { disabled: true } );
    
refresh() jQuery (plugin only) Actualiza la posición y el tamaño de cada elemento seleccionable. CuandoautoRefreshla opción se establece en false, este método se puede utilizar para recalcular manualmente la posición y el tamaño de cada elemento seleccionable.
  • Este método no acepta ningún parámetro.

Ejemplo de código:

Llame al método refresh:

$( ".selector" ).selectable( "refresh" );
    
widget() jQuery Devuelve un objetojQueryque contiene el elemento selectable.
  • Este método no acepta ningún parámetro.

Ejemplo de código:

Llame al método widget:

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

Eventos Tipo Descripción
create( event, ui ) selectablecreate Se activa cuando se crea el selectable.
  • event
    Tipo: Event
  • ui
    Tipo: Object

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

Ejemplo de código:

Inicialice el selectable con el callback create especificado:

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

Vincule un detector de eventos al evento selectablecreate:

$( ".selector" ).on( "selectablecreate", function( event, ui ) {} );
    
selected( event, ui ) selectableselected Se activa al final de la operación de selección, cuando cada elemento se agrega a la selección.
  • event
    Tipo: Event
  • ui
    Tipo: Object
    • selected
      Tipo: Element
      Descripción: el elemento seleccionable que ha sido seleccionado.

Ejemplo de código:

Inicialice el selectable con el callback selected especificado:

$( ".selector" ).selectable({
  selected: function( event, ui ) {}
});
    

Vincule un detector de eventos al evento selectableselected:

$( ".selector" ).on( "selectableselected", function( event, ui ) {} );
    
selecting( event, ui ) selectableselecting Se activa durante la operación de selección, cuando cada elemento se agrega a la selección.
  • event
    Tipo: Event
  • ui
    Tipo: Object
    • selecting
      Tipo: Element
      Descripción: el elemento seleccionable que se está seleccionando actualmente.

Ejemplo de código:

Inicialice el selectable con el callback selecting especificado:

$( ".selector" ).selectable({
  selecting: function( event, ui ) {}
});
    

Vincule un detector de eventos al evento selectableselecting:

$( ".selector" ).on( "selectableselecting", function( event, ui ) {} );
    
start( event, ui ) selectablestart Se activa al inicio de la operación de selección.
  • event
    Tipo: Event
  • ui
    Tipo: Object

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

Ejemplo de código:

Inicialice el selectable con el callback start especificado:

$( ".selector" ).selectable({
  start: function( event, ui ) {}
});
    

Vincule un detector de eventos al evento selectablestart:

$( ".selector" ).on( "selectablestart", function( event, ui ) {} );
    
stop( event, ui ) selectablestop Se dispara al final de la operación de selecció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:

Inicializa el selectable con el callback stop especificado:

$( ".selector" ).selectable({
  stop: function( event, ui ) {}
});
    

Vincular un detector de eventos al evento selectablestop:

$( ".selector" ).on( "selectablestop", function( event, ui ) {} );
    
unselected( event, ui ) selectableunselected Se dispara al final de la operación de selección, cuando cada elemento se elimina de la selección.
  • event
    Tipo: Event
  • ui
    Tipo: Object
    • unselected
      Tipo: Element
      Descripción: el elemento seleccionable que ha sido deseleccionado.

Ejemplo de código:

Inicializa el selectable con el callback unselected especificado:

$( ".selector" ).selectable({
  unselected: function( event, ui ) {}
});
    

Vincular un detector de eventos al evento selectableunselected:

$( ".selector" ).on( "selectableunselected", function( event, ui ) {} );
    
unselecting( event, ui ) selectableunselecting Se dispara durante la operación de selección, cuando cada elemento se elimina de la selección.
  • event
    Tipo: Event
  • ui
    Tipo: Object
    • unselecting
      Tipo: Element
      Descripción: el elemento seleccionable actual que se está deseleccionando.

Ejemplo de código:

Inicializa el selectable con el callback unselecting especificado:

$( ".selector" ).selectable({
  unselecting: function( event, ui ) {}
});
    

Vincular un detector de eventos al evento selectableunselecting:

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

Ejemplos

Un simple widget Selectable de jQuery UI.

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>可选择小部件(Selectable Widget)演示</title>
  <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
  <style>
  #selectable .ui-selecting {
    background: #ccc;
  }
  #selectable .ui-selected {
    background: #999;
  }
  </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>
 
<ul id="selectable">
  <li>Item 1</li>
  <li>Item 2</li>
  <li>Item 3</li>
  <li>Item 4</li>
  <li>Item 5</li>
</ul>
 
<script>
$( "#selectable" ).selectable();
</script>
 
</body>
</html>

Otras extensiones