API jQuery UI - Widget Draggable

Catégorie

Interactions

Utilisation

Description :Permet de déplacer des éléments à l’aide de la souris.

Version ajoutée :1.0

Dépendances :

Remarques :Rend les éléments sélectionnés déplaçables avec la souris. Si vous ne voulez pas simplement faire glisser, mais faire un glisser-déposer, consultez leplugin jQuery UI Droppable, qui fournit une cible de dépôt pour les éléments déplaçables.

Navigation rapide

Options Méthodes Événements

Options Type Description Default
addClasses Boolean Si défini surfalse, cela empêcheraui-draggablela classe d'être ajoutée. Lors d'un appel sur des centaines d'éléments,.draggable()ce paramètre est bénéfique pour l'optimisation des performances.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiéaddClassesoption:

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

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

// getter
var addClasses = $( ".selector" ).draggable( "option", "addClasses" );
 
// setter
$( ".selector" ).draggable( "option", "addClasses", false );
    
vrai
appendTo jQuery ou Element ou Selector ou String L'élément auquel le helper du draggable doit être ajouté pendant le glissement.

Plusieurs types sont pris en charge :

  • jQuery: Un objet jQuery contenant l'élément auquel ajouter le helper.
  • Element: L'élément auquel ajouter le helper.
  • Selector: Un sélecteur spécifiant à quel élément ajouter le helper.
  • String: String"parent"aura pour effet que le helper soit un frère du draggable.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiéappendTooption:

$( ".selector" ).draggable({ appendTo: "body" });
    

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

// getter
var appendTo = $( ".selector" ).draggable( "option", "appendTo" );
 
// setter
$( ".selector" ).draggable( "option", "appendTo", "body" );
    
"parent"
axis String Contraint le glissement à l'axe horizontal (x) ou vertical (y). Valeurs possibles :"x", "y"。

Exemples de code :

Initialisez le draggable avec ce qui est spécifiéaxisoption:

$( ".selector" ).draggable({ axis: "x" });
    

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

// getter
var axis = $( ".selector" ).draggable( "option", "axis" );
 
// setter
$( ".selector" ).draggable( "option", "axis", "x" );
    
false
annulation Sélecteur Empêche le glissement de commencer sur les éléments spécifiés.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiécanceloption:

$( ".selector" ).draggable({ cancel: ".title" });
    

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

// getter
var cancel = $( ".selector" ).draggable( "option", "cancel" );
 
// setter
$( ".selector" ).draggable( "option", "cancel", ".title" );
    
"input, textarea, button, select, option"
connectToSortable Sélecteur Permet au draggable d'être déposé sur le sortable spécifié. Si cette option est utilisée, un draggable peut être déposé sur une liste sortable et en faire partie. Remarque :helperL'option doit être définie sur"clone", afin qu'il fonctionne mieux. Doit inclureSortable Widget.。

Exemples de code :

Initialisez le draggable avec ce qui est spécifiéconnectToSortableoption:

$( ".selector" ).draggable({ connectToSortable: "#my-sortable" });
    

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

// getter
var connectToSortable = $( ".selector" ).draggable( "option", "connectToSortable" );
 
// setter
$( ".selector" ).draggable( "option", "connectToSortable", "#my-sortable" );
    
false
containment Sélecteur ou Élément ou Chaîne ou Tableau Contraint le glissement à l'intérieur des limites de l'élément ou de la zone spécifiée.

Plusieurs types sont pris en charge :

  • Sélecteur: L'élément déplaçable sera contenu dans les limites du premier élément trouvé par le sélecteur. Si aucun élément n'est trouvé, aucun confinement ne sera défini.
  • Élément: L'élément déplaçable sera contenu dans les limites de l'élément.
  • Chaîne: Valeurs possibles :"parent"、"document"、"window"。
  • Tableau: Un tableau, sous la forme[ x1, y1, x2, y2 ]définissant les limites de l'élément.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiécontainmentoption:

$( ".selector" ).draggable({ containment: "parent" });
    

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

// getter
var containment = $( ".selector" ).draggable( "option", "containment" );
 
// setter
$( ".selector" ).draggable( "option", "containment", "parent" );
    
false
cursor String Le curseur CSS pendant l'opération de glissement.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiécursoroption:

$( ".selector" ).draggable({ cursor: "crosshair" });
    

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

// getter
var cursor = $( ".selector" ).draggable( "option", "cursor" );
 
// setter
$( ".selector" ).draggable( "option", "cursor", "crosshair" );
    
"auto"
cursorAt Object Définit le décalage de l'assistant de glissement par rapport au curseur de la souris. Les coordonnées peuvent être données sous forme de hash en utilisant une combinaison d'une ou deux clés :{ top, left, right, bottom }。

Exemples de code :

Initialisez le draggable avec ce qui est spécifiécursorAtoption:

