# All files / autocomplete useInlineSelection.ts

0% Statements 0/75
0% Branches 0/1
0% Functions 0/1
0% Lines 0/75

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76

     "use client";
    import { useCallback, useRef } from "react";
    import { type EditableHTMLElement } from "../form/utils.js";
    import { type NonNullMutableRef } from "../types.js";

    /**
     * @remarks \@since 6.0.0
     */
    export interface HandleInlineSelectionOptions {
      type?: "type" | "replace" | "complete";
      search(query: string): string;
      target: EditableHTMLElement | null;
    }

    /**
     * @remarks \@since 6.0.0
     */
    export interface InlineSelectionOptions {
      defaultValue?: string;
    }

    /**
     * @remarks \@since 6.0.0
     */
    export interface InlineSelectionImplementation {
      typedValue: NonNullMutableRef<string>;
      handleSelection(options: HandleInlineSelectionOptions): void;
    }

    /**
     * @remarks \@since 6.0.0
     */
    export function useInlineSelection(
      options: InlineSelectionOptions = {}
    ): InlineSelectionImplementation {
      const { defaultValue = "" } = options;

      const typedValue = useRef(defaultValue);
      return {
        typedValue,
        handleSelection: useCallback((options) => {
          const { type = "type", target, search } = options;
          if (!target) {
            return;
          }

          const { value } = target;
          const isTyping = type === "type";
          const isCompleting = type === "complete";
          if (!isTyping || value.length > typedValue.current.length) {
            const match = search(value);

            if (match) {
              target.value = match;

              const end = match.length;
              let start = 0;
              if (isTyping) {
                start = value.length;
              } else if (isCompleting) {
                start = end;
              }

              // Using `"backward"` makes it so that the text field does not scroll
              // to the end which might hide the current cursor. instead, it will
              // only scroll as the user types and the newest characters are not
              // visible within the container
              target.setSelectionRange(start, end, "backward");
            }
          }

          typedValue.current = isTyping ? value : target.value;
        }, []),
      };
    }