Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,41 @@ If `accordion` is true, only one panel can be open. Opening another panel will c

If `key` is not provided, the panel's index will be used instead.

#### KeyBoard Event

By default, Collapse will listen `onKeyDown`(<3.7.0 `onKeyPress`) event with `enter` key to toggle panel's active state when `collapsible` is not `disabled`. If you want to disable this behavior, you can prevent the event from bubbling like this:

```jsx
const App = () => {
const items: CollapseProps['items'] = [
{
label: <input onKeyDown={(e) => e.stopPropagation()} />,
children: 'content',
},
{
label: (
<div onKeyDown={(e) => e.stopPropagation()}>
<CustomComponent />
</div>
),
children: 'content',
},
{
label: 'title 2',
children: 'content 2',
collapsible: 'disabled',
},
{
label: 'title 3',
children: 'content 3',
onItemClick: console.log,
},
];

return <Collapse items={items} />;
};
```

## Development

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/basic.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import '../../assets/index.less';
const App = () => {
const items: CollapseProps['items'] = [
{
label: 'title',
label: <input onKeyDown={(e) => e.stopPropagation()} />,
children: 'content',
},
{
Expand Down
4 changes: 2 additions & 2 deletions src/Panel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const CollapsePanel = React.forwardRef<HTMLDivElement, CollapsePanelProps>((prop
onItemClick?.(panelKey!);
};

const handleKeyPress = (e: React.KeyboardEvent) => {
const handleKeyDown = (e: React.KeyboardEvent) => {
if (e.key === 'Enter' || e.keyCode === KeyCode.ENTER || e.which === KeyCode.ENTER) {
handleItemClick();
}
Expand Down Expand Up @@ -76,7 +76,7 @@ const CollapsePanel = React.forwardRef<HTMLDivElement, CollapsePanelProps>((prop
className: headerClassName,
'aria-expanded': isActive,
'aria-disabled': disabled,
onKeyPress: handleKeyPress,
onKeyDown: handleKeyDown,
};

if (!collapsibleHeader && !collapsibleIcon) {
Expand Down
8 changes: 4 additions & 4 deletions tests/index.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -396,16 +396,16 @@ describe('collapse', () => {
second
</Panel>
<Panel header="collapse 3" key="3" collapsible="disabled">
second
third
</Panel>
</Collapse>,
);

fireEvent.keyPress(container.querySelectorAll('.rc-collapse-header')?.[2], myKeyEvent);
fireEvent.keyDown(container.querySelectorAll('.rc-collapse-header')?.[2], myKeyEvent);
jest.runAllTimers();
expect(container.querySelectorAll('.rc-collapse-content-active')).toHaveLength(0);

fireEvent.keyPress(container.querySelector('.rc-collapse-header')!, myKeyEvent);
fireEvent.keyDown(container.querySelector('.rc-collapse-header')!, myKeyEvent);
jest.runAllTimers();

expect(container.querySelectorAll('.rc-collapse-content-active')).toHaveLength(1);
Expand All @@ -414,7 +414,7 @@ describe('collapse', () => {
'rc-collapse-content-active',
);

fireEvent.keyPress(container.querySelector('.rc-collapse-header')!, myKeyEvent);
fireEvent.keyDown(container.querySelector('.rc-collapse-header')!, myKeyEvent);
jest.runAllTimers();

expect(container.querySelectorAll('.rc-collapse-content-active')).toHaveLength(0);
Expand Down