From 9641f2a0dffc421aee7ea5a6fcb282a78c503e03 Mon Sep 17 00:00:00 2001
From: Abbey Yacoe <abbey@xyflow.com>
Date: Mon, 26 May 2025 12:04:22 +0200
Subject: [PATCH] chore: make labelConfig items required, update description
 text

---
 packages/react/src/components/NodeWrapper/index.tsx   | 11 +++++------
 packages/react/src/types/component-props.ts           |  6 +++---
 .../src/lib/components/NodeWrapper/NodeWrapper.svelte |  4 ++--
 packages/svelte/src/lib/container/SvelteFlow/types.ts |  4 ++--
 packages/system/src/constants.ts                      |  2 +-
 5 files changed, 13 insertions(+), 14 deletions(-)

diff --git a/packages/react/src/components/NodeWrapper/index.tsx b/packages/react/src/components/NodeWrapper/index.tsx
index b64176fa..af067adc 100644
--- a/packages/react/src/components/NodeWrapper/index.tsx
+++ b/packages/react/src/components/NodeWrapper/index.tsx
@@ -144,12 +144,11 @@ export function NodeWrapper<NodeType extends Node>({
       event.preventDefault();
 
       store.setState({
-        ariaLiveMessage:
-          labelConfig['a11yDescription.ariaLiveMessage']?.(
-            event.key.replace('Arrow', '').toLowerCase(),
-            ~~internals.positionAbsolute.x,
-            ~~internals.positionAbsolute.y
-          ) || '',
+        ariaLiveMessage: labelConfig['a11yDescription.ariaLiveMessage'](
+          event.key.replace('Arrow', '').toLowerCase(),
+          ~~internals.positionAbsolute.x,
+          ~~internals.positionAbsolute.y
+        ),
       });
 
       moveSelectedNodes({
diff --git a/packages/react/src/types/component-props.ts b/packages/react/src/types/component-props.ts
index 0206e102..315168a9 100644
--- a/packages/react/src/types/component-props.ts
+++ b/packages/react/src/types/component-props.ts
@@ -668,8 +668,8 @@ export interface ReactFlowProps<NodeType extends Node = Node, EdgeType extends E
    */
   debug?: boolean;
   /**
-   * Custom accessibility messages for screen readers and a11y features.
-   * Allows localization and customization of ARIA descriptions.
+   * Configuration for customizable labels, descriptions, and UI text. Provided keys will override the corresponding defaults.
+   * Allows localization, customization of ARIA descriptions, control labels, minimap labels, and other UI strings.
    */
-  labelConfig?: LabelConfig;
+  labelConfig?: Partial<LabelConfig>;
 }
diff --git a/packages/svelte/src/lib/components/NodeWrapper/NodeWrapper.svelte b/packages/svelte/src/lib/components/NodeWrapper/NodeWrapper.svelte
index 9a1a5271..5fd55e72 100644
--- a/packages/svelte/src/lib/components/NodeWrapper/NodeWrapper.svelte
+++ b/packages/svelte/src/lib/components/NodeWrapper/NodeWrapper.svelte
@@ -189,11 +189,11 @@
     ) {
       // prevent default scrolling behavior on arrow key press when node is moved
       event.preventDefault();
-      store.ariaLiveMessage = labelConfig['a11yDescription.ariaLiveMessage']?.(
+      store.ariaLiveMessage = labelConfig['a11yDescription.ariaLiveMessage'](
         event.key.replace('Arrow', '').toLowerCase(),
         ~~node.internals.positionAbsolute.x,
         ~~node.internals.positionAbsolute.y
-      ) || '';
+      ),
 
       store.moveSelectedNodes(arrowKeyDiffs[event.key], event.shiftKey ? 4 : 1);
     }
diff --git a/packages/svelte/src/lib/container/SvelteFlow/types.ts b/packages/svelte/src/lib/container/SvelteFlow/types.ts
index 749f2fb8..03259006 100644
--- a/packages/svelte/src/lib/container/SvelteFlow/types.ts
+++ b/packages/svelte/src/lib/container/SvelteFlow/types.ts
@@ -473,8 +473,8 @@ export type SvelteFlowProps<
     /** This event handler gets called when the user finishes dragging a selection box */
     onselectionend?: (event: PointerEvent) => void;
     /**
-     * Custom accessibility messages for screen readers and a11y features.
-     * Allows localization and customization of ARIA descriptions.
+     * Configuration for customizable labels, descriptions, and UI text. Provided keys will override the corresponding defaults.
+     * Allows localization, customization of ARIA descriptions, control labels, minimap labels, and other UI strings.
      */
     labelConfig?: LabelConfig;
   };
diff --git a/packages/system/src/constants.ts b/packages/system/src/constants.ts
index 24941555..8bbdd005 100644
--- a/packages/system/src/constants.ts
+++ b/packages/system/src/constants.ts
@@ -58,4 +58,4 @@ export const defaultLabelConfig = {
   'minimap.ariaLabel': 'Mini Map',
 };
 
-export type LabelConfig = Partial<typeof defaultLabelConfig>;
+export type LabelConfig = Required<typeof defaultLabelConfig>;