cabbage-react 1.0.28 → 1.0.30

package/README.md

@@ -1,6 +1,6 @@
 # Cabbage React
 
-Cabbage React provides React hooks for synchronizing [Cabbage](https://cabbageaudio.com) with [React](https://github.com/facebook/react), making it easier to build a custom UI that communicates with the Cabbage host.
+Cabbage React provides React hooks for synchronizing [Cabbage](https://cabbageaudio.com) with [React](https://github.com/facebook/react), making it easier to build a custom UI that communicates with the Cabbage backend.
 
 ## Example Project
 
@@ -18,19 +18,18 @@ npm install cabbage-react
 
 ### useCabbageState
 
-Synchronize a parameter with Cabbage. This hook:
+Synchronize a parameter with the backend. This hook:
 
-- Identifies and sets the default value defined in Cabbage to a state.
+- Identifies and sets the default value defined in .csd to a state.
 - Handles initialization when opening an existing session, or reopening the plugin window.
 - Listens for value updates from the host (DAW), or from Csound.
-- Sends changes back to Cabbage when using the provided value-setter.
+- Sends changes to the backend using the provided value-setter.
 
 ### useCabbageProperties
 
-Get properties for a parameter from Cabbage.
-This hook:
+Get properties for a parameter from the backend. This hook:
 
-- Listens for property updates from Cabbage.
+- Listens for property updates from the backend.
 - Updates local state automatically when data changes.
 
 ## Usage
@@ -41,22 +40,17 @@ import { useCabbageProperties, useCabbageState } from "cabbage-react";
 
 const HorizontalSlider = ({
 	channelId,
-	parameterIndex,
 	inputProps,
 }: {
 	channelId: string;
-	parameterIndex: number;
 	inputProps?: InputHTMLAttributes<HTMLInputElement>;
 }) => {
 	const { properties } = useCabbageProperties(channelId);
 	const channelProperties = properties?.channels.find(
-		(c: any) => c.id === channelId
+		(c: any) => c.id === channelId,
 	);
 
-	const { value, setValue } = useCabbageState<number>(
-		channelId,
-		parameterIndex
-	);
+	const { value, setValue } = useCabbageState<number>(channelId);
 
 	return (
 		<div>
@@ -89,7 +83,7 @@ export default HorizontalSlider;
 
 ## Interact directly with Cabbage
 
-You can also import the [Cabbage class](https://github.com/hdale94/cabbage-react/blob/main/src/cabbage/cabbage.js) to send custom messages or interact directly with Cabbage.
+You can also import the [Cabbage class](https://github.com/hdale94/cabbage-react/blob/main/src/cabbage/cabbage.js) to send custom messages or interact directly with the backend.
 
 ## Notify Cabbage When UI Is Ready
 

package/dist/hooks/useCabbageProperties.d.ts

@@ -1,6 +1,6 @@
 /**
- * Custom hook to get a parameter's properties from Cabbage.
- * This hook listens for updates to parameter properties via Cabbage and updates the local state
+ * Custom hook to get a parameter's properties from Cabbage backend.
+ * This hook listens for updates to parameter properties from the backend and updates the local state
  * whenever new data is received.
  * @param channelId - The channel name
  */

package/dist/hooks/useCabbageState.d.ts

@@ -1,7 +1,7 @@
 /**
- * Custom hook to sync a parameter with Cabbage.
- * This hook listens for updates to a parameter value from Cabbage and
- * sends updates to Cabbage when the parameter value changes locally (e.g., through a UI slider).
+ * Custom hook to sync a parameter with Cabbage backend.
+ * This hook listens for updates to a parameter value from the backend and
+ * sends updates to the backend when the parameter value changes locally (e.g., through a UI slider).
  * @param channelId - The channel name
  * @param gesture - The gesture type: "begin" (start of interaction), "value" (during interaction), "end" (end of continuous interaction), or "complete" (discrete action e.g. button click).
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "cabbage-react",
-	"version": "1.0.28",
+	"version": "1.0.30",
 	"type": "module",
 	"keywords": [
 		"cabbage",