萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

JavaScript 獲取與設置文本框/文本域光標位置:跨瀏覽器完整方案

光標位置操作是富文本編輯器、@提及、表單驗證的基礎能力。IE 使用 TextRange,現代瀏覽器使用 selectionStart/End,差異巨大。本文提供統一封裝、TypeScript 類型、React/Vue Hooks 封裝與邊界情況處理。

一、核心 API 差異對比

能力現代瀏覽器 (Chrome/FF/Safari/Edge)IE ≤ 11
獲取光標起始位置element.selectionStartdocument.selection.createRange()
獲取光標結束位置element.selectionEnd同一 Range 對象
設置光標位置element.setSelectionRange(start, end)range.move() + range.select()
獲取選中文本element.value.slice(start, end)range.text
插入文本element.setRangeText(text)range.text = text + range.collapse(false)

二、統一封裝工具庫

// cursorUtils.ts
export interface CursorPosition {
    start: number;
    end: number;
}

/** 獲取輸入框光標/選區位置 */
export function getCursorPosition(el: HTMLInputElement | HTMLTextAreaElement): CursorPosition {
    if (typeof el.selectionStart === 'number') {
        return { start: el.selectionStart, end: el.selectionEnd };
    }
    
    // IE ≤ 11
    if (document.selection && document.selection.type !== 'Control') {
        const range = document.selection.createRange();
        const storedRange = range.duplicate();
        storedRange.moveToElementText(el);
        storedRange.setEndPoint('EndToEnd', range);
        const start = storedRange.text.length - range.text.length;
        const end = start + range.text.length;
        return { start, end };
    }
    
    return { start: 0, end: 0 }; // 未聚焦或不支持
}

/** 設置光標位置(摺疊選區) */
export function setCursorPosition(
    el: HTMLInputElement | HTMLTextAreaElement, 
    pos: number
): void {
    if (el.setSelectionRange) {
        el.focus();
        el.setSelectionRange(pos, pos);
        return;
    }
    
    // IE
    if (document.selection) {
        const range = el.createTextRange();
        range.move('character', pos);
        range.select();
    }
}

/** 設置選區範圍 */
export function setSelectionRange(
    el: HTMLInputElement | HTMLTextAreaElement,
    start: number,
    end: number
): void {
    if (el.setSelectionRange) {
        el.focus();
        el.setSelectionRange(start, end);
        return;
    }
    
    if (document.selection) {
        const range = el.createTextRange();
        range.moveStart('character', start);
        range.moveEnd('character', end - el.value.length); // 負值向左
        range.select();
    }
}

/** 在光標處插入文本 */
export function insertTextAtCursor(
    el: HTMLInputElement | HTMLTextAreaElement,
    text: string
): void {
    const { start, end } = getCursorPosition(el);
    const value = el.value;
    const newValue = value.slice(0, start) + text + value.slice(end);
    
    // 保持 undo 棧(關鍵:直接賦值會清空 undo 歷史)
    if (el.setRangeText) {
        el.setRangeText(text, start, end, 'end'); // 'end' 將光標移至插入文本後
    } else {
        // 兜底:手動恢復選區
        el.value = newValue;
        setCursorPosition(el, start + text.length);
    }
}

三、框架集成:React Hook / Vue Composables

React useCursor Hook

import { useRef, useCallback } from 'react';
import { getCursorPosition, setCursorPosition, insertTextAtCursor } from './cursorUtils';

export function useCursor() {
    const ref = useRef(null);
    
    const get = useCallback(() => 
        ref.current ? getCursorPosition(ref.current) : { start: 0, end: 0 }, []);
    
    const set = useCallback((pos: number) => {
        if (ref.current) setCursorPosition(ref.current, pos);
    }, []);
    
    const insert = useCallback((text: string) => {
        if (ref.current) insertTextAtCursor(ref.current, text);
    }, []);
    
    return { ref, get, set, insert };
}

// 使用
function MentionInput() {
    const { ref, get, insert } = useCursor();
    
    const handleAt = () => {
        const { start } = get();
        insert('@user ');
    };
    
    return <textarea ref={ref} onKeyDown={e => e.key === '@' && handleAt()} />;
}

Vue 3 Composable

import { ref, shallowRef } from 'vue';
import { getCursorPosition, setCursorPosition, insertTextAtCursor } from './cursorUtils';

export function useCursor() {
    const elRef = shallowRef();
    
    const get = () => elRef.value ? getCursorPosition(elRef.value) : { start: 0, end: 0 };
    const set = (pos: number) => elRef.value && setCursorPosition(elRef.value, pos);
    const insert = (text: string) => elRef.value && insertTextAtCursor(elRef.value, text);
    
    return { elRef, get, set, insert };
}

四、邊界情況與避坑指南

1. 元素未聚焦時獲取位置

  • 現代瀏覽器:selectionStart 返回上次位置(可用)
  • IE:document.selection.createRange() 拋錯或返回 body 範圍 → 必須先 el.focus()

2. textarea 換行符差異

  • Windows: \r\n (2 字符)
  • Unix/Mac: \n (1 字符)
  • 瀏覽器統一規範:textarea.value 中統一為 \n,但 TextRange 可能按實際字符計算 → 統一用 value.length 計算位置

3. 虛擬鍵盤彈出導致佈局變化

// 移動端:確保光標在可視區
el.addEventListener('focus', () => {
    setTimeout(() => el.scrollIntoView({ behavior: 'smooth', block: 'center' }), 300);
});

4. ContentEditable 元素(非 input/textarea)

完全不同 API:window.getSelection() + Range,不在本文範圍內。

五、原文代碼問題修正

  • getTa1CursorPosition.caller.arguments[0]:嚴格模式禁用,現代代碼不可用 → 改用事件參數傳遞
  • range.moveToPoint(evt.x, evt.y):IE 專有,標準無此方法 → 放棄點擊位置定位,改用 selectionStart
  • 直接賦值 el.value = newValue 破壞 Undo 歷史 → 必須用 setRangeText 或 execCommand('insertText')

六、總結

  1. 核心分支:selectionStart (現代) vs TextRange (IE)
  2. 封裝統一接口:getCursorPosition、setCursorPosition、insertTextAtCursor
  3. 保護 Undo 棧:優先用 setRangeText / execCommand
  4. 框架集成:React Hook / Vue Composable 封裝 ref 與操作
  5. IE 退役後可全面簡化,但理解兼容邏輯利於維護舊專案

掌握這套封裝,無論是構建 @提及、表情選擇器、代碼片段插入,還是實現協同編輯光標同步,都有堅實基礎。

copyright © 萬盛學電腦網 all rights reserved