Документация/Обзор
Конструктор страниц
Лендинг, собранный перетаскиванием — секции из палитры, которые над страницей превращаются в настоящие, элементы, перемещаемые между колонками, дерево слоёв на тех же данных, редактирование на месте, ширины устройств и отмена.
Страница переведена ИИ и может содержать неточности. Читать английский оригинал
Загружаем демо…
<script setup lang="ts">
import { provide } from 'vue';
import { DnDProvider, type Active, type AnnouncedPosition, type Announcements } from '@vue-dnd-kit/core';
import Builder from './Builder.vue';
import { BUILDER, LAYERS, PAGE, createBuilder } from './builder';
import { BLOCKS, SECTIONS, excerpt, isColumn, isSection, type ChipData, type LayerNode } from './page';
// Provided above the provider: the overlays it renders copy the page's look from it.
const builder = createBuilder();
provide(BUILDER, builder);
/** What a drag carries, in words: "the Hero section", "a new Pricing section", "the heading “…”". */
const what = (active: Active) => {
const node = active.items[0]?.item as LayerNode | undefined;
// A chip of the palette: a plain draggable, with no list item.
if (!node) return `a new ${BLOCKS[(active.data as ChipData).kind].name.toLowerCase()}`;
if (isSection(node)) return `${builder.find(node.id) ? 'the' : 'a new'} ${SECTIONS[node.kind].name} section`;
if (isColumn(node)) return 'the column';
return `the ${BLOCKS[node.kind].name.toLowerCase()} “${excerpt(node)}”`;
};
/** Where a position of a list is, in words. */
const where = ({ list, index, length }: AnnouncedPosition) => {
const place = `${index + 1} of ${length}`;
if (list === PAGE) return `position ${place} on the page`;
if (list === LAYERS) return `row ${place} of the layers`;
const at = builder.find(String(list));
if (!at?.column) return `position ${place}`;
return `position ${place} in column ${at.section.columns.indexOf(at.column) + 1} of ${SECTIONS[at.section.kind].name}`;
};
const announcements: Partial<Announcements> = {
onDragStart: ({ active }) => `Picked up ${what(active)}.`,
onDragOver: ({ active }, { position }) => (position ? `${what(active)}, ${where(position)}` : undefined),
onDragEnd: ({ active, dropped }, { position }) => (dropped && position ? `Dropped ${what(active)} at ${where(position)}.` : undefined),
onDragCancel: ({ active }) => `Cancelled. Nothing changed for ${what(active)}.`,
};
// Space picks up and drops. Enter is left to the editor: it edits a text, adds a template.
const keyboard = { keys: { start: ['Space'], drop: ['Space', 'Enter'], cancel: ['Escape'] } };
const instructions =
'Space picks up; the arrow keys move; Space drops; Escape cancels. Enter edits the focused text, or adds the focused template.';
</script>
<template>
<DnDProvider :announcements="announcements" :keyboard="keyboard" :screen-reader-instructions="instructions">
<Builder />
</DnDProvider>
</template>Разверните рамку примера на весь экран: палитра встанет слева, слои справа, а страница займёт место между ними. Когда экран уже, они делят выдвижную панель, которая открывается из верхней панели.
На что обратить внимание
Canvas.vue: страница — сортируемый список секций сplaceholder: 'indicator'. Она стоит на месте, пока секция в пути, а линия между двумя секциями говорит, куда та встанет: сдвигать 500-пиксельные секции на каждом слоте значило бы трясти всю страницу.dropzoneотдаёт бросок всему холсту, так что секция, отпущенная сбоку или ниже страницы, всё равно приземляется.ColumnList.vue: каждая колонка каждой секции — список группыblocks. Элементы перемещаются между колонками и секциями и сортируются вживую: страница показывает результат, пока вы тащите. Каждая колонка — отдельный компонент, а колонки — списки внутри элементов другого списка.Palette.vue: шаблоны секций — список группы страницы сpull: 'clone',put: falseиsort: false: он раздаёт копии и ничего не берёт обратно. Элементы под ними (ElementChip.vue) — обычные перетаскиваемые элементы, и колонка делает из них блок черезcreateItem.Layers.vue: та же страница в виде сортируемого дерева, на тех же данных. Строка, перемещённая там, перемещается и на странице, и наоборот.builder.ts: страница, выделение, устройство и история. Броски записывают страницу через списки; кнопки панели инструментов и сочетания клавиш меняют её здесь. Каждое изменение — шаг отмены.
Секция в руке — настоящая секция
SectionGhost.vue — оверлей и секций страницы, и шаблонов палитры. Над страницей (to.list
— список страницы) он рендерит саму секцию, шириной со страницу, уменьшенную под указателем.
Когда бросок решён (status: 'dropping'), он возвращает масштаб к 1, пока блок летит на место
секции: и приземляется ровно на неё. Бросок ждёт этого перехода, так что в конце ничего не
прыгает.
<script setup lang="ts">
const props = defineProps<{ items: DragItem[]; status: DnDStatus; to: DropDestination | null }>();
const section = computed(() => props.items[0]!.item as Section);
const fromPalette = computed(() => !find(section.value.id));
const onPage = computed(() => props.to?.list === PAGE);
const look = computed(() => {
if (fromPalette.value && !onPage.value) return 'card'; // still the palette's card
return props.status === 'dropping' ? 'landing' : 'ghost';
});
</script>
<template>
<DragPreview v-if="look === 'card'" :id="items[0]!.id" :style="{ width: '100%', height: '100%' }" />
<div v-else class="replica" :class="look" :style="{ width: `${pageWidth}px`, '--shrink': shrink }">
<SectionView :section="section" />
</div>
</template>
<style scoped>
.replica { transform-origin: 0 0; scale: var(--shrink); transition: scale 0.25s ease; }
.replica.landing { scale: 1; }
</style>
Вдали от страницы шаблон остаётся тем, чем был в палитре: DragPreview показывает копию его
карточки, сделанную библиотекой. Место секции на странице — это слот: пока вы тащите, он ждёт
там, приглушённый; после броска её новое место остаётся пустым, пока на него не приземлится
оверлей.
.page-section[data-dnd-placeholder] { opacity: 0; }
html[data-dnd-dragging] .page-section[data-dnd-placeholder] { opacity: 0.35; }
Каждая секция рисует линию по своему indicator и говорит, что делает бросок: Move Features
here или Add Pricing here для шаблона.
Элементы: в цветах секции, куда они идут
Блоки тащат за всё тело; секцию — за ручку её метки, так как её тело — содержимое, которое
кликают и тащат. BlockGhost.vue, оверлей блоков и чипов, читает из to колонку, в которую
он попадёт, и берёт цвета её секции: кнопка над тёмным футером светлеет ещё до того, как вы
отпустите. Блок оверлея получает размер слота блока там (overlayFit: 'slot', по умолчанию), и
блок раскладывается в нём так, как будет после броска.
// The column it would go into (`to.list` is the column's id): its section's tone.
const look = computed(() => {
const at = props.to && find(String(props.to.list));
return at ? { ...TONES[SECTIONS[at.section.kind].tone], ...typeScale(pageWidth.value) } : null;
});
Чип палитры — обычный перетаскиваемый элемент, который несёт свой тип. Каждая колонка делает из него блок, и новый блок стоит в колонке, отрендеренный собственным шаблоном колонки, пока вы не отпустите или не двинетесь дальше:
makeSortableList(list, {
id: props.column.id,
items: blocks,
group: 'blocks',
overlay: BlockGhost,
createItem: (active) => {
const kind = (active.data as ChipData | undefined)?.kind;
return kind ? createBlock(BLOCKS[kind].spec) : undefined;
},
});
blocks — записываемый computed поверх props.column.blocks, а не toRef: отмена кладёт на
страницу новые объекты, и колонка должна следовать за ними.
Шаблоны: копии наружу, внутрь ничего
makeSortableList(list, {
id: 'templates',
items: templates,
group: { name: 'sections', pull: 'clone', put: false },
sort: false,
clone: (template) => createSection(template.kind), // new ids all the way down
overlay: SectionGhost,
});
Шаблоны — настоящие секции, так что их карточки показывают их (уменьшенными), а оверлей может их отрендерить. Клик по карточке или Enter добавляет секцию после выделенной: страницу можно собрать вообще без перетаскивания.
Слои: та же страница деревом
makeSortableTree(tree, {
id: LAYERS,
items: sections as Ref<LayerNode[]>,
// Keys of their own: the canvas's lists already drag these ids.
getKey: (node) => `layer-${node.id}`,
getChildren: (node) => (isSection(node) ? node.columns : isColumn(node) ? node.blocks : undefined),
setChildren: (node, children) => { … },
// Blocks go into columns, nothing into blocks, sections stay at the top.
canNest: (node, parent) => levelOf(node) === levelOf(parent) + 1,
maxDepth: 2,
placeholder: 'indicator',
// A tree takes any row at its top level: a block let go there flies back.
onBeforeDrop: (event) => (event.to.parentKey !== null || event.items.every(isSection) ? 'accept' : 'reject'),
});
Ключи общие для всего провайдера, поэтому у строк собственные ключи. Колонки — тоже строки,
disabled: они принимают блоки и остаются на месте. Там, куда блоку нельзя, между двумя
секциями, его линия краснеет. Наведение на строку обводит её узел на странице; выделение узла на
странице открывает здесь его секцию и прокручивает его строку в видимую область.
Редактирование на месте и клавиатура
Блок тащится из любого места, поэтому его тексты не редактируются, пока вы не кликнете по нему
дважды: тогда они становятся contenteditable, а canDrag отклоняет драги, так что нажатие
ставит курсор. EditableText.vue пишет DOM из модели, только пока текст не редактируется,
так что курсор никогда не прыгает, а отмена всё равно видна.
Провайдер оставляет Space для драгов, а Enter — редактору:
<DnDProvider
:keyboard="{ keys: { start: ['Space'], drop: ['Space', 'Enter'], cancel: ['Escape'] } }"
:announcements="announcements"
:screen-reader-instructions="instructions"
>
Перейдите табом к блоку: Space берёт его, а стрелки двигают его по колонке и в следующие; Enter редактирует его. Секция двигается за свою ручку так же или стрелками своей панели инструментов. Ctrl Z отменяет, Delete удаляет, Ctrl D дублирует. Скринридеры слышат «the Hero section, position 3 of 7 on the page», а не id.
Отмена и изменения без драга
Каждый бросок — один шаг истории: монитор сохраняет страницу, как только списки её записали.
useDnDMonitor({ onDragEnd: () => builder.commit() });
Отмена возвращает снимок. У списков включён animateChanges, так что то, что сдвинул снимок,
скользит туда, как и секции, которые панель инструментов двигает вверх и вниз; добавленные
секции проявляются, а удалённые растворяются.
Подробнее: сортируемые списки · списки с общими элементами · деревья · оверлей · анимации · доступность