Skip to content

AR-1204: drag and drop for attribute fields #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NicoPaladiniAries merged 1 commit into from
Jun 3, 2025
Merged

AR-1204: drag and drop for attribute fields #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@
"@commercetools-uikit/text-input": "^18.4.0",
"@commercetools-uikit/time-input": "^18.4.0",
"@commercetools/sync-actions": "^5.15.0",
"@dnd-kit/core": "^6.3.1",
"@dnd-kit/modifiers": "^9.0.0",
"@dnd-kit/sortable": "^10.0.0",
"@formatjs/cli": "^6.2.7",
"@jest/types": "27.5.1",
"@manypkg/cli": "^0.21.3",
Expand Down
169 changes: 111 additions & 58 deletions src/components/custom-object-form/attribute-field.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,27 @@ import Card from '@commercetools-uikit/card';
import Constraints from '@commercetools-uikit/constraints';
import { BinLinearIcon, PlusBoldIcon } from '@commercetools-uikit/icons';
import Spacings from '@commercetools-uikit/spacings';
import {
closestCenter,
DndContext,
DragEndEvent,
KeyboardSensor,
PointerSensor,
useSensor,
useSensors,
} from '@dnd-kit/core';
import {
arrayMove,
SortableContext,
sortableKeyboardCoordinates,
verticalListSortingStrategy,
} from '@dnd-kit/sortable';
import { TYPES } from '../../constants';
import { getValueByType } from '../../helpers';
import AttributeLabel from './attribute-label';
import AttributeInput from './attribute-input';
import messages from './messages';
import { SortableItem } from './sortable-item';
import styles from './attribute-field.module.css';