$( ".selector" ).draggable({ cursorAt: { left: 5 } });
    

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

// getter
var cursorAt = $( ".selector" ).draggable( "option", "cursorAt" );
 
// setter
$( ".selector" ).draggable( "option", "cursorAt", { left: 5 } );
    
false
delay Number Le délai en millisecondes après mousedown avant que le glissement ne commence. Cette option peut empêcher un glissement indésirable lors d'un clic sur un élément.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiédelayoption:

$( ".selector" ).draggable({ delay: 300 });
    

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

// getter
var delay = $( ".selector" ).draggable( "option", "delay" );
 
// setter
$( ".selector" ).draggable( "option", "delay", 300 );
    
0
disabled Boolean Si défini surtrue, puis désactive le draggable.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiédisabledoption:

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

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

// getter
var disabled = $( ".selector" ).draggable( "option", "disabled" );
 
// setter
$( ".selector" ).draggable( "option", "disabled", true );
    
false
distance Number La distance en pixels dont la souris doit se déplacer après mousedown avant que le déplacement ne commence. Cette option peut empêcher les déplacements indésirables lors d'un clic sur un élément.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiédistanceoption:

$( ".selector" ).draggable({ distance: 10 });
    

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

// getter
var distance = $( ".selector" ).draggable( "option", "distance" );
 
// setter
$( ".selector" ).draggable( "option", "distance", 10 );
    
1
grid Tableau Aligne l'assistant de déplacement sur une grille, tous les x et y pixels. Le tableau doit être de la forme[ x, y ]。

Exemples de code :

Initialisez le draggable avec ce qui est spécifiégridoption:

$( ".selector" ).draggable({ grid: [ 50, 20 ] });
    

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

// getter
var grid = $( ".selector" ).draggable( "option", "grid" );
 
// setter
$( ".selector" ).draggable( "option", "grid", [ 50, 20 ] );
    
false
handle Sélecteur ou Element Si spécifié, empêche le déplacement de commencer à moins qu'un mousedown ne se produise sur l'élément spécifié. Seuls les descendants de l'élément déplaçable peuvent être déplacés.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiéhandleoption:

$( ".selector" ).draggable({ handle: "h2" });
    

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

// getter
var handle = $( ".selector" ).draggable( "option", "handle" );
 
// setter
$( ".selector" ).draggable( "option", "handle", "h2" );
    
false
helper String ou Function() Permet d'utiliser un élément d'assistance pour l'affichage du déplacement.

Plusieurs types sont pris en charge :

  • String: Si défini sur"clone", l'élément sera cloné et le clone sera déplacé.
  • Function: Une fonction qui renverra un DOMElement à utiliser pendant le déplacement.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiéhelperoption:

$( ".selector" ).draggable({ helper: "clone" });
    

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

// getter
var helper = $( ".selector" ).draggable( "option", "helper" );
 
// setter
$( ".selector" ).draggable( "option", "helper", "clone" );
    
"original"
iframeFix Boolean ou Selector Empêche les iframes de capturer les événements mousemove pendant un glissement. Utile en combinaison avec l'cursorAtoption, ou lorsque le curseur de la souris n'est pas au-dessus du helper.

Plusieurs types sont pris en charge :

  • Boolean: Lorsqu'il est défini surtrue, un calque transparent sera placé au-dessus de toutes les iframes de la page.
  • Sélecteur: Toutes les iframes correspondant au sélecteur seront couvertes par un calque transparent.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiéiframeFixoption:

$( ".selector" ).draggable({ iframeFix: true });
    

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

// getter
var iframeFix = $( ".selector" ).draggable( "option", "iframeFix" );
 
// setter
$( ".selector" ).draggable( "option", "iframeFix", true );
    
false
opacity Number L'opacité du helper pendant le glissement.

Exemples de code :

Initialisez le draggable avec ce qui est spécifiéopacityoption:

$( ".selector" ).draggable({ opacity: 0.35 });
    

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

// getter
var opacity = $( ".selector" ).draggable( "option", "opacity" );
 
// setter
$( ".selector" ).draggable( "option", "opacity", 0.35 );
    
false
refreshPositions Boolean Si défini surtrue, toutes les positions droppable sont calculées à chaque mousemove. Remarque : Cela résout des scénarios très dynamiques, mais réduit considérablement les performances.

Exemples de code :

Initialiser avec lesrefreshPositionsoptions spécifiées pour le draggable :

$( ".selector" ).draggable({ refreshPositions: true });
    

Obtenir ou définir l'refreshPositionsoption après initialisation :

// getter
var refreshPositions = $( ".selector" ).draggable( "option", "refreshPositions" );
 
// setter
$( ".selector" ).draggable( "option", "refreshPositions", true );
    
false
revert Boolean ou String ou Function() Indique si l'élément revient à sa position de départ lorsque le glissement s'arrête.

