jQuery UI API - Selectable Widget

Catégorie

Interactions

Utilisation

Description :Sélectionner des éléments individuels ou un groupe d'éléments à l'aide de la souris.

Version ajoutée :1.0

Dépendances :

Remarques :Le plugin Selectable de jQuery UI permet de sélectionner des éléments en les faisant glisser avec la souris (parfois appelé lasso). Vous pouvez cliquer ou faire glisser tout en maintenant la touche ctrl/meta pour sélectionner plusieurs éléments (non contigus).

Remarques supplémentaires :Ce widget nécessite du CSS fonctionnel, sinon il ne fonctionnera pas. Si vous créez un thème personnalisé, utilisez le fichier CSS spécifique au widget comme point de départ.

Navigation rapide

Options Méthodes Événements

Options Type Description Default
appendTo Sélecteur L'élément auquel l'aide de sélection (lasso) doit être ajouté.

Exemples de code :

Initialiser avec lesappendTooptions pour draggable :

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

Après l'initialisation, obtenir ou définir l'appendTooption:

// getter
var appendTo = $( ".selector" ).selectable( "option", "appendTo" );
 
// setter
$( ".selector" ).selectable( "option", "appendTo", "#someElem" );
    
"body"
autoRefresh Boolean Cette option détermine s'il faut mettre à jour (recalculer) la position et la taille de chaque élément sélectionnable au début de chaque opération de sélection. Si vous avez de nombreux éléments, vous pouvez définir cette option sur false et appeler manuellement larefresh()méthode.

Exemples de code :

Initialiser avec lesautoRefreshoptions pour draggable :

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

Après l'initialisation, obtenir ou définir l'autoRefreshoption:

// getter
var autoRefresh = $( ".selector" ).selectable( "option", "autoRefresh" );
 
// setter
$( ".selector" ).selectable( "option", "autoRefresh", false );
    
vrai
annulation Sélecteur Empêche la sélection de démarrer sur les éléments qui correspondent au sélecteur.

Exemples de code :

Initialiser avec lescanceloptions pour selectable :

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

Après l'initialisation, obtenir ou définir l'canceloption:

// getter
var cancel = $( ".selector" ).selectable( "option", "cancel" );
 
// setter
$( ".selector" ).selectable( "option", "cancel", "a,.cancel" );
    
"input, textarea, button, select, option"
delay Number Le temps en millisecondes après un appui de souris jusqu'au début de la sélection. Cette option peut empêcher les sélections inutiles lorsqu'on clique sur un élément.

Exemples de code :

Initialiser avec lesdelayoptions pour selectable :

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

Après l'initialisation, obtenir ou définir l'delayoption:

// getter
var delay = $( ".selector" ).selectable( "option", "delay" );
 
// setter
$( ".selector" ).selectable( "option", "delay", 150 );
    
0
disabled Boolean Si défini surtrue, le selectable est désactivé.

Exemples de code :

Initialiser avec lesdisabledoptions pour selectable :

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

Après l'initialisation, obtenir ou définir l'disabledoption:

// getter
var disabled = $( ".selector" ).selectable( "option", "disabled" );
 
// setter
$( ".selector" ).selectable( "option", "disabled", true );
    
false
distance Number La distance en pixels que la souris doit parcourir après un appui de souris avant le début de la sélection. Si cette option est spécifiée, la sélection ne commence que lorsque la souris est glissée au-delà de la distance spécifiée. Cette option peut empêcher les sélections inutiles lorsqu'on clique sur un élément.

Exemples de code :

Initialiser avec lesdistanceoptions pour selectable :

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

Après l'initialisation, obtenir ou définir l'distanceoption:

// getter
var distance = $( ".selector" ).selectable( "option", "distance" );
 
// setter
$( ".selector" ).selectable( "option", "distance", 30 );
    
0
filter Sélecteur Les éléments enfants correspondants qui sont rendus sélectionnables (peuvent être sélectionnés).

Exemples de code :

Initialiser avec lesfilteroptions pour selectable :

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

Après l'initialisation, obtenir ou définir l'filteroption:

// getter
var filter = $( ".selector" ).selectable( "option", "filter" );
 
// setter
$( ".selector" ).selectable( "option", "filter", "li" );
    
"*"
tolerance String Spécifie le mode utilisé pour tester si le lasso sélectionne un élément. Valeurs possibles :
  • "fit": Le lasso chevauche complètement l'élément.
  • "touch": Le lasso chevauche l'élément, dans n'importe quelle proportion.

Exemples de code :

Initialiser avec lestoleranceoptions pour selectable :

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

Après l'initialisation, obtenir ou définir l'toleranceoption:

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

Méthodes Renvoie Description
destroy() jQuery (plugin uniquement) Supprime complètement la fonctionnalité selectable. Cela rétablit l'élément dans son état précédant l'initialisation.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Appelez la méthode destroy :

$( ".selector" ).selectable( "destroy" );
    
disable() jQuery (plugin uniquement) Désactive le selectable.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Appelez la méthode disable :

$( ".selector" ).selectable( "disable" );
    
enable() jQuery (plugin uniquement) Active le selectable.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Appelez la méthode enable :

$( ".selector" ).selectable( "enable" );
    
