ink/build/hooks/use-paste.js

React for CLI

import { useEffect, useEffectEvent } from 'react';
import reconciler from '../reconciler.js';
import { useStdinContext } from './use-stdin.js';
/**
A React hook that calls `handler` whenever the user pastes text in the terminal. Bracketed paste mode (`\x1b[?2004h`) is automatically enabled while the hook is active, so pasted text arrives as a single string rather than being misinterpreted as individual key presses.

`usePaste` and `useInput` can be used together in the same component. They operate on separate event channels, so paste content is never forwarded to `useInput` handlers when `usePaste` is active.

```
import {useInput, usePaste} from 'ink';

const MyInput = () => {
    useInput((input, key) => {
        // Only receives typed characters and key events, not pasted text.
        if (key.return) {
            // Submit
        }
    });

    usePaste((text) => {
        // Receives the full pasted string, including newlines.
        console.log('Pasted:', text);
    });

    return …
};
```
*/
const usePaste = (handler, options = {}) => {
    // eslint-disable-next-line @typescript-eslint/naming-convention
    const { setRawMode, setBracketedPasteMode, internal_eventEmitter } = useStdinContext();
    useEffect(() => {
        if (options.isActive === false) {
            return;
        }
        setRawMode(true);
        setBracketedPasteMode(true);
        return () => {
            setRawMode(false);
            setBracketedPasteMode(false);
        };
    }, [options.isActive, setRawMode, setBracketedPasteMode]);
    const handlePaste = useEffectEvent((text) => {
        // Use discreteUpdates to assign DiscreteEventPriority to state
        // updates triggered by paste, matching the priority of useInput.
        // @ts-expect-error Types require 5 arguments (fn, a, b, c, d) but only fn is needed at runtime.
        reconciler.discreteUpdates(() => {
            handler(text);
        });
    });
    useEffect(() => {
        if (options.isActive === false) {
            return;
        }
        internal_eventEmitter.on('paste', handlePaste);
        return () => {
            internal_eventEmitter.removeListener('paste', handlePaste);
        };
    }, [options.isActive, internal_eventEmitter]);
};
export default usePaste;
//# sourceMappingURL=use-paste.js.map