rename to "useKnobKeyboardControls"

satelllte · Jan 13, 2024 · 108de51 · 108de51
1 parent 2f488c5
commit 108de51
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/apps/docs/src/app/page.tsx b/apps/docs/src/app/page.tsx
@@ -225,7 +225,7 @@ function IndexPage() {
             ]}
           />
           <ComponentDocumentation
-            name='useKnobKeyboardControl'
+            name='useKnobKeyboardControls'
             about='A primitive for enabling keyboard controls.'
             properties={[
               {

diff --git a/apps/docs/src/components/knobs/KnobBase.tsx b/apps/docs/src/components/knobs/KnobBase.tsx
@@ -4,7 +4,7 @@ import {
   KnobHeadless,
   KnobHeadlessLabel,
   KnobHeadlessOutput,
-  useKnobKeyboardControl,
+  useKnobKeyboardControls,
 } from 'react-knob-headless';
 import {mapFrom01Linear, mapTo01Linear} from '@dsp-ts/math';
 import {KnobBaseThumb} from './KnobBaseThumb';
@@ -50,7 +50,7 @@ export function KnobBase({
   const stepLarger = stepLargerFn(valueRaw);
   const dragSensitivity = 0.006;
 
-  const keyboardControlHandlers = useKnobKeyboardControl({
+  const keyboardControlHandlers = useKnobKeyboardControls({
     valueRaw,
     valueMin,
     valueMax,

diff --git a/packages/react-knob-headless/src/index.ts b/packages/react-knob-headless/src/index.ts
@@ -1,4 +1,4 @@
 export {KnobHeadless} from './KnobHeadless';
 export {KnobHeadlessLabel} from './KnobHeadlessLabel';
 export {KnobHeadlessOutput} from './KnobHeadlessOutput';
-export {useKnobKeyboardControl} from './useKnobKeyboardControl';
+export {useKnobKeyboardControls} from './useKnobKeyboardControls';
diff --git a/...ob-headless/src/useKnobKeyboardControl.ts → ...b-headless/src/useKnobKeyboardControls.ts b/...ob-headless/src/useKnobKeyboardControl.ts → ...b-headless/src/useKnobKeyboardControls.ts
@@ -1,6 +1,6 @@
 import {clamp} from '@dsp-ts/math';
 
-type UseKnobKeyboardControlProps = {
+type UseKnobKeyboardControlsProps = {
   /**
    * Same as `valueRaw` prop of `KnobHeadless`.
    */
@@ -36,15 +36,15 @@ type UseKnobKeyboardControlProps = {
   readonly noDefaultPrevention?: boolean;
 };
 
-export const useKnobKeyboardControl = ({
+export const useKnobKeyboardControls = ({
   valueRaw,
   valueMin,
   valueMax,
   step,
   stepLarger,
   onValueRawChange,
   noDefaultPrevention = false,
-}: UseKnobKeyboardControlProps): {onKeyDown: React.KeyboardEventHandler} => {
+}: UseKnobKeyboardControlsProps): {onKeyDown: React.KeyboardEventHandler} => {
   const onKeyDown: React.KeyboardEventHandler = (event) => {
     const {code} = event;
     switch (code) {