option( optionName ) Object Obtient, pour ce qui est actuellement spécifiéoptionNamela valeur associée.
  • optionName
    Type : String
    Description : Le nom de l'option à obtenir.

Exemples de code :

Appelez cette méthode :

var isDisabled = $( ".selector" ).selectable( "option", "disabled" );
    
option() PlainObject Obtient un objet contenant des paires clé/valeur représentant le hash des options actuelles du selectable.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Appelez cette méthode :

var options = $( ".selector" ).selectable( "option" );
    
option( optionName, value ) jQuery (plugin uniquement) Définit, pour l'option spécifiéeoptionNamela valeur de l'option selectable associée.
  • optionName
    Type : String
    Description : Le nom de l'option à définir.
  • value
    Type : Object
    Description : La valeur à définir pour l'option.

Exemples de code :

Appelez cette méthode :

$( ".selector" ).selectable( "option", "disabled", true );
    
option( options ) jQuery (plugin uniquement) Définit une ou plusieurs options pour le selectable.
  • options
    Type : Object
    Description : Les paires option-valeur à définir.

Exemples de code :

Appelez cette méthode :

$( ".selector" ).selectable( "option", { disabled: true } );
    
refresh() jQuery (plugin uniquement) Met à jour la position et la taille de chaque élément selectable. Lorsque l'autoRefreshoption est définie sur false, cette méthode peut être utilisée pour recalculer manuellement la position et la taille de chaque élément selectable.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Appelez la méthode refresh :

$( ".selector" ).selectable( "refresh" );
    
widget() jQuery Renvoie unjQueryobjet contenant l'élément selectable.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Appelez la méthode widget :

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

Événements Type Description
create( event, ui ) selectablecreate Déclenché lorsque le selectable est créé.
  • event
    Type : Event
  • ui
    Type : Object

Remarque :uiL'objet est vide, et est inclus pour des raisons de cohérence avec les autres événements.

Exemples de code :

Initialise le selectable avec le callback create spécifié :

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

Attachez un écouteur d'événement à l'événement selectablecreate :

$( ".selector" ).on( "selectablecreate", function( event, ui ) {} );
    
selected( event, ui ) selectableselected Déclenché à la fin de l'opération de sélection, lorsque chaque élément a été ajouté à la sélection.
  • event
    Type : Event
  • ui
    Type : Object
    • selected
      Type : Element
      Description : L'élément sélectionnable qui a été sélectionné.

Exemples de code :

Initialisez le selectable avec le rappel selected spécifié :

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

Attachez un écouteur d'événement à l'événement selectableselected :

$( ".selector" ).on( "selectableselected", function( event, ui ) {} );
    
selecting( event, ui ) selectableselecting Déclenché pendant l'opération de sélection, lorsque chaque élément est ajouté à la sélection.
  • event
    Type : Event
  • ui
    Type : Object
    • sélection en cours
      Type : Element
      Description : L'élément sélectionnable actuel en cours de sélection.

Exemples de code :

Initialisez le selectable avec le callback selecting spécifié :

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

Liez un écouteur d'événement à l'événement selectableselecting :

$( ".selector" ).on( "selectableselecting", function( event, ui ) {} );
    
start( event, ui ) selectablestart Déclenché au début de l'opération de sélection.
  • event
    Type : Event
  • ui
    Type : Object

Remarque :uiL'objet est vide, et est inclus pour des raisons de cohérence avec les autres événements.

Exemples de code :

Initialisez le selectable avec le callback start spécifié :

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

Liez un écouteur d'événement à l'événement selectablestart :

$( ".selector" ).on( "selectablestart", function( event, ui ) {} );
    
stop( event, ui ) selectablestop Déclenché à la fin de l'opération de sélection.
  • event
    Type : Event
  • ui
    Type : Object

Remarque :uiL'objet est vide ; il est inclus ici pour des raisons de cohérence avec les autres événements.

Exemples de code :

Initialisez le selectable avec le callback stop spécifié :

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

Liez un écouteur d'événement à l'événement selectablestop :

$( ".selector" ).on( "selectablestop", function( event, ui ) {} );
    
unselected( event, ui ) selectableunselected Déclenché à la fin de l'opération de sélection, lorsque chaque élément est retiré de la sélection.
  • event
    Type : Event
  • ui
    Type : Object
    • non sélectionné
      Type : Element
      Description : L'élément sélectionnable qui n'est plus sélectionné.

Exemples de code :

Initialiser le sélectionnable avec la fonction de rappel unselected spécifiée :

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

Lier un écouteur d'événement à l'événement selectableunselected :

$( ".selector" ).on( "selectableunselected", function( event, ui ) {} );
    
unselecting( event, ui ) selectableunselecting Déclenché pendant l'opération de sélection, lorsque chaque élément est retiré de la sélection.
  • event
    Type : Event
  • ui
    Type : Object
    • désélection en cours
      Type : Element
      Description : L'élément sélectionnable actuel en cours de désélection.

Exemples de code :

Initialiser le sélectionnable avec la fonction de rappel unselecting spécifiée :

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

Lier un écouteur d'événement à l'événement selectableunselecting :

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

Exemples

Un widget Selectable simple 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>

Autres extensions