Create sortable grids and lists to rearrange the order of its elements.
Drag and drop an element to a new location within the sortable grid, while the other items adjust to fit. This is great, if you want to sort items like gallery or menu items, for example.
To apply this component, add the uk-sortable attribute to a container and create child elements.
<div uk-sortable>
<div></div>
<div></div>
</div>
<ul
class="uk-child-width-1-4@s uk-grid-small uk-child-width-1-2"
uk-sortable="handle: .handle"
uk-grid
>
<li>
<div
class="handle uk-background-muted uk-padding-small uk-text-small uk-text-center"
>
Item 1
</div>
</li>
<li>
<div
class="handle uk-background-muted uk-padding-small uk-text-small uk-text-center"
>
Item 2
</div>
</li>
<li>
<div
class="handle uk-background-muted uk-padding-small uk-text-small uk-text-center"
>
Item 3
</div>
</li>
<li>
<div
class="handle uk-background-muted uk-padding-small uk-text-small uk-text-center"
>
Item 4
</div>
</li>
<li>
<div
class="handle uk-background-muted uk-padding-small uk-text-small uk-text-center"
>
Item 5
</div>
</li>
<li>
<div
class="handle uk-background-muted uk-padding-small uk-text-small uk-text-center"
>
Item 6
</div>
</li>
<li>
<div
class="handle uk-background-muted uk-padding-small uk-text-small uk-text-center"
>
Item 7
</div>
</li>
<li>
<div
class="handle uk-background-muted uk-padding-small uk-text-small uk-text-center"
>
Item 8
</div>
</li>
</ul>By default, the entire sortable element can be used for drag and drop sorting. To create a handle which will be used instead, just add the handle: SELECTOR option to the attribute and add the handle class to the element that you want to use as a handle.
<ul uk-sortable="handle: .uk-sortable-handle">
<li>
<div class="uk-sortable-handle"></div>
...
</li>
</ul>
<ul
class="uk-child-width-1-4@s uk-grid-small uk-child-width-1-2"
uk-sortable="handle: .uk-sortable-handle"
uk-grid
>
<li>
<div
class="uk-background-muted uk-flex uk-flex-middle uk-padding-small uk-text-small"
>
<span
class="uk-margin-small-right uk-sortable-handle uk-text-center"
uk-icon="ratio: 0.8; icon: table"
></span
>Item 1
</div>
</li>
<li>
<div
class="uk-background-muted uk-flex uk-flex-middle uk-padding-small uk-text-small"
>
<span
class="uk-margin-small-right uk-sortable-handle uk-text-center"
uk-icon="ratio: 0.8; icon: table"
></span
>Item 2
</div>
</li>
<li>
<div
class="uk-background-muted uk-flex uk-flex-middle uk-padding-small uk-text-small"
>
<span
class="uk-margin-small-right uk-sortable-handle uk-text-center"
uk-icon="ratio: 0.8; icon: table"
></span
>Item 3
</div>
</li>
<li>
<div
class="uk-background-muted uk-flex uk-flex-middle uk-padding-small uk-text-small"
>
<span
class="uk-margin-small-right uk-sortable-handle uk-text-center"
uk-icon="ratio: 0.8; icon: table"
></span
>Item 4
</div>
</li>
<li>
<div
class="uk-background-muted uk-flex uk-flex-middle uk-padding-small uk-text-small"
>
<span
class="uk-margin-small-right uk-sortable-handle uk-text-center"
uk-icon="ratio: 0.8; icon: table"
></span
>Item 5
</div>
</li>
<li>
<div
class="uk-background-muted uk-flex uk-flex-middle uk-padding-small uk-text-small"
>
<span
class="uk-margin-small-right uk-sortable-handle uk-text-center"
uk-icon="ratio: 0.8; icon: table"
></span
>Item 6
</div>
</li>
<li>
<div
class="uk-background-muted uk-flex uk-flex-middle uk-padding-small uk-text-small"
>
<span
class="uk-margin-small-right uk-sortable-handle uk-text-center"
uk-icon="ratio: 0.8; icon: table"
></span
>Item 7
</div>
</li>
<li>
<div
class="uk-background-muted uk-flex uk-flex-middle uk-padding-small uk-text-small"
>
<span
class="uk-margin-small-right uk-sortable-handle uk-text-center"
uk-icon="ratio: 0.8; icon: table"
></span
>Item 8
</div>
</li>
</ul>To be able to sort items from one list to another, you can group them by adding the group: GROUP-NAME option to the uk-sortable attribute on each list.
<div uk-sortable="group: my-group">
<div></div>
</div>
<div uk-sortable="group: my-group">
<div></div>
</div>
<div class="uk-child-width-1-3@s" uk-grid>
<div>
<h4 class="uk-h4 uk-margin-bottom">Group 1</h4>
<div uk-sortable="group: sortable-group">
<div class="uk-margin">
<div class="uk-background-muted uk-padding-small uk-text-small">
Item 1
</div>
</div>
<div class="uk-margin">
<div class="uk-background-muted uk-padding-small uk-text-small">
Item 2
</div>
</div>
<div class="uk-margin">
<div class="uk-background-muted uk-padding-small uk-text-small">
Item 3
</div>
</div>
<div class="uk-margin">
<div class="uk-background-muted uk-padding-small uk-text-small">
Item 4
</div>
</div>
</div>
</div>
<div>
<h4 class="uk-h4 uk-margin-bottom">Group 2</h4>
<div uk-sortable="group: sortable-group">
<div class="uk-margin">
<div class="uk-background-muted uk-padding-small uk-text-small">
Item 1
</div>
</div>
<div class="uk-margin">
<div class="uk-background-muted uk-padding-small uk-text-small">
Item 2
</div>
</div>
<div class="uk-margin">
<div class="uk-background-muted uk-padding-small uk-text-small">
Item 3
</div>
</div>
<div class="uk-margin">
<div class="uk-background-muted uk-padding-small uk-text-small">
Item 4
</div>
</div>
</div>
</div>
<div>
<h4 class="uk-h4 uk-margin-bottom">Empty Group</h4>
<div uk-sortable="group: sortable-group"></div>
</div>
</div>You can also apply one or more custom classes to items when they are being dragged. To do so, add the cls-custom: MY-CLASS option to the attribute.
<ul uk-sortable="cls-custom: my-class">
...
</ul>
<ul class="uk-width-medium" uk-sortable="cls-custom: uk-background-muted">
<li
class="uk-background-placeholder uk-margin-small-top uk-padding-small uk-text-small"
>
<a href="#">Item 1</a>
</li>
<li
class="uk-background-placeholder uk-margin-small-top uk-padding-small uk-text-small"
>
<a href="#">Item 2</a>
</li>
<li
class="uk-background-placeholder uk-margin-small-top uk-padding-small uk-text-small"
>
<a href="#">Item 3</a>
</li>
<li
class="uk-background-placeholder uk-margin-small-top uk-padding-small uk-text-small"
>
<a href="#">Item 4</a>
</li>
</ul>Any of these options can be applied to the component attribute. Separate multiple options with a semicolon. Learn more
| Option | Value | Default | Description |
|---|---|---|---|
group | String | The group | |
animation | String, Boolean | slide | Animation mode (slide, false). |
duration | Number | 250 | Animation duration in milliseconds. |
threshold | Number | 5 | Mouse move threshold before dragging starts. |
cls-item | String | uk-sortable-item | The item class. |
cls-placeholder | String | uk-sortable-placeholder | The placeholder class. |
cls-drag | String | uk-sortable-drag | The ghost class. |
cls-drag-state | String | uk-drag | The body’s dragging class. |
cls-base | String | uk-sortable | The list’s class. |
cls-no-drag | String | uk-sortable-nodrag | Disable dragging on elements with this class. |
cls-empty | String | uk-sortable-empty | The empty list class. |
cls-custom | String | The ghost’s custom class. | |
handle | String | false | The handle selector. |
Learn more about JavaScript components.
UIkit.sortable(element, options);
The following events will be triggered on elements with this component attached:
| Name | Description |
|---|---|
start | Fires after dragging starts. |
stop | Fires after dragging stops. |
moved | Fires after an element has been moved. |
added | Fires after an element has been added. |
removed | Fires after an element has been removed. |
On your tailwind.config.js file, add the
Sortable component within the ui() plugin.
import ui from "franken-ui";
ui({
components: {
sortable: {
hooks: {}
}
}
}),
Note If you are developing theme from scratch, you can use all these hooks. If you’re using the shadcn/ui theme, some hooks might not work as they were already in use or removed. Learn more about using hooks.
| Hook Name | Affected Classes |
|---|---|
hook-sortable | .uk-sortable |
hook-drag | .uk-sortable-drag |
hook-placeholder | .uk-sortable-placeholder |
hook-empty | .uk-sortable-empty |
hook-misc | * |