ink/build/hooks/use-cursor.js

React for CLI

import { useContext, useRef, useCallback, useInsertionEffect } from 'react';
import CursorContext from '../components/CursorContext.js';
/**
`useCursor` is a React hook that lets you control the terminal cursor position.

Setting a cursor position makes the cursor visible at the specified coordinates (relative to the Ink output origin). This is useful for IME (Input Method Editor) support, where the composing character is displayed at the cursor location.

Pass `undefined` to hide the cursor.
*/
const useCursor = () => {
    const context = useContext(CursorContext);
    const positionRef = useRef(undefined);
    const setCursorPosition = useCallback((position) => {
        positionRef.current = position;
    }, []);
    // Propagate cursor position to log-update only during commit phase.
    // useInsertionEffect runs before resetAfterCommit (which triggers onRender),
    // and does NOT run for abandoned concurrent renders (e.g. suspended components).
    // This prevents cursor state from leaking across render boundaries.
    useInsertionEffect(() => {
        context.setCursorPosition(positionRef.current);
        return () => {
            context.setCursorPosition(undefined);
        };
    });
    return { setCursorPosition };
};
export default useCursor;
//# sourceMappingURL=use-cursor.js.map