Skip to content

feat(batch-selection): align with Fusion DS #8152

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

Draft
nuria1110 wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

feat(batch-selection): align with Fusion DS #8152

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
202 changes: 101 additions & 101 deletions skills/carbon-react/components/batch-selection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,138 +13,138 @@ description: Carbon BatchSelection component props and usage examples.
- Props interface: `BatchSelectionProps`

## Props
| Name | Type | Required | Literals | Description | Default |
| --- | --- | --- | --- | --- | --- |
| children | React.ReactNode | Yes | | Content to be rendered after selected count | |
| selectedCount | number | Yes | | Number of selected elements | |
| colorTheme | "white" \| "dark" \| "light" \| "transparent" \| undefined | No | | Color of the background, transparent if not defined | "transparent" |
| disabled | boolean \| undefined | No | | If true disables all user interaction | false |
| hidden | boolean \| undefined | No | | Hidden if true | |
| data-element | string \| undefined | No | | Identifier used for testing purposes, applied to the root element of the component. | |
| data-role | string \| undefined | No | | Identifier used for testing purposes, applied to the root element of the component. | |
| Name | Type | Required | Literals | Deprecated | Deprecation reason | Description | Default |
| --- | --- | --- | --- | --- | --- | --- | --- |
| children | React.ReactNode | Yes | | | | Content to be rendered after selected count. | |
| selectedCount | number | Yes | | | | Number of selected items | |
| hidden | boolean \| undefined | No | | | | If true, the component is hidden. | |
| onDismiss | (() => void) \| undefined | No | | | | Callback called when the close button is clicked. Renders the close button when provided. | |
| smallScreen | boolean \| undefined | No | | | | Flag to adjust layout for small screens | |
| totalItems | number \| undefined | No | | | | Total number of items | 0 |
| data-element | string \| undefined | No | | | | Identifier used for testing purposes, applied to the root element of the component. | |
| data-role | string \| undefined | No | | | | Identifier used for testing purposes, applied to the root element of the component. | |
| colorTheme | "white" \| "dark" \| "light" \| "transparent" \| undefined | No | | Yes | Changing the color theme of this component is no longer supported. | | |
| disabled | boolean \| undefined | No | | Yes | Disabling this component is no longer supported. | | |

## Examples
### Default

**Render**
**Args**

```tsx
() => {
return (
<BatchSelection selectedCount={0}>
<Button size="small" mx={1} buttonType="secondary">
Select All 38 items
</Button>
<IconButton onClick={() => {}}>
<Icon type="csv" />
</IconButton>
<IconButton onClick={() => {}}>
<Icon type="bin" />
</IconButton>
<IconButton onClick={() => {}}>
<Icon type="pdf" />
</IconButton>
</BatchSelection>
);
}
{
selectedCount: 1,
totalItems: 10,
onDismiss: () => {},
}
```


### Dark

**Render**

```tsx
() => {
return (
<BatchSelection selectedCount={1} colorTheme="dark">
<IconButton onClick={() => {}}>
<Icon type="csv" />
</IconButton>
<IconButton onClick={() => {}}>
<Icon type="bin" />
</IconButton>
<IconButton onClick={() => {}}>
<Icon type="pdf" />
</IconButton>
(args) => (
<BatchSelection {...args}>
<Button variantType="tertiary">Button 1</Button>
<Button variantType="tertiary">Button 2</Button>
<Button variantType="tertiary">Button 3</Button>
</BatchSelection>
);
}
)
```


### Light
### SmallScreen

**Render**
**Args**

```tsx
() => {
return (
<BatchSelection selectedCount={2} colorTheme="light">
<IconButton onClick={() => {}}>
<Icon type="csv" />
</IconButton>
<IconButton onClick={() => {}}>
<Icon type="bin" />
</IconButton>
<IconButton onClick={() => {}}>
<Icon type="pdf" />
</IconButton>
</BatchSelection>
);
}
{
smallScreen: true,
selectedCount: 1,
totalItems: 10,
onDismiss: () => {},
}
```


### White

**Render**

```tsx
() => {
return (
<BatchSelection selectedCount={3} colorTheme="white">
<IconButton onClick={() => {}}>
<Icon type="csv" />
</IconButton>
<IconButton onClick={() => {}}>
<Icon type="bin" />
</IconButton>
<IconButton onClick={() => {}}>
<Icon type="pdf" />
</IconButton>
(args) => (
<BatchSelection {...args}>
<Button variantType="tertiary">Button 1</Button>
<Button variantType="tertiary">Button 2</Button>
</BatchSelection>
);
}
)
```


### Disabled
### ExampleImplementation

**Args**

```tsx
{
selectedCount: 1,
totalItems: 10,
onDismiss: () => {},
}
```

**Render**

```tsx
() => {
return (
<BatchSelection selectedCount={4} disabled>
<IconButton onClick={() => {}}>
<Icon type="csv" />
</IconButton>
<IconButton onClick={() => {}}>
<Icon type="bin" />
</IconButton>
<IconButton onClick={() => {}}>
<Icon type="pdf" />
</IconButton>
<Button iconType="home" mr="3px">
Button
(args) => {
const isSmallScreen = useMediaQuery("(max-width: 680px)");
const isLargeScreen = useMediaQuery("(min-width: 840px)");

const smallScreenActions = (
<Button variantType="subtle">
Actions
<Icon type="caret_down" />
</Button>
<Link icon="admin">This is a link</Link>
<Link icon="admin" onClick={() => {}}>
This is actually a button but looks like a link
</Link>
</BatchSelection>
);
}
);

const mediumScreenActions = (
<>
<Button variantType="tertiary">
<Icon type="placeholder" />
Action 1
</Button>
<Button variantType="tertiary">
<Icon type="ellipsis_horizontal" />
More
</Button>
</>
);

const largeScreenActions = (
<>
<Button variantType="tertiary">
<Icon type="placeholder" />
Action 1
</Button>
<Button variantType="tertiary">
<Icon type="placeholder" />
Action 2
</Button>
<Button variantType="tertiary">
<Icon type="placeholder" />
Action 3
</Button>
</>
);

return (
<BatchSelection smallScreen={isSmallScreen} {...args}>
<Button variantType="subtle">
<Icon type="check_none" />
Select All
</Button>
{!isSmallScreen && <Divider p={0} height="40px" />}
{isSmallScreen && smallScreenActions}
{isLargeScreen && largeScreenActions}
{!isSmallScreen && !isLargeScreen && mediumScreenActions}
</BatchSelection>
);
}
```

11 changes: 0 additions & 11 deletions src/components/batch-selection/__internal__/batch-selection.context.ts
View file
Open in desktop

This file was deleted.

112 changes: 0 additions & 112 deletions src/components/batch-selection/batch-selection-interaction.stories.tsx
View file
Open in desktop

This file was deleted.

Loading
Loading