Prend en charge plusieurs types :

  • Boolean: S'il est défini surtrue, l'élément revient toujours.
  • String: Si défini sur"invalid", le retour ne se produit que lorsque l'élément draggable n'est pas placé sur un droppable ; s'il est défini sur"valid"l'inverse se produit.
  • Function: Une fonction qui détermine si l'élément revient à sa position de départ. La fonction doit renvoyertruepour que l'élément revienne.

Exemples de code :

Initialiser avec lesrevertoptions spécifiées pour le draggable :

$( ".selector" ).draggable({ revert: true });
    

Obtenir ou définir l'revertoption après initialisation :

// getter
var revert = $( ".selector" ).draggable( "option", "revert" );
 
// setter
$( ".selector" ).draggable( "option", "revert", true );
    
false
revertDuration Number La durée de l'animation de retour, en millisecondes. Si l'revertoption estfalseelle est ignorée.

Exemples de code :

Initialiser avec lesrevertDurationoptions spécifiées pour le draggable :

$( ".selector" ).draggable({ revertDuration: 200 });
    

Obtenir ou définir l'revertDurationoption après initialisation :

// getter
var revertDuration = $( ".selector" ).draggable( "option", "revertDuration" );
 
// setter
$( ".selector" ).draggable( "option", "revertDuration", 200 );
    
500
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 avec lesscopeoptions spécifiées pour le draggable :

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

Obtenir ou définir l'scopeoption après initialisation :

// getter
var scope = $( ".selector" ).draggable( "option", "scope" );
 
// setter
$( ".selector" ).draggable( "option", "scope", "tasks" );
    
"default"
scroll Boolean Si défini surtrue, le conteneur défile automatiquement pendant le glissement.

Exemples de code :

Initialiser avec lesscrolloptions spécifiées pour le draggable :

$( ".selector" ).draggable({ scroll: false });
    

Obtenir ou définir l'scrolloption après initialisation :

// getter
var scroll = $( ".selector" ).draggable( "option", "scroll" );
 
// setter
$( ".selector" ).draggable( "option", "scroll", false );
    
vrai
scrollSensitivity Number La distance en pixels depuis le bord de la fenêtre d'affichage à partir de laquelle le défilement doit commencer. La distance est relative au pointeur, pas au draggable. Si lescrolloption estfalseelle est ignorée.

Exemples de code :

Initialiser avec lesscrollSensitivityoptions spécifiées pour le draggable :

$( ".selector" ).draggable({ scrollSensitivity: 100 });
    

Obtenir ou définir l'scrollSensitivityoption après initialisation :

// getter
var scrollSensitivity = $( ".selector" ).draggable( "option", "scrollSensitivity" );
 
// setter
$( ".selector" ).draggable( "option", "scrollSensitivity", 100 );
    
20
scrollSpeed Number Lorsque le pointeur de la souris arrive à moins descrollSensitivitydistance, la vitesse à laquelle la fenêtre défile. Si lescrolloption estfalseelle est ignorée.

Exemples de code :

Initialiser avec lesscrollSpeedoptions spécifiées pour le draggable :

$( ".selector" ).draggable({ scrollSpeed: 100 });
    

Obtenir ou définir l'scrollSpeedoption après initialisation :

// getter
var scrollSpeed = $( ".selector" ).draggable( "option", "scrollSpeed" );
 
// setter
$( ".selector" ).draggable( "option", "scrollSpeed", 100 );
    
20
snap Boolean ou Selector Indique si l'élément s'aligne sur d'autres éléments.

Prend en charge plusieurs types :

  • Boolean: Lorsqu'il est défini surtrue, l'élément s'aligne sur d'autres éléments draggables.
  • Sélecteur: Un sélecteur spécifiant les éléments sur lesquels s'aligner.

Exemples de code :

Initialiser avec lessnapoptions spécifiées pour le draggable :

$( ".selector" ).draggable({ snap: true });
    

Obtenir ou définir l'snapoption après initialisation :

// getter
var snap = $( ".selector" ).draggable( "option", "snap" );
 
// setter
$( ".selector" ).draggable( "option", "snap", true );
    
false
snapMode String Détermine sur quel bord de la cible d'alignement le draggable s'aligne. Si lesnapoption estfalseil est ignoré. Valeurs possibles :"inner"、"outer"、"both"。

Exemples de code :

Initialiser avec lessnapModeoptions spécifiées pour le draggable :

$( ".selector" ).draggable({ snapMode: "inner" });
    

Obtenir ou définir l'snapModeoption après initialisation :

// getter
var snapMode = $( ".selector" ).draggable( "option", "snapMode" );
 
// setter
$( ".selector" ).draggable( "option", "snapMode", "inner" );
    
