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

Modified the Knobs onChange debounce function so that knob storage occurs on keypress but rendering waits until debouncing has completed #6022

Merged
merged 3 commits into from
Mar 11, 2019
Merged

Modified the Knobs onChange debounce function so that knob storage occurs on keypress but rendering waits until debouncing has completed #6022

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fcb86a8
Modified the component force render debounce so that knob storage occ…
CodeByAlex Mar 11, 2019
636a02d
Merge branch 'next' into feature/knobs-performance-debouncing
CodeByAlex Mar 11, 2019
48788f6
Removed double lodash import added during merge
CodeByAlex Mar 11, 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
21 changes: 9 additions & 12 deletions addons/knobs/src/registerKnobs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +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;
const COMPONENT_FORCE_RENDER_DEBOUNCE_DELAY_MS = 325;

function forceReRender() {
addons.getChannel().emit(FORCE_RE_RENDER);
Expand All @@ -19,20 +19,17 @@ function setPaneKnobs(timestamp = +new Date()) {
}

// 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.
const knobOptions = knobStore.get(name);

knobOptions.value = value;
const debouncedOnKnobChanged = debounce(() => {
knobStore.markAllUnused();

forceReRender();
}, KNOB_CHANGED_DEBOUNCE_DELAY_MS);
}, COMPONENT_FORCE_RENDER_DEBOUNCE_DELAY_MS);

function knobChanged(change) {
debouncedOnKnobChanged(change);
const { name } = change;
const { value } = change; // Update the related knob and it's value.
const knobOptions = knobStore.get(name);
knobOptions.value = value;
debouncedOnKnobChanged();
}

function knobClicked(clicked) {
Expand Down