Skip to content

chore(DragAndDrop): convert examples to TS #7244

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
tlabaj merged 4 commits into from
May 3, 2022
Merged

chore(DragAndDrop): convert examples to TS #7244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a67478
convert DnD to TS
jenny-s51 Apr 13, 2022
3287021
make param required
jenny-s51 Apr 18, 2022
596def3
PR feedback from Titani
jenny-s51 Apr 27, 2022
857dae4
remove extra space
jenny-s51 Apr 27, 2022
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
176 changes: 22 additions & 154 deletions packages/react-core/src/components/DragDrop/examples/DragDrop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,175 +1,43 @@
---
id: Drag and drop
section: components
propComponents: [
DragDrop,
Draggable,
Droppable,
DraggableItemPosition
]
propComponents: [DragDrop, Draggable, Droppable, DraggableItemPosition]
beta: true
---

You can use `DragDrop` to move items in or between lists. `DragDrop`s should contain `Droppable`s which contain `Draggable`s.
You can use the `DragDrop` component to move items in or between lists. The `DragDrop` component should contain `Droppable` components which contain `Draggable` components.

```js noLive
```ts noLive
import React from 'react';
import { DragDrop, Draggable, Droppable } from '@patternfly/react-core';

<DragDrop> {/* DragDrop houses the context for dragging and dropping */}
<Droppable>
<Draggable>
You can put anything here! It will be wrapped in a styled div.
</Draggable>
<Draggable>
You can have as many Draggables as you like.
</Draggable>
</Droppable>
<Droppable> {/* You can also have many droppables! */}
<Draggable />
</Droppable>
</DragDrop>
const DragDropCodeSample: React.FunctionComponent = () => (
<DragDrop>
{' '}
{/* DragDrop houses the context for dragging and dropping */}
<Droppable>
<Draggable>You can put anything here! It will be wrapped in a styled div.</Draggable>
<Draggable>You can have as many Draggables as you like.</Draggable>
</Droppable>
<Droppable>
{' '}
{/* You can also have many droppables! */}
<Draggable />
</Droppable>
</DragDrop>
);
```

Note: Keyboard accessibility and screen reader accessibility are still in development.

## Examples
### Basic

```js
import React from 'react';
import { DragDrop, Draggable, Droppable } from '@patternfly/react-core';

const getItems = count =>
Array.from({ length: count }, (v, k) => k).map(k => ({
id: `item-${k}`,
content: `item ${k} `.repeat(k === 4 ? 20 : 1)
}));

const reorder = (list, startIndex, endIndex) => {
const result = Array.from(list);
const [removed] = result.splice(startIndex, 1);
result.splice(endIndex, 0, removed);
return result;
};

Basic = () => {
const [items, setItems] = React.useState(getItems(10));

function onDrop(source, dest) {
if (dest) {
const newItems = reorder(
items,
source.index,
dest.index
);
setItems(newItems);

return true;
}
return false;
}
### Basic

return (
<DragDrop onDrop={onDrop}>
<Droppable>
{items.map(({ id, content }, i) =>
<Draggable key={i} style={{ padding: '8px' }}>
{content}
</Draggable>
)}
</Droppable>
</DragDrop>
);
}
```ts file="./DragDropBasic.tsx"
```

### Multiple lists