"both"
snapTolerance Number La distance en pixels depuis le bord de la cible d'alignement à laquelle l'alignement se produit. Si lesnapoption estfalseelle est ignorée.

Exemples de code :

Initialiser avec lessnapToleranceoptions spécifiées pour le draggable :

$( ".selector" ).draggable({ snapTolerance: 30 });
    

Obtenir ou définir l'snapToleranceoption après initialisation :

// getter
var snapTolerance = $( ".selector" ).draggable( "option", "snapTolerance" );
 
// setter
$( ".selector" ).draggable( "option", "snapTolerance", 30 );
    
20
stack Sélecteur Contrôle le z-index de l'ensemble des éléments qui correspondent au sélecteur, toujours devant l'élément en cours de glissement. Utile pour des choses comme les gestionnaires de fenêtres.

Exemples de code :

Initialiser avec lesstackoptions spécifiées pour le draggable :

$( ".selector" ).draggable({ stack: ".products" });
    

Obtenir ou définir l'stackoption après initialisation :

// getter
var stack = $( ".selector" ).draggable( "option", "stack" );
 
// setter
$( ".selector" ).draggable( "option", "stack", ".products" );
    
false
zIndex Number Le z-index du helper lors du glissement.

Exemples de code :

Initialiser avec leszIndexoptions spécifiées pour le draggable :

$( ".selector" ).draggable({ zIndex: 100 });
    

Obtenir ou définir l'zIndexoption après initialisation :

// getter
var zIndex = $( ".selector" ).draggable( "option", "zIndex" );
 
// setter
$( ".selector" ).draggable( "option", "zIndex", 100 );
    
false

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

Exemples de code :

Invoquer la méthode destroy :

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

Exemples de code :

Invoquer la méthode disable :

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

Exemples de code :

Invoquer la méthode enable :

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

Exemples de code :

Invoquez la méthode :

var isDisabled = $( ".selector" ).draggable( "option", "disabled" );
    
option() PlainObject Récupère un objet contenant des paires clé/valeur qui représentent le hash des options actuelles du draggable.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Invoquez la méthode :

var options = $( ".selector" ).draggable( "option" );
    
option( optionName, value ) jQuery (plugin uniquement) Définit la valeur de l'option du draggable associée au nomoptionNamed'option spécifié.
  • 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 la méthode :

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

Exemples de code :

Invoquez la méthode :

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

Exemples de code :

Invoquez la méthode widget :

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

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

Remarque :uiL'objet est vide, mais inclus pour la cohérence avec les autres événements.

Exemples de code :

Initialisez le draggable avec la fonction de rappel create spécifiée :

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

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

$( ".selector" ).on( "dragcreate", function( event, ui ) {} );
    
drag( event, ui ) drag Déclenché lorsque la souris se déplace pendant le glissement.
  • event
    Type : Event
  • ui
    Type : Object
    • helper
      Type : jQuery
      Description : L'objet jQuery représentant le helper du draggable.
    • position
      Type : Object
      Description : La position CSS actuelle du helper, par exemple, un{ top, left }objet.
    • offset
      Type : Object
      Description : La position de décalage actuelle du helper, par exemple, un{ top, left }objet.

Exemples de code :

Initialisez le draggable avec la fonction de rappel drag spécifiée :

$( ".selector" ).draggable({
  drag: function( event, ui ) {}
});
    

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

$( ".selector" ).on( "drag", function( event, ui ) {} );
    
start( event, ui ) dragstart Déclenché lorsque le glissement commence.
  • event
    Type : Event
  • ui
    Type : Object
    • helper
      Type : jQuery
      Description : L'objet jQuery représentant le helper du draggable.
    • position
      Type : Object
      Description : La position CSS actuelle du helper, par exemple, un{ top, left }objet.
    • offset
      Type : Object
      Description : La position de décalage actuelle du helper, par exemple, un{ top, left }objet.

Exemples de code :

Initialiser le draggable avec la fonction de rappel start spécifiée :

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

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

$( ".selector" ).on( "dragstart", function( event, ui ) {} );
    
stop( event, ui ) dragstop Déclenché lorsque le glissement s'arrête.
  • event
    Type : Event
  • ui
    Type : Object
    • helper
      Type : jQuery
      Description : L'objet jQuery représentant le helper en cours de glissement.
    • position
      Type : Object
      Description : La position CSS actuelle du helper, telle que{ top, left }objet.
    • offset
      Type : Object
      Description : La position de décalage actuelle du helper, telle que{ top, left }objet.

Exemples de code :

Initialiser le draggable avec la fonction de rappel stop spécifiée :

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

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

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

Exemples

Un widget Draggable simple de jQuery UI.

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>可拖拽小部件(Draggable 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;
  }
  </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="draggable">请拖拽我!</div>
 
<script>
$( "#draggable" ).draggable();
</script>
 
</body>
</html>

Autres extensions