jQuery UI API - Виджет Droppable

Категория

Взаимодействия

Использование

Описание:Создаёт цели для перетаскиваемых виджетов.

Добавлено в версии:1.0

Зависимости:

Примечания:Плагин jQuery UI Droppable делает выбранные элементы droppable (то есть они принимают сброс после перетаскивания). Можно указать, какие перетаскиваемые элементы будут приниматься по отдельности.

Быстрая навигация

Параметры Методы Events

Параметры Type Описание Default
accept Селектор или Function() Управляет тем, какие перетаскиваемые элементы могут быть приняты droppable.

Поддерживает несколько типов:

  • Селектор: Селектор, указывающий, какие перетаскиваемые элементы могут быть приняты droppable.
  • Function(): Функция, которая будет вызываться для каждого перетаскиваемого элемента на странице (передаётся в функцию в качестве первого аргумента). Если перетаскиваемый элемент принимается, функция должна вернутьtrue。

Примеры кода:

Инициализируйте droppable с указаннойacceptoption:

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

После инициализации получите или задайтеacceptопцию:

// getter
var accept = $( ".selector" ).droppable( "option", "accept" );
 
// setter
$( ".selector" ).droppable( "option", "accept", ".special" );
    
"*"
activeClass String Если указано, класс будет добавлен к droppable, когда допустимый draggable начинает перетаскиваться.

Примеры кода:

Инициализируйте droppable с указаннойactiveClassoption:

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

После инициализации получите или задайтеactiveClassопцию:

// getter
var activeClass = $( ".selector" ).droppable( "option", "activeClass" );
 
// setter
$( ".selector" ).droppable( "option", "activeClass", "ui-state-highlight" );
    
false
addClasses Boolean Если установлено значениеfalse, предотвратитui-droppableдобавление класса. При вызове на сотнях элементов.droppable()это помогает оптимизации производительности.

Примеры кода:

Инициализируйте droppable с указаннойaddClassesoption:

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

После инициализации получите или задайтеaddClassesопцию:

// getter
var addClasses = $( ".selector" ).droppable( "option", "addClasses" );
 
// setter
$( ".selector" ).droppable( "option", "addClasses", false );
    
истина
disabled Boolean Если установлено значениеtrue, droppable отключён.

Примеры кода:

Инициализируйте droppable с указаннойdisabledoption:

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

После инициализации получите или задайтеdisabledопцию:

// getter
var disabled = $( ".selector" ).droppable( "option", "disabled" );
 
// setter
$( ".selector" ).droppable( "option", "disabled", true );
    
false
greedy Boolean По умолчанию, когда элемент сбрасывается на вложенные droppable, каждый droppable получит элемент. Однако, установив эту опцию вtrue, droppable любого родительского элемента не будет получать элемент.dropСобытия всё равно будут срабатывать как обычно, но будет проверятьсяevent.targetчтобы увидеть, какой droppable получает элемент draggable.

Примеры кода:

Инициализируйте droppable с указаннойgreedyoption:

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

После инициализации получите или задайтеgreedyопцию:

// getter
var greedy = $( ".selector" ).droppable( "option", "greedy" );
 
// setter
$( ".selector" ).droppable( "option", "greedy", true );
    
false
hoverClass String Если указано, класс будет добавлен к droppable, когда допустимый draggable находится над droppable.

Примеры кода:

Инициализируйте droppable с указаннойhoverClassoption:

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

После инициализации получите или задайтеhoverClassопцию:

// getter
var hoverClass = $( ".selector" ).droppable( "option", "hoverClass" );
 
// setter
$( ".selector" ).droppable( "option", "hoverClass", "drop-hover" );
    
false
scope String Используется для группировки парных элементов draggable и droppable, в дополнение кacceptопции droppable. Элемент draggable с тем жеscopeзначение, так как droppable будет принят этим droppable.

Примеры кода:

Инициализируйте droppable с указаннойscopeoption:

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

После инициализации получите или задайтеscopeопцию:

// getter
var scope = $( ".selector" ).droppable( "option", "scope" );
 
// setter
$( ".selector" ).droppable( "option", "scope", "tasks" );
    
"default"
tolerance String Задает режим, используемый для проверки того, находится ли draggable над droppable. Возможные значения:
  • "fit": draggable полностью перекрывает droppable.
  • "intersect": draggable перекрывает droppable как минимум на 50% в обоих направлениях.
  • "pointer": указатель мыши перекрывает droppable.
  • "touch": draggable перекрывает droppable на любую величину.

Примеры кода:

Инициализируйте droppable с указаннойtoleranceoption:

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

После инициализации получите или задайтеtoleranceопцию:

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

Методы Возвращает Описание
destroy() jQuery (только плагин) Полностью удалить функциональность droppable. Это вернет элемент в состояние до инициализации.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите метод destroy:

$( ".selector" ).droppable( "destroy" );
    
disable() jQuery (только плагин) Отключить droppable.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите метод disable:

$( ".selector" ).droppable( "disable" );
    
enable() jQuery (только плагин) Включить droppable.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите метод enable:

$( ".selector" ).droppable( "enable" );
    
option( optionName ) Object Получить значение, в данный момент связанное с указаннымoptionNameпараметр.
  • optionName
    Тип: String
    Описание: Имя опции, которую нужно получить.

Примеры кода:

Вызовите этот метод:

