Skip to content

Add disabledBehavior to ListView docs #3261

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
reidbarber merged 5 commits into from
Jun 28, 2022
Merged

Add disabledBehavior to ListView docs #3261

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
320c771
add disabledBehavior to ListView docs
reidbarber Jun 23, 2022
c33ff83
Merge branch 'main' into list-disabledBehavior-docs
LFDanLu Jun 24, 2022
f3ae03b
address comments
reidbarber Jun 27, 2022
aa7eae0
Merge branch 'main' into list-disabledBehavior-docs
snowystinger Jun 27, 2022
ffed7c3
Merge branch 'main' into list-disabledBehavior-docs
LFDanLu Jun 28, 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
26 changes: 24 additions & 2 deletions packages/@react-spectrum/list/docs/ListView.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ function PokemonList(props) {
{id: 4, name: 'Pikachu'}
];

let [selectedKeys, setSelectedKeys] = React.useState(new Set([2]));
let [selectedKeys, setSelectedKeys] = React.useState(props.defaultSelectedKeys || new Set([2]));

return (
<ListView items={rows} maxWidth="size-6000" aria-label="ListView with controlled selection" selectionMode="multiple" selectedKeys={selectedKeys} onSelectionChange={setSelectedKeys} {...props}>
Expand Down Expand Up @@ -293,13 +293,35 @@ In this mode, if a single row is selected and the user presses it, it will not b

### Disabled rows

You can disable specific rows by providing an array of keys to ListView via the `disabledKeys` prop. This will prevent rows from being selectable, as shown in the example below.
You can disable specific rows by providing an array of keys to ListView via the `disabledKeys` prop. This will disable all interactions on disabled rows, unless the `disabledBehavior` prop is used to change this behavior.

```tsx example
// Using the same list as above
<PokemonList disabledKeys={[3]} aria-label="ListView with disabled rows" />
```

If you set the `disabledBehavior` prop to `selection`, interactions such as focus, dragging, or actions can still be performed on disabled rows.
```tsx example
<Flex wrap gap="size-300">
<PokemonList
disabledKeys={[3]}
defaultSelectedKeys={[]}
disabledBehavior="all"
aria-label="ListView with all interaction disabled for disabled rows"
width="size-2400"
onAction={key => alert(`Opening item ${key}...`)}
/>
<PokemonList
disabledKeys={[3]}
defaultSelectedKeys={[]}
disabledBehavior="selection"
aria-label="ListView with selection disabled for disabled rows"
width="size-2400"
onAction={key => alert(`Opening item ${key}...`)}
/>
</Flex>
```

### Highlight selection

By default, ListView uses the checkbox selection style, which includes a checkbox in each row for selection. When the selectionStyle prop is set to `"highlight"`, the checkboxes are hidden,
Expand Down