Skip to content
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

[Addon: Knobs] - Performance Fix: added debouncing between keystrokes to speed up component rendering #5811

Merged
merged 4 commits into from
Mar 7, 2019
Merged

[Addon: Knobs] - Performance Fix: added debouncing between keystrokes to speed up component rendering #5811

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
429752a
added debouncing at 155ms between each keypress before the forceReRen…
CodeByAlex Mar 1, 2019
c15e07a
edited variable name
CodeByAlex Mar 2, 2019
8aa71c5
modified debounce logic to use lodash rather than custom timeout code
CodeByAlex Mar 7, 2019
ca63d0e
Merge branch 'next' into performance-fix-knob-change-debouncing
CodeByAlex Mar 7, 2019
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
1 change: 1 addition & 0 deletions addons/knobs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
"escape-html": "^1.0.3",
"fast-deep-equal": "^2.0.1",
"global": "^4.3.2",
"lodash.debounce": "^4.0.8",
"prop-types": "^15.7.2",
"qs": "^6.6.0",
"react-color": "^2.17.0",
Expand Down
9 changes: 8 additions & 1 deletion addons/knobs/src/registerKnobs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import addons from '@storybook/addons';
import { STORY_CHANGED, FORCE_RE_RENDER, REGISTER_SUBSCRIPTION } from '@storybook/core-events';

import debounce from 'lodash.debounce';
import KnobManager from './KnobManager';
import { CHANGE, CLICK, RESET, SET } from './shared';

export const manager = new KnobManager();
const { knobStore } = manager;
const KNOB_CHANGED_DEBOUNCE_DELAY_MS = 150;

function forceReRender() {
addons.getChannel().emit(FORCE_RE_RENDER);
Expand All @@ -16,7 +18,8 @@ function setPaneKnobs(timestamp = +new Date()) {
channel.emit(SET, { knobs: knobStore.getAll(), timestamp });
}

function knobChanged(change) {
// Increased performance by reducing the number of times a component is rendered during knob changes
const debouncedOnKnobChanged = debounce(change => {
const { name, value } = change;

// Update the related knob and it's value.
Expand All @@ -26,6 +29,10 @@ function knobChanged(change) {
knobStore.markAllUnused();

forceReRender();
}, KNOB_CHANGED_DEBOUNCE_DELAY_MS);

function knobChanged(change) {
debouncedOnKnobChanged(change);
}

function knobClicked(clicked) {
Expand Down