ink-prompt 0.1.6 → 0.1.7

package/dist/components/MultilineInput/index.d.ts

@@ -1,37 +1,110 @@
 import React from 'react';
 export interface MultilineInputProps {
-    /** Controlled text value */
+    /**
+     * Controlled text value. When provided, the component becomes controlled
+     * and the value is managed externally.
+     */
     value?: string;
-    /** Called when text changes */
+    /**
+     * Called when the text content changes due to user input. Receives the
+     * new text value as a parameter.
+     */
     onChange?: (value: string) => void;
-    /** Called when user submits (Enter without backslash) */
+    /**
+     * Called when the user submits the input (typically by pressing Enter
+     * without a backslash at the end). Receives the final text value.
+     */
     onSubmit?: (value: string) => void;
-    /** Placeholder text when empty */
+    /**
+     * Placeholder text displayed when the input is empty and the cursor
+     * is not shown.
+     */
     placeholder?: string;
-    /** Whether to show the cursor (defaults to true) */
+    /**
+     * Whether to display the cursor. Defaults to true.
+     */
     showCursor?: boolean;
-    /** Terminal width for word wrapping */
+    /**
+     * Terminal width for word wrapping. If not provided, uses the terminal's
+     * current width with resize support.
+     */
     width?: number;
-    /** Whether input is active/focused (defaults to true) */
+    /**
+     * Whether the input is active and focused, allowing keyboard input.
+     * Defaults to true.
+     */
     isActive?: boolean;
-    /** Called whenever the cursor offset changes (flat index) */
+    /**
+     * Called whenever the cursor position changes. Receives the flat
+     * character offset as a parameter.
+     */
     onCursorChange?: (offset: number) => void;
-    /** Optional external cursor override (flat index) */
+    /**
+     * Optional external cursor position override. When set, forces the
+     * cursor to the specified flat character offset.
+     */
     cursorOverride?: number;
+    /**
+     * Called when an arrow key is pressed but cursor is at a boundary.
+     * - 'up': cursor is on the first/topmost line
+     * - 'down': cursor is on the last/bottommost line
+     * - 'left': cursor is at position 0 (start of text)
+     * - 'right': cursor is at end of text (after last character)
+     */
+    onBoundaryArrow?: (direction: 'up' | 'down' | 'left' | 'right') => void;
 }
 /**
  * Props for the core component (without Ink-specific hooks)
  * This allows testing the rendering logic separately.
  */
 export interface MultilineInputCoreProps {
+    /**
+     * Controlled text value. When provided, the component becomes controlled
+     * and the text is managed externally.
+     */
     value?: string;
+    /**
+     * Called when the text content changes. Receives the new text value
+     * as a parameter.
+     */
     onChange?: (value: string) => void;
+    /**
+     * Called when the user submits the input (typically by pressing Enter
+     * without a backslash at the end).
+     */
     onSubmit?: (value: string) => void;
+    /**
+     * Placeholder text displayed when the input is empty and the cursor
+     * is not shown.
+     */
     placeholder?: string;
+    /**
+     * Whether to display the cursor. Defaults to true.
+     */
     showCursor?: boolean;
+    /**
+     * Terminal width for word wrapping. If not provided, uses the terminal's
+     * current width.
+     */
     width?: number;
+    /**
+     * Called whenever the cursor position changes. Receives the flat
+     * character offset as a parameter.
+     */
     onCursorChange?: (offset: number) => void;
+    /**
+     * Optional external cursor position override. When set, forces the
+     * cursor to the specified flat character offset.
+     */
     cursorOverride?: number;
+    /**
+     * Called when an arrow key is pressed but cursor is at a boundary.
+     * - 'up': cursor is on the first/topmost line
+     * - 'down': cursor is on the last/bottommost line
+     * - 'left': cursor is at position 0 (start of text)
+     * - 'right': cursor is at end of text (after last character)
+     */
+    onBoundaryArrow?: (direction: 'up' | 'down' | 'left' | 'right') => void;
 }
 /**
  * Core rendering component that can be tested without Ink runtime.

package/dist/components/MultilineInput/index.js

@@ -66,7 +66,7 @@ export const MultilineInputCore = ({ value, onChange, placeholder, showCursor =
  * Full MultilineInput with Ink keyboard handling.
  * This component uses Ink-specific hooks and must be rendered in an Ink context.
  */
-export const MultilineInput = ({ value, onChange, onSubmit, placeholder, showCursor = true, width, isActive = true, onCursorChange, cursorOverride, }) => {
+export const MultilineInput = ({ value, onChange, onSubmit, placeholder, showCursor = true, width, isActive = true, onCursorChange, cursorOverride, onBoundaryArrow, }) => {
     // Get terminal width from Ink (with resize support) if not provided
     const terminalWidth = useTerminalWidth(width);
     // Track raw input for detecting Home/End keys
@@ -140,11 +140,12 @@ export const MultilineInput = ({ value, onChange, onSubmit, placeholder, showCur
         redo: textInput.redo,
         setText: textInput.setText,
         submit: handleSubmit,
+        onBoundaryArrow,
     };
     // Handle keyboard input
     useInput((input, key) => {
         log(`[USEINPUT] input="${input.replace(/[\x00-\x1F\x7F-\uFFFF]/g, c => `\\x${c.charCodeAt(0).toString(16)}`)}" key=${JSON.stringify(key)} rawLen=${lastRawInput.current?.length || 0}`);
-        handleKey(key, input, buffer, actions, textInput.cursor, lastRawInput.current);
+        handleKey(key, input, buffer, actions, textInput.cursor, lastRawInput.current, terminalWidth);
     }, { isActive });
     // Show placeholder if empty and no cursor shown
     const isEmpty = textInput.value === '';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ink-prompt",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "A React Ink component for prompts",
   "type": "module",
   "main": "./dist/index.js",