type Props = {
Expand Down Expand Up @@ -67,73 +83,110 @@ const AttributeField: FC<Props> = ({
const selectOptions =
type === TYPES.LocalizedEnum
? options?.map((option) => {
return {
value: option.value,
label: option.label[dataLocale],
};
})
return {
value: option.value,
label: option.label[dataLocale],
};
})
: options;

const sensors = useSensors(
useSensor(PointerSensor),
useSensor(KeyboardSensor, {
coordinateGetter: sortableKeyboardCoordinates,
})
);

return (
<>
{isSet ? (
<FieldArray
name={name}
render={({ push, remove }) => (
<Spacings.Stack scale="s">
<AttributeLabel
data-testid="set-attribute-label"
type={type}
title={title}
isRequired={isRequired}
reference={reference}
/>
<Constraints.Horizontal max="scale">
<SecondaryButton
data-testid="add-attribute"
iconLeft={<PlusBoldIcon />}
label={intl.formatMessage(messages.addLabel)}
onClick={() => push(emptyValue)}
render={({ push, remove, form }) => {
const handleDragEnd = (event: DragEndEvent) => {
const { active, over } = event;
if (active.id !== over?.id) {
const oldIndex = active.data.current?.sortable.index;
const newIndex = over?.data.current?.sortable.index;

if (
typeof oldIndex === 'number' &&
typeof newIndex === 'number'
) {
const updated = arrayMove(value, oldIndex, newIndex);
form.setFieldValue(name, updated);
}
}
};

return (
<Spacings.Stack scale="s">
<AttributeLabel
data-testid="set-attribute-label"
type={type}
title={title}
isRequired={isRequired}
reference={reference}
/>
</Constraints.Horizontal>
{value.map((val: any, index: number) => (
<Card
key={index}
theme={isNestedSet ? 'light' : 'dark'}
type="flat"
<Constraints.Horizontal max="scale">
<SecondaryButton
data-testid="add-attribute"
iconLeft={<PlusBoldIcon />}
label={intl.formatMessage(messages.addLabel)}
onClick={() => push(emptyValue)}
/>
</Constraints.Horizontal>
<DndContext
sensors={sensors}
collisionDetection={closestCenter}
onDragEnd={handleDragEnd}
>
<Spacings.Inline alignItems="center">
<div className={styles.fullWidth}>
<AttributeInput
data-testid={`set-attribute-input-${index}`}
type={type}
title={title}
name={`${name}.${index}`}
value={val}
touched={get(touched, index)}
errors={get(errors, index)}
onChange={onChange}
onBlur={onBlur}
isRequired={isRequired}
isSet={isSet}
isNestedSet={isNestedSet}
attributes={attributes}
reference={reference}
options={selectOptions}
/>
</div>
<SecondaryIconButton
data-testid={`remove-attribute-${index}`}
icon={<BinLinearIcon />}
label={intl.formatMessage(messages.removeLabel)}
isDisabled={index === 0 && value.length === 1}
onClick={() => remove(index)}
/>
</Spacings.Inline>
</Card>
))}
</Spacings.Stack>
)}
<SortableContext
items={value.map((_: any, i: number) => `${i}`)}
strategy={verticalListSortingStrategy}
>
{value.map((val: any, index: number) => (
<SortableItem key={index} id={`${index}`}>
<Card
theme={isNestedSet ? 'light' : 'dark'}
type="flat"
>
<Spacings.Inline alignItems="center">
<div className={styles.fullWidth}>
<AttributeInput
data-testid={`set-attribute-input-${index}`}
type={type}
title={title}
name={`${name}.${index}`}
value={val}
touched={get(touched, index)}
errors={get(errors, index)}
onChange={onChange}
onBlur={onBlur}
isRequired={isRequired}
isSet={isSet}
isNestedSet={isNestedSet}
attributes={attributes}
reference={reference}
options={selectOptions}
/>
</div>
<SecondaryIconButton
data-testid={`remove-attribute-${index}`}
icon={<BinLinearIcon />}
label={intl.formatMessage(messages.removeLabel)}
isDisabled={index === 0 && value.length === 1}
onClick={() => remove(index)}
/>
</Spacings.Inline>
</Card>
</SortableItem>
))}
</SortableContext>
</DndContext>
</Spacings.Stack>
);
}}
/>
) : (
<Spacings.Stack scale="xs">
Expand Down
30 changes: 30 additions & 0 deletions src/components/custom-object-form/sortable-item.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { useSortable } from '@dnd-kit/sortable';
import { CSS } from '@dnd-kit/utilities';
import { ViewGridPlusIcon } from '@commercetools-uikit/icons';

type SortableItemProps = {
id: string;
children: React.ReactNode;
};

export const SortableItem = ({ id, children }: SortableItemProps) => {
const { attributes, listeners, setNodeRef, transform } =
useSortable({ id });

const style = {
transform: CSS.Transform.toString(transform),
transition: 'transform 200ms ease',
width: '100%',
};

return (
<div ref={setNodeRef} style={style} {...attributes}>
<div style={{ display: 'flex', alignItems: 'center' }}>
<span {...listeners} style={{ cursor: 'grab', marginRight: '8px' }}>
<ViewGridPlusIcon />
</span>
<div style={{ flex: 1 }}>{children}</div>
</div>
</div>
);
};
39 changes: 39 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3070,6 +3070,45 @@
resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70"
integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==

"@dnd-kit/accessibility@^3.1.1":
version "3.1.1"
resolved "https://registry.yarnpkg.com/@dnd-kit/accessibility/-/accessibility-3.1.1.tgz#3b4202bd6bb370a0730f6734867785919beac6af"
integrity sha512-2P+YgaXF+gRsIihwwY1gCsQSYnu9Zyj2py8kY5fFvUM1qm2WA2u639R6YNVfU4GWr+ZM5mqEsfHZZLoRONbemw==
dependencies:
tslib "^2.0.0"

"@dnd-kit/core@^6.3.1":
version "6.3.1"
resolved "https://registry.yarnpkg.com/@dnd-kit/core/-/core-6.3.1.tgz#4c36406a62c7baac499726f899935f93f0e6d003"
integrity sha512-xkGBRQQab4RLwgXxoqETICr6S5JlogafbhNsidmrkVv2YRs5MLwpjoF2qpiGjQt8S9AoxtIV603s0GIUpY5eYQ==
dependencies:
"@dnd-kit/accessibility" "^3.1.1"
"@dnd-kit/utilities" "^3.2.2"
tslib "^2.0.0"

"@dnd-kit/modifiers@^9.0.0":
version "9.0.0"
resolved "https://registry.yarnpkg.com/@dnd-kit/modifiers/-/modifiers-9.0.0.tgz#96a0280c77b10c716ef79d9792ce7ad04370771d"
integrity sha512-ybiLc66qRGuZoC20wdSSG6pDXFikui/dCNGthxv4Ndy8ylErY0N3KVxY2bgo7AWwIbxDmXDg3ylAFmnrjcbVvw==
dependencies:
"@dnd-kit/utilities" "^3.2.2"
tslib "^2.0.0"

"@dnd-kit/sortable@^10.0.0":
version "10.0.0"
resolved "https://registry.yarnpkg.com/@dnd-kit/sortable/-/sortable-10.0.0.tgz#1f9382b90d835cd5c65d92824fa9dafb78c4c3e8"
integrity sha512-+xqhmIIzvAYMGfBYYnbKuNicfSsk4RksY2XdmJhT+HAC01nix6fHCztU68jooFiMUB01Ky3F0FyOvhG/BZrWkg==
dependencies:
"@dnd-kit/utilities" "^3.2.2"
tslib "^2.0.0"

"@dnd-kit/utilities@^3.2.2":
version "3.2.2"
resolved "https://registry.yarnpkg.com/@dnd-kit/utilities/-/utilities-3.2.2.tgz#5a32b6af356dc5f74d61b37d6f7129a4040ced7b"
integrity sha512-+MKAJEOfaBe5SmV6t34p80MMKhjvUz0vRrvVJbPT0WElzaOJ/1xs+D+KDv+tD/NE5ujfrChEcshd4fLn0wpiqg==
dependencies:
tslib "^2.0.0"

"@emotion/babel-plugin-jsx-pragmatic@^0.3.0":
version "0.3.0"
resolved "https://registry.yarnpkg.com/@emotion/babel-plugin-jsx-pragmatic/-/babel-plugin-jsx-pragmatic-0.3.0.tgz#12bde56c351f5981e5de66c99e62c371df6c42ca"
Expand Down
Loading