jQuery UI API - Widget Droppable

Catégorie

Interactions

Utilisation

Description :Crée des cibles pour les widgets déplaçables.

添加于版本:1.0

Dépendances :

Notes :Le plugin Droppable de jQuery UI rend les éléments sélectionnés déposables (c'est-à-dire qu'ils acceptent d'être déposés après avoir été déplacés). Vous pouvez spécifier quels éléments déplaçables seront acceptés individuellement.

Navigation rapide

Options Méthodes Événements

Options Type Description Default
accept Sélecteur ou Function() Contrôle quels éléments déplaçables peuvent être acceptés par le droppable.

Prend en charge plusieurs types :

  • Sélecteur: Un sélecteur spécifiant quels éléments déplaçables peuvent être acceptés par le droppable.
  • Function(): Une fonction qui sera appelée pour chaque élément déplaçable de la page (transmise à la fonction comme premier argument). Si l'élément déplaçable est accepté, la fonction doit retournertrue。

Exemples de code :

Initialiser le droppable avec le paramètre spécifiéacceptoption:

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

Après l'initialisation, obtenir ou définiracceptl'option :

// getter
var accept = $( ".selector" ).droppable( "option", "accept" );
 
// setter
$( ".selector" ).droppable( "option", "accept", ".special" );
    
"*"
activeClass String Si spécifiée, la classe sera ajoutée au droppable lorsqu'un draggable acceptable commence à être glissé.

Exemples de code :

Initialiser le droppable avec le paramètre spécifiéactiveClassoption:

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

Après l'initialisation, obtenir ou définiractiveClassl'option :

// getter
var activeClass = $( ".selector" ).droppable( "option", "activeClass" );
 
// setter
$( ".selector" ).droppable( "option", "activeClass", "ui-state-highlight" );
    
false
addClasses Boolean Si défini surfalse, empêcheraui-droppablela classe d'être ajoutée. Lors d'un appel sur des centaines d'éléments.droppable()cela aide à optimiser les performances.

Exemples de code :

Initialiser le droppable avec le paramètre spécifiéaddClassesoption:

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

Après l'initialisation, obtenir ou définiraddClassesl'option :

// getter
var addClasses = $( ".selector" ).droppable( "option", "addClasses" );
 
// setter
$( ".selector" ).droppable( "option", "addClasses", false );
    
vrai
disabled Boolean Si défini surtrue, le droppable est désactivé.

Exemples de code :

Initialiser le droppable avec le paramètre spécifiédisabledoption:

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

Après l'initialisation, obtenir ou définirdisabledl'option :

// getter
var disabled = $( ".selector" ).droppable( "option", "disabled" );
 
// setter
$( ".selector" ).droppable( "option", "disabled", true );
    
false
greedy Boolean Par défaut, lorsqu'un élément est déposé sur des droppables imbriqués, chaque droppable recevra l'élément. Cependant, en définissant cette option surtrue, le droppable de tout élément parent ne recevra pas l'élément.dropLes événements se déclencheront toujours comme d'habitude, mais il vérifieraevent.targetpour voir quel droppable reçoit l'élément draggable.

Exemples de code :

Initialiser le droppable avec le paramètre spécifiégreedyoption:

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

Après l'initialisation, obtenir ou définirgreedyl'option :

// getter
var greedy = $( ".selector" ).droppable( "option", "greedy" );
 
// setter
$( ".selector" ).droppable( "option", "greedy", true );
    
false
hoverClass String Si spécifié, la classe sera ajoutée au droppable lorsqu'un draggable acceptable survole le droppable.

Exemples de code :

Initialiser le droppable avec le paramètre spécifiéhoverClassoption:

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

Après l'initialisation, obtenir ou définirhoverClassl'option :

// getter
var hoverClass = $( ".selector" ).droppable( "option", "hoverClass" );
 
// setter
$( ".selector" ).droppable( "option", "hoverClass", "drop-hover" );
    
false
scope String Utilisé pour regrouper des éléments draggable et droppable appariés, en plus de l'acceptoption du droppable. Un draggable avec le mêmescopevaleur comme le droppable sera accepté par ce droppable.

Exemples de code :

Initialiser le droppable avec le paramètre spécifiéscopeoption:

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

Après l'initialisation, obtenir ou définirscopel'option :

// getter
var scope = $( ".selector" ).droppable( "option", "scope" );
 
// setter
$( ".selector" ).droppable( "option", "scope", "tasks" );
    
"default"
tolerance String Spécifie le mode utilisé pour tester si un draggable est au-dessus d'un droppable. Valeurs possibles :
  • "fit": Le draggable chevauche complètement le droppable.
  • "intersect": Le draggable chevauche le droppable d'au moins 50% dans les deux directions.
  • "pointer": Le pointeur de la souris chevauche le droppable.
  • "touch": Le draggable chevauche le droppable de n'importe quelle quantité.

Exemples de code :

Initialiser le droppable avec le paramètre spécifiétoleranceoption:

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

Après l'initialisation, obtenir ou définirtolerancel'option :

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

Méthodes Renvoie Description
destroy() jQuery (plugin uniquement) Supprime complètement la fonctionnalité droppable. Cela ramènera l'élément à son état antérieur à l'initialisation.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Invoquer la méthode destroy :

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

Exemples de code :

Invoquer la méthode disable :

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

Exemples de code :

Invoquer la méthode enable :

$( ".selector" ).droppable( "enable" );
    
option( optionName ) Object Obtient la valeur actuellement associée au nom d'option spécifiéoptionNameoption.
  • optionName
    Type : String
    Description : Le nom de l'option à obtenir.

Exemples de code :

Invoquez cette méthode :

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

Exemples de code :

Invoquez cette méthode :

var options = $( ".selector" ).droppable( "option" );
    
option( optionName, value ) jQuery (plugin uniquement) Définir la valeur de l'option droppable associée au nom d'option spécifiéoptionNameoption.
  • 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 :

Invoquez cette méthode :

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

Exemples de code :

Invoquez cette méthode :

$( ".selector" ).droppable( "option", { disabled: true } );
    
widget() jQuery Retourne unjQueryobjet contenant l'élément droppable.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Invoquez la méthode widget :

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

Événements Type Description
activate( event, ui ) dropactivate Déclenché lorsqu'un draggable acceptable commence à être glissé. Cette option est utile si vous souhaitez faire en sorte que le droppable « s'illumine » lorsqu'un élément peut y être déposé.
  • event
    Type : Event
  • ui
    Type : Object
    • draggable
      Type : jQuery
      Description : un objet jQuery représentant l'élément draggable.
    • helper
      Type : jQuery
      Description : un objet jQuery représentant le helper glissé.
    • position
      Type : Object
      Description : la position CSS actuelle du helper draggable, telle que{ top, left }objet.
    • offset
      Type : Object
      Description : la position de décalage actuelle du helper draggable, telle que{ top, left }objet.

Exemples de code :

Initialiser le droppable avec le callback activate spécifié :

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

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

$( ".selector" ).on( "dropactivate", function( event, ui ) {} );
    
create( event, ui ) dropcreate Déclenché lorsque le droppable est créé.
  • 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 :

Initialiser le droppable avec la fonction de rappel create spécifiée :

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

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

$( ".selector" ).on( "dropcreate", function( event, ui ) {} );
    
deactivate( event, ui ) dropdeactivate Déclenché lorsqu'un draggable acceptable cesse d'être déplacé.
  • event
    Type : Event
  • ui
    Type : Object
    • draggable
      Type : jQuery
      Description : un objet jQuery représentant l'élément draggable.
    • helper
      Type : jQuery
      Description : Un objet jQuery représentant le helper draggable.
    • position
      Type : Object
      Description : la position CSS actuelle du helper draggable, telle que{ top, left }objet.
    • offset
      Type : Object
      Description : la position de décalage actuelle du helper draggable, telle que{ top, left }objet.

Exemples de code :

Initialiser le droppable avec la fonction de rappel deactivate spécifiée :

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

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

$( ".selector" ).on( "dropdeactivate", function( event, ui ) {} );
    
drop( event, ui ) drop Déclenché lorsqu'un draggable acceptable est déposé sur le droppable (en fonction detolerancel'option).
  • event
    Type : Event
  • ui
    Type : Object
    • draggable
      Type : jQuery
      Description : un objet jQuery représentant l'élément draggable.
    • helper
      Type : jQuery
      Description : Un objet jQuery représentant le helper draggable.
    • position
      Type : Object
      Description : la position CSS actuelle du helper draggable, telle que{ top, left }objet.
    • offset
      Type : Object
      Description : la position de décalage actuelle du helper draggable, telle que{ top, left }objet.

Exemples de code :

Initialisez le droppable avec la fonction de rappel drop spécifiée :

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

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

$( ".selector" ).on( "drop", function( event, ui ) {} );
    
out( event, ui ) dropout Déclenché lorsqu'un draggable est glissé hors du droppable (en fonction detolerancel'option).
  • 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 droppable avec la fonction de rappel out spécifiée :

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

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

$( ".selector" ).on( "dropout", function( event, ui ) {} );
    
over( event, ui ) dropover Déclenché lorsqu'un draggable acceptable est glissé au-dessus du droppable (en fonction detolerancel'option).
  • event
    Type : Event
  • ui
    Type : Object
    • draggable
      Type : jQuery
      Description : un objet jQuery représentant l'élément draggable.
    • helper
      Type : jQuery
      Description : Un objet jQuery représentant le helper draggable.
    • position
      Type : Object
      Description : la position CSS actuelle du helper draggable, telle que{ top, left }objet.
    • offset
      Type : Object
      Description : la position de décalage actuelle du helper draggable, telle que{ top, left }objet.

Exemples de code :

Initialisez le droppable avec la fonction de rappel over spécifiée :

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

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

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

Exemples

Une paire d'éléments déplaçables et déposables.

<!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>

Autres extensions