var isDisabled = $( ".selector" ).droppable( "option", "disabled" );
    
option() PlainObject Получить объект, содержащий пары ключ/значение, представляющие текущий хеш параметров droppable.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите этот метод:

var options = $( ".selector" ).droppable( "option" );
    
option( optionName, value ) jQuery (только плагин) Задать значение опции droppable, связанной с указаннымoptionNameпараметр.
  • optionName
    Тип: String
    Описание: Имя опции, которую нужно установить.
  • value
    Тип: Object
    Описание: Значение, задаваемое для параметра.

Примеры кода:

Вызовите этот метод:

$( ".selector" ).droppable( "option", "disabled", true );
    
option( options ) jQuery (только плагин) Задать одну или несколько опций для droppable.
  • options
    Тип: Object
    Описание: Пары «параметр — значение» для установки.

Примеры кода:

Вызовите этот метод:

$( ".selector" ).droppable( "option", { disabled: true } );
    
widget() jQuery ВернутьjQueryобъект, содержащий элемент droppable.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите метод widget:

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

Events Type Описание
activate( event, ui ) dropactivate Срабатывает, когда допустимый draggable начинает перетаскивание. Эта опция полезна, если вы хотите, чтобы droppable «подсвечивался», когда на него можно сбросить элемент.
  • event
    Тип: Event
  • ui
    Тип: Object
    • draggable
      Тип: jQuery
      Описание: объект jQuery, представляющий элемент draggable.
    • helper
      Тип: jQuery
      Описание: объект jQuery, представляющий перетаскиваемый helper.
    • position
      Тип: Object
      Описание: текущая CSS-позиция draggable helper, например{ top, left }объект.
    • offset
      Тип: Object
      Описание: текущая позиция смещения draggable helper, например{ top, left }объект.

Примеры кода:

Инициализировать droppable с указанным обратным вызовом activate:

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

Привязать обработчик события к событию dropactivate:

$( ".selector" ).on( "dropactivate", function( event, ui ) {} );
    
create( event, ui ) dropcreate Срабатывает при создании droppable.
  • event
    Тип: Event
  • ui
    Тип: Object

Примечание:uiОбъект пуст; он включён здесь для согласованности с другими событиями.

Примеры кода:

Инициализируйте droppable с указанной функцией обратного вызова create:

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

Привяжите прослушиватель событий к событию dropcreate:

$( ".selector" ).on( "dropcreate", function( event, ui ) {} );
    
deactivate( event, ui ) dropdeactivate Срабатывает, когда допустимый draggable прекращает перетаскивание.
  • event
    Тип: Event
  • ui
    Тип: Object
    • draggable
      Тип: jQuery
      Описание: объект jQuery, представляющий элемент draggable.
    • helper
      Тип: jQuery
      Описание: объект jQuery, представляющий helper элемента draggable.
    • position
      Тип: Object
      Описание: текущая CSS-позиция draggable helper, например{ top, left }объект.
    • offset
      Тип: Object
      Описание: текущая позиция смещения draggable helper, например{ top, left }объект.

Примеры кода:

Инициализируйте droppable с указанной функцией обратного вызова deactivate:

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

Привяжите прослушиватель событий к событию dropdeactivate:

$( ".selector" ).on( "dropdeactivate", function( event, ui ) {} );
    
drop( event, ui ) drop Срабатывает, когда допустимый draggable сброшен на droppable (на основеtoleranceопции).
  • event
    Тип: Event
  • ui
    Тип: Object
    • draggable
      Тип: jQuery
      Описание: объект jQuery, представляющий элемент draggable.
    • helper
      Тип: jQuery
      Описание: объект jQuery, представляющий helper элемента draggable.
    • position
      Тип: Object
      Описание: текущая CSS-позиция draggable helper, например{ top, left }объект.
    • offset
      Тип: Object
      Описание: текущая позиция смещения draggable helper, например{ top, left }объект.

Примеры кода:

Инициализируйте droppable с указанной функцией обратного вызова drop:

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

Привяжите обработчик события к событию drop:

$( ".selector" ).on( "drop", function( event, ui ) {} );
    
out( event, ui ) dropout Срабатывает, когда draggable перетаскивается за пределы droppable (на основеtoleranceопции).
  • event
    Тип: Event
  • ui
    Тип: Object

Примечание:uiОбъект пуст; он включён здесь для согласованности с другими событиями.

Примеры кода:

Инициализируйте droppable с указанной функцией обратного вызова out:

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

Привяжите обработчик события к событию dropout:

$( ".selector" ).on( "dropout", function( event, ui ) {} );
    
over( event, ui ) dropover Срабатывает, когда допустимый draggable перетаскивается над droppable (на основеtoleranceопции).
  • event
    Тип: Event
  • ui
    Тип: Object
    • draggable
      Тип: jQuery
      Описание: объект jQuery, представляющий элемент draggable.
    • helper
      Тип: jQuery
      Описание: объект jQuery, представляющий helper элемента draggable.
    • position
      Тип: Object
      Описание: текущая CSS-позиция draggable helper, например{ top, left }объект.
    • offset
      Тип: Object
      Описание: текущая позиция смещения draggable helper, например{ top, left }объект.

Примеры кода:

Инициализируйте droppable с указанной функцией обратного вызова over:

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

Привяжите обработчик события к событию dropover:

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

Примеры

Пара элементов draggable и 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>

Другие расширения