Loading...
Loading...
Compare original and translation side by side
/Umbraco-CMS/src/Umbraco.Web.UI.Client/examples/sorter-with-nested-containers//Umbraco-CMS/src/Umbraco.Web.UI.Client/examples/sorter-with-two-containers//Umbraco-CMS/src/Umbraco.Web.UI.Client/examples/sorter-with-nested-containers//Umbraco-CMS/src/Umbraco.Web.UI.Client/examples/sorter-with-two-containers/umbraco-state-managementumbraco-umbraco-elementumbraco-state-managementumbraco-umbraco-elementimport { UmbSorterController } from '@umbraco-cms/backoffice/sorter';
import { html, customElement, property, repeat } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
interface MyItem {
id: string;
name: string;
}
@customElement('my-sortable-list')
export class MySortableListElement extends UmbLitElement {
#sorter = new UmbSorterController<MyItem, HTMLElement>(this, {
// Get unique identifier from DOM element
getUniqueOfElement: (element) => {
return element.getAttribute('data-id') ?? '';
},
// Get unique identifier from data model
getUniqueOfModel: (modelEntry) => {
return modelEntry.id;
},
// Identifier shared by all connected sorters (for cross-container dragging)
identifier: 'my-sortable-list',
// CSS selector for sortable items
itemSelector: '.sortable-item',
// CSS selector for the container
containerSelector: '.sortable-container',
// Called when order changes
onChange: ({ model }) => {
this._items = model;
this.requestUpdate();
this.dispatchEvent(new CustomEvent('change', { detail: { items: model } }));
},
});
@property({ type: Array, attribute: false })
public get items(): MyItem[] {
return this._items;
}
public set items(value: MyItem[]) {
this._items = value;
this.#sorter.setModel(value);
this.requestUpdate();
}
private _items: MyItem[] = [];
override render() {
return html`
<div class="sortable-container">
${repeat(
this._items,
(item) => item.id,
(item) => html`
<div class="sortable-item" data-id=${item.id}>
${item.name}
</div>
`
)}
</div>
`;
}
}import { UmbSorterController } from '@umbraco-cms/backoffice/sorter';
import { html, customElement, property, repeat } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
interface MyItem {
id: string;
name: string;
}
@customElement('my-sortable-list')
export class MySortableListElement extends UmbLitElement {
#sorter = new UmbSorterController<MyItem, HTMLElement>(this, {
// Get unique identifier from DOM element
getUniqueOfElement: (element) => {
return element.getAttribute('data-id') ?? '';
},
// Get unique identifier from data model
getUniqueOfModel: (modelEntry) => {
return modelEntry.id;
},
// Identifier shared by all connected sorters (for cross-container dragging)
identifier: 'my-sortable-list',
// CSS selector for sortable items
itemSelector: '.sortable-item',
// CSS selector for the container
containerSelector: '.sortable-container',
// Called when order changes
onChange: ({ model }) => {
this._items = model;
this.requestUpdate();
this.dispatchEvent(new CustomEvent('change', { detail: { items: model } }));
},
});
@property({ type: Array, attribute: false })
public get items(): MyItem[] {
return this._items;
}
public set items(value: MyItem[]) {
this._items = value;
this.#sorter.setModel(value);
this.requestUpdate();
}
private _items: MyItem[] = [];
override render() {
return html`
<div class="sortable-container">
${repeat(
this._items,
(item) => item.id,
(item) => html`
<div class="sortable-item" data-id=${item.id}>
${item.name}
</div>
`
)}
</div>
`;
}
}import { UmbSorterController } from '@umbraco-cms/backoffice/sorter';
import { html, customElement, property, repeat, css } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
export interface NestedItem {
name: string;
children?: NestedItem[];
}
@customElement('my-sorter-group')
export class MySorterGroupElement extends UmbLitElement {
#sorter = new UmbSorterController<NestedItem, MySorterItemElement>(this, {
getUniqueOfElement: (element) => element.name,
getUniqueOfModel: (modelEntry) => modelEntry.name,
// IMPORTANT: Same identifier allows items to move between all nested groups
identifier: 'my-nested-sorter',
itemSelector: 'my-sorter-item',
containerSelector: '.sorter-container',
onChange: ({ model }) => {
const oldValue = this._value;
this._value = model;
this.requestUpdate('value', oldValue);
this.dispatchEvent(new CustomEvent('change'));
},
});
@property({ type: Array, attribute: false })
public get value(): NestedItem[] {
return this._value ?? [];
}
public set value(value: NestedItem[]) {
this._value = value;
this.#sorter.setModel(value);
this.requestUpdate();
}
private _value?: NestedItem[];
override render() {
return html`
<div class="sorter-container">
${repeat(
this.value,
(item) => item.name,
(item) => html`
<my-sorter-item .name=${item.name}>
<!-- Recursive nesting -->
<my-sorter-group
.value=${item.children ?? []}
@change=${(e: Event) => {
item.children = (e.target as MySorterGroupElement).value;
}}
></my-sorter-group>
</my-sorter-item>
`
)}
</div>
`;
}
static override styles = css`
:host {
display: block;
min-height: 20px;
border: 1px dashed rgba(122, 122, 122, 0.25);
border-radius: var(--uui-border-radius);
padding: var(--uui-size-space-1);
}
`;
}import { UmbSorterController } from '@umbraco-cms/backoffice/sorter';
import { html, customElement, property, repeat, css } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
export interface NestedItem {
name: string;
children?: NestedItem[];
}
@customElement('my-sorter-group')
export class MySorterGroupElement extends UmbLitElement {
#sorter = new UmbSorterController<NestedItem, MySorterItemElement>(this, {
getUniqueOfElement: (element) => element.name,
getUniqueOfModel: (modelEntry) => modelEntry.name,
// IMPORTANT: Same identifier allows items to move between all nested groups
identifier: 'my-nested-sorter',
itemSelector: 'my-sorter-item',
containerSelector: '.sorter-container',
onChange: ({ model }) => {
const oldValue = this._value;
this._value = model;
this.requestUpdate('value', oldValue);
this.dispatchEvent(new CustomEvent('change'));
},
});
@property({ type: Array, attribute: false })
public get value(): NestedItem[] {
return this._value ?? [];
}
public set value(value: NestedItem[]) {
this._value = value;
this.#sorter.setModel(value);
this.requestUpdate();
}
private _value?: NestedItem[];
override render() {
return html`
<div class="sorter-container">
${repeat(
this.value,
(item) => item.name,
(item) => html`
<my-sorter-item .name=${item.name}>
<!-- Recursive nesting -->
<my-sorter-group
.value=${item.children ?? []}
@change=${(e: Event) => {
item.children = (e.target as MySorterGroupElement).value;
}}
></my-sorter-group>
</my-sorter-item>
`
)}
</div>
`;
}
static override styles = css`
:host {
display: block;
min-height: 20px;
border: 1px dashed rgba(122, 122, 122, 0.25);
border-radius: var(--uui-border-radius);
padding: var(--uui-size-space-1);
}
`;
}import { html, customElement, property, css } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
@customElement('my-sorter-item')
export class MySorterItemElement extends UmbLitElement {
@property({ type: String })
name = '';
override render() {
return html`
<div class="item-wrapper">
<div class="drag-handle">
<uui-icon name="icon-navigation"></uui-icon>
</div>
<div class="item-content">
<span>${this.name}</span>
<slot name="action"></slot>
</div>
<div class="children">
<slot></slot>
</div>
</div>
`;
}
static override styles = css`
:host {
display: block;
background: var(--uui-color-surface);
border: 1px solid var(--uui-color-border);
border-radius: var(--uui-border-radius);
margin: var(--uui-size-space-1) 0;
}
.item-wrapper {
padding: var(--uui-size-space-3);
}
.drag-handle {
cursor: grab;
display: inline-block;
margin-right: var(--uui-size-space-2);
}
.drag-handle:active {
cursor: grabbing;
}
.children {
margin-left: var(--uui-size-space-5);
margin-top: var(--uui-size-space-2);
}
`;
}
declare global {
interface HTMLElementTagNameMap {
'my-sorter-item': MySorterItemElement;
}
}import { html, customElement, property, css } from '@umbraco-cms/backoffice/external/lit';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
@customElement('my-sorter-item')
export class MySorterItemElement extends UmbLitElement {
@property({ type: String })
name = '';
override render() {
return html`
<div class="item-wrapper">
<div class="drag-handle">
<uui-icon name="icon-navigation"></uui-icon>
</div>
<div class="item-content">
<span>${this.name}</span>
<slot name="action"></slot>
</div>
<div class="children">
<slot></slot>
</div>
</div>
`;
}
static override styles = css`
:host {
display: block;
background: var(--uui-color-surface);
border: 1px solid var(--uui-color-border);
border-radius: var(--uui-border-radius);
margin: var(--uui-size-space-1) 0;
}
.item-wrapper {
padding: var(--uui-size-space-3);
}
.drag-handle {
cursor: grab;
display: inline-block;
margin-right: var(--uui-size-space-2);
}
.drag-handle:active {
cursor: grabbing;
}
.children {
margin-left: var(--uui-size-space-5);
margin-top: var(--uui-size-space-2);
}
`;
}
declare global {
interface HTMLElementTagNameMap {
'my-sorter-item': MySorterItemElement;
}
}@customElement('my-dual-sorter-dashboard')
export class MyDualSorterDashboard extends UmbLitElement {
listOneItems: MyItem[] = [
{ id: '1', name: 'Apple' },
{ id: '2', name: 'Banana' },
];
listTwoItems: MyItem[] = [
{ id: '3', name: 'Carrot' },
{ id: '4', name: 'Date' },
];
override render() {
return html`
<div class="container">
<my-sortable-list
.items=${this.listOneItems}
@change=${(e: CustomEvent) => {
this.listOneItems = e.detail.items;
}}
></my-sortable-list>
<my-sortable-list
.items=${this.listTwoItems}
@change=${(e: CustomEvent) => {
this.listTwoItems = e.detail.items;
}}
></my-sortable-list>
</div>
`;
}
}identifier@customElement('my-dual-sorter-dashboard')
export class MyDualSorterDashboard extends UmbLitElement {
listOneItems: MyItem[] = [
{ id: '1', name: 'Apple' },
{ id: '2', name: 'Banana' },
];
listTwoItems: MyItem[] = [
{ id: '3', name: 'Carrot' },
{ id: '4', name: 'Date' },
];
override render() {
return html`
<div class="container">
<my-sortable-list
.items=${this.listOneItems}
@change=${(e: CustomEvent) => {
this.listOneItems = e.detail.items;
}}
></my-sortable-list>
<my-sortable-list
.items=${this.listTwoItems}
@change=${(e: CustomEvent) => {
this.listTwoItems = e.detail.items;
}}
></my-sortable-list>
</div>
`;
}
}identifier| Option | Type | Description |
|---|---|---|
| | Shared ID for connected sorters (enables cross-container dragging) |
| | CSS selector for sortable items |
| | CSS selector for the container |
| | Extract unique ID from DOM element |
| | Extract unique ID from data model |
| | Called when order changes |
| | Called when dragging starts |
| | Called when dragging ends |
| 选项 | 类型 | 描述 |
|---|---|---|
| | 关联排序器的共享ID(支持跨容器拖拽) |
| | 可排序项的CSS选择器 |
| | 容器的CSS选择器 |
| | 从DOM元素中提取唯一ID |
| | 从数据模型中提取唯一ID |
| | 排序变化时触发的回调 |
| | 拖拽开始时触发的回调 |
| | 拖拽结束时触发的回调 |
// Set the model (call when items change externally)
this.#sorter.setModel(items);
// Get current model
const currentItems = this.#sorter.getModel();
// Disable sorting temporarily
this.#sorter.disable();
// Re-enable sorting
this.#sorter.enable();// Set the model (call when items change externally)
this.#sorter.setModel(items);
// Get current model
const currentItems = this.#sorter.getModel();
// Disable sorting temporarily
this.#sorter.disable();
// Re-enable sorting
this.#sorter.enable();| Class | Applied To | When |
|---|---|---|
| Container | While any item is being dragged |
| Placeholder element | Indicates drop position |
| 类名 | 应用对象 | 触发时机 |
|---|---|---|
| 容器 | 当有项被拖拽时 |
| 占位元素 | 指示放置位置时 |
itemSelectorcontainerSelectoridentifierrepeat()itemSelectorcontainerSelectoridentifierrepeat()