jQuery UI API - Виджет Draggable
Категория
Использование
Описание:Позволяет перемещать элементы с помощью мыши.
Добавлено в версии:1.0
Зависимости:
Примечания:Делает выбранные элементы перетаскиваемыми с помощью мыши. Если вам нужно не просто перетаскивание, а drag & drop, см.плагин jQuery UI Droppable, который предоставляет цель сброса для перетаскиваемых элементов.
Быстрая навигация
| Параметры | Методы | Events |
|---|---|---|
| Параметры | Type | Описание | Default |
|---|---|---|---|
| addClasses | Boolean | Если установлено значениеfalse, это предотвратитui-draggableдобавление класса. При вызове для сотен элементов,.draggable()эта настройка полезна для оптимизации производительности.Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ addClasses: false });
После инициализации получите или задайте // getter var addClasses = $( ".selector" ).draggable( "option", "addClasses" ); // setter $( ".selector" ).draggable( "option", "addClasses", false ); |
истина |
| appendTo | jQuery, Element, Selector или String | К какому элементу следует добавлять helper перетаскиваемого элемента во время перетаскивания. Поддерживается несколько типов:
Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ appendTo: "body" });
После инициализации получите или задайте // getter var appendTo = $( ".selector" ).draggable( "option", "appendTo" ); // setter $( ".selector" ).draggable( "option", "appendTo", "body" ); |
"parent" |
| axis | String | Ограничивает перетаскивание горизонтальной (x) или вертикальной (y) осью. Возможные значения:"x", "y"。Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ axis: "x" });
После инициализации получите или задайте // getter var axis = $( ".selector" ).draggable( "option", "axis" ); // setter $( ".selector" ).draggable( "option", "axis", "x" ); |
false |
| отмена | Селектор | Предотвращает начало перетаскивания на указанных элементах. Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ cancel: ".title" });
После инициализации получите или задайте // getter var cancel = $( ".selector" ).draggable( "option", "cancel" ); // setter $( ".selector" ).draggable( "option", "cancel", ".title" ); |
"input, textarea, button, select, option" |
| connectToSortable | Селектор | Позволяет перетаскиваемому элементу быть помещённым в указанный sortable. Если используется эта опция, перетаскиваемый элемент можно поместить в список sortable, и он станет его частью. Примечание:helperПараметр должен быть установлен в"clone", чтобы это работало лучше. Необходимо включитьSortable Widget.。Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ connectToSortable: "#my-sortable" });
После инициализации получите или задайте // getter var connectToSortable = $( ".selector" ).draggable( "option", "connectToSortable" ); // setter $( ".selector" ).draggable( "option", "connectToSortable", "#my-sortable" ); |
false |
| containment | Селектор, элемент, строка или массив | Ограничивает перетаскивание пределами указанного элемента или области. Поддерживается несколько типов:
Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ containment: "parent" });
После инициализации получите или задайте // getter var containment = $( ".selector" ).draggable( "option", "containment" ); // setter $( ".selector" ).draggable( "option", "containment", "parent" ); |
false |
| cursor | String | CSS-курсор во время операции перетаскивания. Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ cursor: "crosshair" });
После инициализации получите или задайте // getter var cursor = $( ".selector" ).draggable( "option", "cursor" ); // setter $( ".selector" ).draggable( "option", "cursor", "crosshair" ); |
"auto" |
| cursorAt | Object | Задает смещение вспомогательного элемента перетаскивания относительно курсора мыши. Координаты можно задать в виде хэша с использованием комбинации одного или двух ключей:{ top, left, right, bottom }。Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ cursorAt: { left: 5 } });
После инициализации получите или задайте
// getter
var cursorAt = $( ".selector" ).draggable( "option", "cursorAt" );
// setter
$( ".selector" ).draggable( "option", "cursorAt", { left: 5 } );
|
false |
| delay | Number | Время в миллисекундах после mousedown до начала перетаскивания. Этот параметр может предотвратить нежелательное перетаскивание при щелчке по элементу. Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ delay: 300 });
После инициализации получите или задайте // getter var delay = $( ".selector" ).draggable( "option", "delay" ); // setter $( ".selector" ).draggable( "option", "delay", 300 ); |
0 |
| disabled | Boolean | Если установлено значениеtrue, затем отключает draggable.Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ disabled: true });
После инициализации получите или задайте // getter var disabled = $( ".selector" ).draggable( "option", "disabled" ); // setter $( ".selector" ).draggable( "option", "disabled", true ); |
false |
| distance | Number | Расстояние в пикселях, на которое мышь должна переместиться после mousedown, прежде чем начнётся перетаскивание. Эта опция помогает предотвратить нежелательное перетаскивание при щелчке по элементу. Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ distance: 10 });
После инициализации получите или задайте // getter var distance = $( ".selector" ).draggable( "option", "distance" ); // setter $( ".selector" ).draggable( "option", "distance", 10 ); |
1 |
| grid | Массив | Привязывает помощник перетаскивания к сетке с шагом x и y пикселей. Массив должен иметь вид[ x, y ]。Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ grid: [ 50, 20 ] });
После инициализации получите или задайте // getter var grid = $( ".selector" ).draggable( "option", "grid" ); // setter $( ".selector" ).draggable( "option", "grid", [ 50, 20 ] ); |
false |
| handle | Selector или Element | Если указан, не разрешает начинать перетаскивание, если mousedown не происходит на указанном элементе. Перетаскивать разрешено только потомкам draggable-элемента. Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ handle: "h2" });
После инициализации получите или задайте // getter var handle = $( ".selector" ).draggable( "option", "handle" ); // setter $( ".selector" ).draggable( "option", "handle", "h2" ); |
false |
| helper | String или Function() | Позволяет использовать вспомогательный элемент для отображения при перетаскивании. Поддерживается несколько типов:
Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ helper: "clone" });
После инициализации получите или задайте // getter var helper = $( ".selector" ).draggable( "option", "helper" ); // setter $( ".selector" ).draggable( "option", "helper", "clone" ); |
"original" |
| iframeFix | Boolean или Selector | Предотвращает перехват iframe-элементами событий mousemove во время перетаскивания. Полезно в сочетании сcursorAtопцией, или когда курсор мыши не находится над helper.Поддерживается несколько типов:
Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ iframeFix: true });
После инициализации получите или задайте // getter var iframeFix = $( ".selector" ).draggable( "option", "iframeFix" ); // setter $( ".selector" ).draggable( "option", "iframeFix", true ); |
false |
| opacity | Number | Непрозрачность helper во время перетаскивания. Примеры кода: Инициализировать draggable с указанными
$( ".selector" ).draggable({ opacity: 0.35 });
После инициализации получите или задайте // getter var opacity = $( ".selector" ).draggable( "option", "opacity" ); // setter $( ".selector" ).draggable( "option", "opacity", 0.35 ); |
false |
| refreshPositions | Boolean | Если установлено значениеtrue, все позиции droppable вычисляются при каждом mousemove. Примечание: это решает сценарии с высокой динамикой, но значительно снижает производительность.Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ refreshPositions: true });
Получить или задать // getter var refreshPositions = $( ".selector" ).draggable( "option", "refreshPositions" ); // setter $( ".selector" ).draggable( "option", "refreshPositions", true ); |
false |
| revert | Boolean или String или Function() | Возвращается ли элемент в исходное положение, когда перетаскивание прекращается. Поддерживает несколько типов:
Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ revert: true });
Получить или задать // getter var revert = $( ".selector" ).draggable( "option", "revert" ); // setter $( ".selector" ).draggable( "option", "revert", true ); |
false |
| revertDuration | Number | Длительность анимации возврата в миллисекундах. Еслиrevertопция равнаfalseона игнорируется.Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ revertDuration: 200 });
Получить или задать // getter var revertDuration = $( ".selector" ).draggable( "option", "revertDuration" ); // setter $( ".selector" ).draggable( "option", "revertDuration", 200 ); |
500 |
| scope | String | Используется для группировки парных элементов draggable и droppable, в дополнение кacceptопции droppable. Элемент draggable с тем жеscopeзначение, так как droppable будет принят этим droppable.Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ scope: "tasks" });
Получить или задать // getter var scope = $( ".selector" ).draggable( "option", "scope" ); // setter $( ".selector" ).draggable( "option", "scope", "tasks" ); |
"default" |
| scroll | Boolean | Если установлено значениеtrue, контейнер автоматически прокручивается во время перетаскивания.Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ scroll: false });
Получить или задать // getter var scroll = $( ".selector" ).draggable( "option", "scroll" ); // setter $( ".selector" ).draggable( "option", "scroll", false ); |
истина |
| scrollSensitivity | Number | Расстояние в пикселях от края области просмотра, с которого должна начинаться прокрутка. Расстояние отсчитывается от указателя, а не от draggable. Еслиscrollопция равнаfalseона игнорируется.Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ scrollSensitivity: 100 });
Получить или задать // getter var scrollSensitivity = $( ".selector" ).draggable( "option", "scrollSensitivity" ); // setter $( ".selector" ).draggable( "option", "scrollSensitivity", 100 ); |
20 |
| scrollSpeed | Number | Когда указатель мыши оказывается в пределахscrollSensitivityрасстояния, скорость, с которой прокручивается окно. Еслиscrollопция равнаfalseона игнорируется.Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ scrollSpeed: 100 });
Получить или задать // getter var scrollSpeed = $( ".selector" ).draggable( "option", "scrollSpeed" ); // setter $( ".selector" ).draggable( "option", "scrollSpeed", 100 ); |
20 |
| snap | Boolean или Selector | Определяет, привязывается ли элемент к другим элементам. Поддерживает несколько типов:
Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ snap: true });
Получить или задать // getter var snap = $( ".selector" ).draggable( "option", "snap" ); // setter $( ".selector" ).draggable( "option", "snap", true ); |
false |
| snapMode | String | Определяет, к какому краю цели привязки привязывается draggable. Еслиsnapопция равнаfalseэто игнорируется. Возможные значения:"inner"、"outer"、"both"。Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ snapMode: "inner" });
Получить или задать // getter var snapMode = $( ".selector" ).draggable( "option", "snapMode" ); // setter $( ".selector" ).draggable( "option", "snapMode", "inner" ); |
"both" |
| snapTolerance | Number | Расстояние в пикселях от края цели привязки, на котором происходит привязка. Еслиsnapопция равнаfalseона игнорируется.Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ snapTolerance: 30 });
Получить или задать // getter var snapTolerance = $( ".selector" ).draggable( "option", "snapTolerance" ); // setter $( ".selector" ).draggable( "option", "snapTolerance", 30 ); |
20 |
| stack | Селектор | Управляет z-index набора элементов, соответствующих селектору, чтобы они всегда находились перед текущим перетаскиваемым элементом. Полезно для таких вещей, как оконные менеджеры. Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ stack: ".products" });
Получить или задать // getter var stack = $( ".selector" ).draggable( "option", "stack" ); // setter $( ".selector" ).draggable( "option", "stack", ".products" ); |
false |
| zIndex | Number | z-index помощника при перетаскивании. Примеры кода: Инициализировать с указанными
$( ".selector" ).draggable({ zIndex: 100 });
Получить или задать // getter var zIndex = $( ".selector" ).draggable( "option", "zIndex" ); // setter $( ".selector" ).draggable( "option", "zIndex", 100 ); |
false |
| Методы | Возвращает | Описание |
|---|---|---|
| destroy() | jQuery (только плагин) | Полностью удаляет функциональность draggable. Это возвращает элемент в состояние до инициализации.
Примеры кода: Вызовите метод destroy: $( ".selector" ).draggable( "destroy" ); |
| disable() | jQuery (только плагин) | Отключает draggable.
Примеры кода: Вызовите метод disable: $( ".selector" ).draggable( "disable" ); |
| enable() | jQuery (только плагин) | Включает draggable.
Примеры кода: Вызовите метод enable: $( ".selector" ).draggable( "enable" ); |
| option( optionName ) | Object | Получает значение, связанное в данный момент с указаннымoptionNameпараметр.
Примеры кода: Вызовите метод: var isDisabled = $( ".selector" ).draggable( "option", "disabled" ); |
| option() | PlainObject | Возвращает объект, содержащий пары ключ/значение, представляющие текущий хеш опций draggable.
Примеры кода: Вызовите метод: var options = $( ".selector" ).draggable( "option" ); |
| option( optionName, value ) | jQuery (только плагин) | Устанавливает значение опции draggable, связанной с указаннымoptionNameименем опции.
Примеры кода: Вызовите метод: $( ".selector" ).draggable( "option", "disabled", true ); |
| option( options ) | jQuery (только плагин) | Устанавливает одну или несколько опций для draggable.
Примеры кода: Вызовите метод:
$( ".selector" ).draggable( "option", { disabled: true } );
|
| widget() | jQuery | ВозвращаетjQueryобъект, содержащий перетаскиваемый элемент.
Примеры кода: Вызовите метод widget: var widget = $( ".selector" ).draggable( "widget" ); |
| Events | Type | Описание |
|---|---|---|
| create( event, ui ) | dragcreate | Срабатывает при создании draggable.
Примечание: Примеры кода: Инициализируйте draggable с указанной callback-функцией create:
$( ".selector" ).draggable({
create: function( event, ui ) {}
});
Привяжите обработчик события к событию dragcreate:
$( ".selector" ).on( "dragcreate", function( event, ui ) {} );
|
| drag( event, ui ) | drag | Срабатывает при перемещении мыши во время перетаскивания.
Примеры кода: Инициализируйте draggable с указанной callback-функцией drag:
$( ".selector" ).draggable({
drag: function( event, ui ) {}
});
Привяжите обработчик события к событию drag:
$( ".selector" ).on( "drag", function( event, ui ) {} );
|
| start( event, ui ) | dragstart | Срабатывает при начале перетаскивания.
Примеры кода: Инициализируйте draggable с указанной callback-функцией start:
$( ".selector" ).draggable({
start: function( event, ui ) {}
});
Привяжите обработчик события к событию dragstart:
$( ".selector" ).on( "dragstart", function( event, ui ) {} );
|
| stop( event, ui ) | dragstop | Срабатывает, когда перетаскивание останавливается.
Примеры кода: Инициализируйте draggable с указанной callback-функцией stop:
$( ".selector" ).draggable({
stop: function( event, ui ) {}
});
Привяжите обработчик события к событию dragstop:
$( ".selector" ).on( "dragstop", function( event, ui ) {} );
|
Примеры
Простой виджет Draggable 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>
Другие расширения