Skip to content

feat(rate): Allow disabling keyboard control #190

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
MadCcc merged 5 commits into from
May 30, 2024
+37 −32
Merged

feat(rate): Allow disabling keyboard control #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5f04cf1
:recycle: clean Code
Wxh16144 May 30, 2024
214f6b7
feat(rate): Allow disabling keyboard control
Wxh16144 May 30, 2024
0353408
chore: rename
Wxh16144 May 30, 2024
822993d
chore: update
Wxh16144 May 30, 2024
9cf099b
typo
Wxh16144 May 30, 2024
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
53 changes: 21 additions & 32 deletions src/Rate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ export interface RateProps
id?: string;
autoFocus?: boolean;
direction?: string;
/**
* Is keyboard control enabled.
* @default true
*/
keyboard?: boolean;
}

export interface RateRef {
Expand All @@ -46,6 +51,7 @@ function Rate(props: RateProps, ref: React.Ref<RateRef>) {
count = 5,
allowHalf = false,
allowClear = true,
keyboard = true,

// Display
character = '★',
Expand Down Expand Up @@ -166,39 +172,22 @@ function Rate(props: RateProps, ref: React.Ref<RateRef>) {
const onInternalKeyDown: React.KeyboardEventHandler<HTMLUListElement> = (event) => {
const { keyCode } = event;
const reverse = direction === 'rtl';
let nextValue = value;
if (keyCode === KeyCode.RIGHT && nextValue < count && !reverse) {
if (allowHalf) {
nextValue += 0.5;
} else {
nextValue += 1;
const step = allowHalf ? 0.5 : 1;

if (keyboard) {
if (keyCode === KeyCode.RIGHT && value < count && !reverse) {
changeValue(value + step);
event.preventDefault();
} else if (keyCode === KeyCode.LEFT && value > 0 && !reverse) {
changeValue(value - step);
event.preventDefault();
} else if (keyCode === KeyCode.RIGHT && value > 0 && reverse) {
changeValue(value - step);
event.preventDefault();
} else if (keyCode === KeyCode.LEFT && value < count && reverse) {
changeValue(value + step);
event.preventDefault();
}
changeValue(nextValue);
event.preventDefault();
} else if (keyCode === KeyCode.LEFT && nextValue > 0 && !reverse) {
if (allowHalf) {
nextValue -= 0.5;
} else {
nextValue -= 1;
}
changeValue(nextValue);
event.preventDefault();
} else if (keyCode === KeyCode.RIGHT && nextValue > 0 && reverse) {
if (allowHalf) {
nextValue -= 0.5;
} else {
nextValue -= 1;
}
changeValue(nextValue);
event.preventDefault();
} else if (keyCode === KeyCode.LEFT && nextValue < count && reverse) {
if (allowHalf) {
nextValue += 0.5;
} else {
nextValue += 1;
}
changeValue(nextValue);
event.preventDefault();
}

onKeyDown?.(event);
Expand Down
16 changes: 16 additions & 0 deletions tests/simple.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,22 @@ describe('rate', () => {
wrapper.simulate('mouseleave');
expect(handleMouseLeave).toHaveBeenCalled();
});

it('should ignore key presses when keyboard is false', () => {
const mockChange = jest.fn();
const mockKeyDown = jest.fn();
const wrapper = mount(
<Rate
defaultValue={3}
onChange={mockChange}
onKeyDown={mockKeyDown}
keyboard={false}
/>
);
wrapper.simulate('keyDown', { keyCode: KeyCode.LEFT });
expect(mockChange).not.toHaveBeenCalled();
expect(mockKeyDown).toHaveBeenCalled();
});
});

describe('html attributes', () => {
Expand Down