```js
import React from 'react';
import { DragDrop, Draggable, Droppable, Split, SplitItem } from '@patternfly/react-core';

const getItems = (count, start) =>
Array.from({ length: count }, (v, k) => k).map(k => ({
id: `item-${k + start}`,
content: `item ${k + start} `.repeat(k === 4 ? 20 : 1)
}));

const reorder = (list, startIndex, endIndex) => {
const result = Array.from(list);
const [removed] = result.splice(startIndex, 1);
result.splice(endIndex, 0, removed);
return result;
};

const move = (source, destination, sourceIndex, destIndex) => {
const sourceClone = Array.from(source);
const destClone = Array.from(destination);
const [removed] = sourceClone.splice(sourceIndex, 1);
destClone.splice(destIndex, 0, removed);
return [sourceClone, destClone];
};

MultiList = () => {
const [items, setItems] = React.useState({
items1: getItems(10, 0),
items2: getItems(5, 10)
});

function onDrop(source, dest) {
console.log(source, dest);
if (dest) {
if (source.droppableId === dest.droppableId) {
const newItems = reorder(
source.droppableId === 'items1' ? items.items1 : items.items2,
source.index,
dest.index
);
if (source.droppableId === 'items1') {
setItems({
items1: newItems,
items2: items.items2
});
} else {
setItems({
items1: items.items1,
items2: newItems
});
}
} else {
const [newItems1, newItems2] = move(
source.droppableId === 'items1' ? items.items1 : items.items2,
dest.droppableId === 'items1' ? items.items1 : items.items2,
source.index,
dest.index
);
setItems({
items1: source.droppableId === 'items1' ? newItems1 : newItems2,
items2: dest.droppableId === 'items1' ? newItems1 : newItems2
});
}
return true;
}
return false;
}

return (
<DragDrop onDrop={onDrop}>
<Split hasGutter>
{Object.entries(items).map(([key, subitems]) =>
<SplitItem key={key} style={{ flex: 1 }}>
<Droppable zone="multizone" droppableId={key}>
{subitems.map(({ id, content }, i) =>
<Draggable key={id} style={{ padding: '8px' }}>
{content}
</Draggable>
)}
</Droppable>
</SplitItem>
)}
</Split>
</DragDrop>
);
}
```ts file="./DragDropMultipleLists.tsx"
```

53 changes: 53 additions & 0 deletions packages/react-core/src/components/DragDrop/examples/DragDropBasic.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import React from 'react';
import { DragDrop, Draggable, Droppable } from '@patternfly/react-core';

interface ItemType {
id: string;
content: string;
}

interface SourceType {
droppableId: string;
index: number;
}

interface DestinationType extends SourceType {}

const getItems = (count: number) =>
Array.from({ length: count }, (_, idx) => idx).map(idx => ({
id: `item-${idx}`,
content: `item ${idx} `.repeat(idx === 4 ? 20 : 1)
}));

const reorder = (list: ItemType[], startIndex: number, endIndex: number) => {
const result = list;
const [removed] = result.splice(startIndex, 1);
result.splice(endIndex, 0, removed);
return result;
};

export const DragDropBasic: React.FunctionComponent = () => {
const [items, setItems] = React.useState(getItems(10));

function onDrop(source: SourceType, dest: DestinationType) {
if (dest) {
const newItems = reorder(items, source.index, dest.index);
setItems(newItems);

return true;
}
return false;
}

return (
<DragDrop onDrop={onDrop}>
<Droppable>
{items.map(({ content }, i) => (
<Draggable key={i} style={{ padding: '8px' }}>
{content}
</Draggable>
))}
</Droppable>
</DragDrop>
);
};
98 changes: 98 additions & 0 deletions packages/react-core/src/components/DragDrop/examples/DragDropMultipleLists.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
import React from 'react';
import { DragDrop, Draggable, Droppable, Split, SplitItem } from '@patternfly/react-core';

interface ItemType {
id: string;
content: string;
}

interface SourceType {
droppableId: string;
index: number;
}

interface DestinationType extends SourceType {}

const getItems = (count: number, startIndex: number) =>
Array.from({ length: count }, (_, idx) => idx + startIndex).map(idx => ({
id: `item-${idx}`,
content: `item ${idx} `.repeat(idx === 4 ? 20 : 1)
}));

const reorder = (list: ItemType[], startIndex: number, endIndex: number) => {
const result = list;
const [removed] = result.splice(startIndex, 1);
result.splice(endIndex, 0, removed);
return result;
};

const move = (source: ItemType[], destination: ItemType[], sourceIndex: number, destIndex: number) => {
const sourceClone = source;
const destClone = destination;
const [removed] = sourceClone.splice(sourceIndex, 1);
destClone.splice(destIndex, 0, removed);
return [sourceClone, destClone];
};

export const DragDropMultipleLists: React.FunctionComponent = () => {
const [items, setItems] = React.useState({
items1: getItems(10, 0),
items2: getItems(5, 10)
});

function onDrop(source: SourceType, dest: DestinationType) {
// eslint-disable-next-line no-console
console.log(source, dest);
if (dest) {
if (source.droppableId === dest.droppableId) {
const newItems = reorder(
source.droppableId === 'items1' ? items.items1 : items.items2,
source.index,
dest.index
);
if (source.droppableId === 'items1') {
setItems({
items1: newItems,
items2: items.items2
});
} else {
setItems({
items1: items.items1,
items2: newItems
});
}
} else {
const [newItems1, newItems2] = move(
source.droppableId === 'items1' ? items.items1 : items.items2,
dest.droppableId === 'items1' ? items.items1 : items.items2,
source.index,
dest.index
);
setItems({
items1: source.droppableId === 'items1' ? newItems1 : newItems2,
items2: dest.droppableId === 'items1' ? newItems1 : newItems2
});
}
return true;
}
return false;
}

return (
<DragDrop onDrop={onDrop}>
<Split hasGutter>
{Object.entries(items).map(([key, subitems]) => (
<SplitItem key={key} style={{ flex: 1 }}>
<Droppable zone="multizone" droppableId={key}>
{subitems.map(({ id, content }) => (
<Draggable key={id} style={{ padding: '8px' }}>
{content}
</Draggable>
))}
</Droppable>
</SplitItem>
))}
</Split>
</DragDrop>
);
};