Skip to content
Open
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
5 changes: 5 additions & 0 deletions .changeset/token-cancel-keyboard-removal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

Token, IssueLabelToken: Respect canceled keyboard events when removing tokens with Backspace or Delete.
4 changes: 4 additions & 0 deletions packages/react/src/Token/TokenBase.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ const TokenBase = React.forwardRef<HTMLButtonElement | HTMLAnchorElement | HTMLS
onKeyDown={(event: KeyboardEvent<HTMLSpanElement & HTMLAnchorElement & HTMLButtonElement>) => {
onKeyDown && onKeyDown(event)

if (event.defaultPrevented) {
return
}

if ((event.key === 'Backspace' || event.key === 'Delete') && onRemove) {
onRemove()
}
Expand Down
22 changes: 22 additions & 0 deletions packages/react/src/Token/__tests__/Token.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,28 @@ const testTokenComponent = (Component: React.ComponentType<React.PropsWithChildr
expect(domNode.parentElement).toHaveClass('testing-class')
})

it.each(['Backspace', 'Delete'])('allows onKeyDown to cancel removal with %s', key => {
const onRemove = vi.fn()
const onKeyDown = vi.fn((event: React.KeyboardEvent) => event.preventDefault())
const {getByText} = HTMLRender(<Component text="token" onRemove={onRemove} onKeyDown={onKeyDown} />)

fireEvent.keyDown(getByText('token'), {key})

expect(onKeyDown).toHaveBeenCalledTimes(1)
expect(onRemove).not.toHaveBeenCalled()
})

it.each(['Backspace', 'Delete'])('removes with %s when onKeyDown does not cancel the event', key => {
const onRemove = vi.fn()
const onKeyDown = vi.fn()
const {getByText} = HTMLRender(<Component text="token" onRemove={onRemove} onKeyDown={onKeyDown} />)

fireEvent.keyDown(getByText('token'), {key})

expect(onKeyDown).toHaveBeenCalledTimes(1)
expect(onRemove).toHaveBeenCalledTimes(1)
})

it('renders with correct data-cursor-is-interactive attribute for button element', () => {
const {getByText} = HTMLRender(<Component as="button" text="token" />)
const domNode = getByText('token')
Expand Down
Loading