Jak ustawić pozycję karetki (kursora) w zadowalającym elemencie (div)?

190

Mam ten prosty kod HTML jako przykład:

<div id="editable" contenteditable="true">
  text text text<br>
  text text text<br>
  text text text<br>
</div>
<button id="button">focus</button>

Chcę prostej rzeczy - kiedy klikam przycisk, chcę umieścić kursor (kursor) w określonym miejscu w edytowalnym div. Podczas wyszukiwania w Internecie mam JS dołączony do kliknięcia przycisku, ale to nie działa (FF, Chrome):

var range = document.createRange();
var myDiv = document.getElementById("editable");
range.setStart(myDiv, 5);
range.setEnd(myDiv, 5);

Czy możliwe jest ręczne ustawienie pozycji karetki w ten sposób?

Frodik
źródło

Odpowiedzi:

260

W większości przeglądarek potrzebujesz obiektów Rangei Selection. Każdą z granic wyboru określa się jako węzeł i przesunięcie w tym węźle. Na przykład, aby ustawić kursor na piąty znak drugiego wiersza tekstu, wykonaj następujące czynności:

var el = document.getElementById("editable");
var range = document.createRange();
var sel = window.getSelection();
range.setStart(el.childNodes[2], 5);
range.collapse(true);
sel.removeAllRanges();
sel.addRange(range);

IE <9 działa zupełnie inaczej. Jeśli potrzebujesz obsługi tych przeglądarek, będziesz potrzebować innego kodu.

Przykład jsFiddle: http://jsfiddle.net/timdown/vXnCM/

Tim Down
źródło
2
Twoje rozwiązanie działa idealnie. Wielkie dzięki. Czy jest szansa, że ​​można by go uruchomić w „kontekście tekstowym” - oznacza to, że pozycja # 5 byłaby piątą literą na ekranie, a nie piątą literą w kodzie?
Frodik
3
@Frodik: Możesz użyć setSelectionRange()funkcji z odpowiedzi, którą tu napisałem: stackoverflow.com/questions/6240139/… . Jak zauważyłem w odpowiedzi, istnieją różne rzeczy, z którymi nie poradzi sobie poprawnie / konsekwentnie, ale może być wystarczająco dobry.
Tim Down
7
co powiesz na ustawienie karetki wewnątrz znacznika zakresu, takiego jak: << div id = "editable" contenteditable = "true"> test1 <br> test2 <br> <span> </span> </div>
Med Akram Z
1
@MalcolmOcean: Barf, ponieważ IE <9 nie ma document.createRange(lub window.getSelection, ale nie zajdzie tak daleko).
Tim Down
1
@undroid: Jsfiddle działa dobrze dla mnie w Firefox 38.0.5 na Macu.
Tim Down
62

Większość odpowiedzi na temat pozycjonowania kursora, które można zadowalać, jest dość uproszczona, ponieważ uwzględnia tylko dane wejściowe z prostym tekstem waniliowym. Gdy użyjesz elementów HTML w kontenerze, wprowadzony tekst zostaje podzielony na węzły i swobodnie rozłożony w strukturze drzewa.

Aby ustawić pozycję kursora, mam tę funkcję, która zapętla wszystkie podrzędne węzły tekstowe w dostarczonym węźle i ustawia zakres od początku początkowego węzła do znaku chars.count :

function createRange(node, chars, range) {
    if (!range) {
        range = document.createRange()
        range.selectNode(node);
        range.setStart(node, 0);
    }

    if (chars.count === 0) {
        range.setEnd(node, chars.count);
    } else if (node && chars.count >0) {
        if (node.nodeType === Node.TEXT_NODE) {
            if (node.textContent.length < chars.count) {
                chars.count -= node.textContent.length;
            } else {
                range.setEnd(node, chars.count);
                chars.count = 0;
            }
        } else {
           for (var lp = 0; lp < node.childNodes.length; lp++) {
                range = createRange(node.childNodes[lp], chars, range);

                if (chars.count === 0) {
                    break;
                }
            }
        }
    } 

    return range;
};

Następnie wywołuję procedurę za pomocą tej funkcji:

function setCurrentCursorPosition(chars) {
    if (chars >= 0) {
        var selection = window.getSelection();

        range = createRange(document.getElementById("test").parentNode, { count: chars });

        if (range) {
            range.collapse(false);
            selection.removeAllRanges();
            selection.addRange(range);
        }
    }
};

Range.collapse (false) ustawia kursor na końcu zakresu. Przetestowałem to z najnowszymi wersjami Chrome, IE, Mozilla i Opera i wszystkie one działają dobrze.

PS. Jeśli ktoś jest zainteresowany, uzyskuję aktualną pozycję kursora za pomocą tego kodu:

function isChildOf(node, parentId) {
    while (node !== null) {
        if (node.id === parentId) {
            return true;
        }
        node = node.parentNode;
    }

    return false;
};

function getCurrentCursorPosition(parentId) {
    var selection = window.getSelection(),
        charCount = -1,
        node;

    if (selection.focusNode) {
        if (isChildOf(selection.focusNode, parentId)) {
            node = selection.focusNode; 
            charCount = selection.focusOffset;

            while (node) {
                if (node.id === parentId) {
                    break;
                }

                if (node.previousSibling) {
                    node = node.previousSibling;
                    charCount += node.textContent.length;
                } else {
                     node = node.parentNode;
                     if (node === null) {
                         break
                     }
                }
           }
      }
   }

    return charCount;
};

Kod działa odwrotnie niż funkcja set - pobiera bieżące window.getSelection (). FocusNode i focusOffset i odlicza wstecz wszystkie napotkane znaki tekstowe, dopóki nie trafi do węzła nadrzędnego o identyfikatorze containerId. Funkcja isChildOf sprawdza przed uruchomieniem, że podany węzeł jest faktycznie dzieckiem podanego elementu parentId .

Kod powinien pracować prosto bez zmian, ale ja po prostu podjąć go z jQuery plugin Mam opracowaną więc włamał się kilka tego roku - daj mi znać, jeśli coś nie działa!

Liam
źródło
1
Czy możesz podać jsfiddle tej działającej aplikacji? Usiłuję dowiedzieć się, jak to działa, ponieważ nie jestem pewien, do czego node.idi parentIdnawiązuję bez przykładu. Dzięki :)
Bendihossan,
4
@Bendihossan - spróbuj tego jsfiddle.net/nrx9yvw9/5 - z jakiegoś powodu div edytowalny w treści w tym przykładzie dodaje kilka znaków i znak powrotu karetki na początku tekstu (może nawet sam jsfiddle robi to tak, jak robi ; t zrobić to samo na moim serwerze asp.net).
Liam,
@Bendihossan - elementy html w zadowalającym div dzielą się na strukturę drzewa z jednym węzłem dla każdego elementu html. Funkcja getCurrentCursorPosition pobiera bieżącą pozycję zaznaczenia i wraca w górę drzewa, licząc, ile jest znaków zwykłego tekstu. Node.id jest identyfikatorem elementu html, podczas gdy parentId odnosi się do identyfikatora elementu html, do którego powinien przestać się liczyć
Liam
1
Na mojej liście rzeczy do zrobienia jest napisanie tego, który jest całkowicie niezależny od mojego kodu interfejsu użytkownika - opublikuję go, gdy będę miał sekundę.
Liam,
1
Aby móc szybko przetestować różne rozwiązania, czy możesz edytować swoją odpowiedź na działające fragmenty kodu? Z góry dziękuję.
Basj
3

Jeśli nie chcesz używać jQuery, możesz wypróbować następujące podejście:

public setCaretPosition() {
    const editableDiv = document.getElementById('contenteditablediv');
    const lastLine = this.input.nativeElement.innerHTML.replace(/.*?(<br>)/g, '');
    const selection = window.getSelection();
    selection.collapse(editableDiv.childNodes[editableDiv.childNodes.length - 1], lastLine.length);
}

editableDivedytowalny element, nie zapomnij ustawić iddla niego elementu . Następnie musisz wyciągnąć innerHTMLz elementu i przeciąć wszystkie przewody hamulcowe. I po prostu ustaw zwinięcie z następnymi argumentami.

Wołodymyr Khmil
źródło
3
  const el = document.getElementById("editable");
  el.focus()
  let char = 1, sel; // character at which to place caret

  if (document.selection) {
    sel = document.selection.createRange();
    sel.moveStart('character', char);
    sel.select();
  }
  else {
    sel = window.getSelection();
    sel.collapse(el.lastChild, char);
  }
Sagar M.
źródło
3

function set_mouse() {
  var as = document.getElementById("editable");
  el = as.childNodes[1].childNodes[0]; //goal is to get ('we') id to write (object Text) because it work only in object text
  var range = document.createRange();
  var sel = window.getSelection();
  range.setStart(el, 1);
  range.collapse(true);
  sel.removeAllRanges();
  sel.addRange(range);

  document.getElementById("we").innerHTML = el; // see out put of we id
}
<div id="editable" contenteditable="true">dddddddddddddddddddddddddddd
  <p>dd</p>psss
  <p>dd</p>
  <p>dd</p>
  <p>text text text</p>
</div>
<p id='we'></p>
<button onclick="set_mouse()">focus</button>

Bardzo trudno jest ustawić karetkę w odpowiedniej pozycji, gdy masz element zaawansowany, taki jak (p) (rozpiętość) itp. Celem jest uzyskanie (tekst obiektu):

<div id="editable" contenteditable="true">dddddddddddddddddddddddddddd<p>dd</p>psss<p>dd</p>
    <p>dd</p>
    <p>text text text</p>
</div>
<p id='we'></p>
<button onclick="set_mouse()">focus</button>
<script>

    function set_mouse() {
        var as = document.getElementById("editable");
        el = as.childNodes[1].childNodes[0];//goal is to get ('we') id to write (object Text) because it work only in object text
        var range = document.createRange();
        var sel = window.getSelection();
        range.setStart(el, 1);
        range.collapse(true);
        sel.removeAllRanges();
        sel.addRange(range);

        document.getElementById("we").innerHTML = el;// see out put of we id
    }
</script>
Jalaluddin Rumi
źródło
1
Aby móc szybko przetestować swoją odpowiedź, czy możesz edytować swoją odpowiedź w postaci fragmentu kodu? Z góry dziękuję.
Basj
1

Piszę zakreślacz składni (i podstawowy edytor kodu) i musiałem wiedzieć, jak automatycznie wpisać pojedynczy znak cytatu i przesunąć kursor z powrotem (jak obecnie wiele edytorów kodu).

Oto fragment mojego rozwiązania, dzięki dużej pomocy z tego wątku, dokumentacji MDN i wielu możliwości oglądania konsoli Moz ..

//onKeyPress event

if (evt.key === "\"") {
    let sel = window.getSelection();
    let offset = sel.focusOffset;
    let focus = sel.focusNode;

    focus.textContent += "\""; //setting div's innerText directly creates new
    //nodes, which invalidate our selections, so we modify the focusNode directly

    let range = document.createRange();
    range.selectNode(focus);
    range.setStart(focus, offset);

    range.collapse(true);
    sel.removeAllRanges();
    sel.addRange(range);
}

//end onKeyPress event

Jest to w zadowalającym elemencie div

Zostawiam to tutaj jako podziękowanie, zdając sobie sprawę, że odpowiedź jest już zaakceptowana.

Jonathan Crowder
źródło
1

Zrobiłem to dla mojego prostego edytora tekstu.

Różnice w stosunku do innych metod:

  • Wysoka wydajność
  • Działa ze wszystkimi spacjami

stosowanie

// get current selection
const [start, end] = getSelectionOffset(container)

// change container html
container.innerHTML = newHtml

// restore selection
setSelectionOffset(container, start, end)

// use this instead innerText for get text with keep all spaces
const innerText = getInnerText(container)
const textBeforeCaret = innerText.substring(0, start)
const textAfterCaret = innerText.substring(start)

selection.ts

/** return true if node found */
function searchNode(
    container: Node,
    startNode: Node,
    predicate: (node: Node) => boolean,
    excludeSibling?: boolean,
): boolean {
    if (predicate(startNode as Text)) {
        return true
    }

    for (let i = 0, len = startNode.childNodes.length; i < len; i++) {
        if (searchNode(startNode, startNode.childNodes[i], predicate, true)) {
            return true
        }
    }

    if (!excludeSibling) {
        let parentNode = startNode
        while (parentNode && parentNode !== container) {
            let nextSibling = parentNode.nextSibling
            while (nextSibling) {
                if (searchNode(container, nextSibling, predicate, true)) {
                    return true
                }
                nextSibling = nextSibling.nextSibling
            }
            parentNode = parentNode.parentNode
        }
    }

    return false
}

function createRange(container: Node, start: number, end: number): Range {
    let startNode
    searchNode(container, container, node => {
        if (node.nodeType === Node.TEXT_NODE) {
            const dataLength = (node as Text).data.length
            if (start <= dataLength) {
                startNode = node
                return true
            }
            start -= dataLength
            end -= dataLength
            return false
        }
    })

    let endNode
    if (startNode) {
        searchNode(container, startNode, node => {
            if (node.nodeType === Node.TEXT_NODE) {
                const dataLength = (node as Text).data.length
                if (end <= dataLength) {
                    endNode = node
                    return true
                }
                end -= dataLength
                return false
            }
        })
    }

    const range = document.createRange()
    if (startNode) {
        if (start < startNode.data.length) {
            range.setStart(startNode, start)
        } else {
            range.setStartAfter(startNode)
        }
    } else {
        if (start === 0) {
            range.setStart(container, 0)
        } else {
            range.setStartAfter(container)
        }
    }

    if (endNode) {
        if (end < endNode.data.length) {
            range.setEnd(endNode, end)
        } else {
            range.setEndAfter(endNode)
        }
    } else {
        if (end === 0) {
            range.setEnd(container, 0)
        } else {
            range.setEndAfter(container)
        }
    }

    return range
}

export function setSelectionOffset(node: Node, start: number, end: number) {
    const range = createRange(node, start, end)
    const selection = window.getSelection()
    selection.removeAllRanges()
    selection.addRange(range)
}

function hasChild(container: Node, node: Node): boolean {
    while (node) {
        if (node === container) {
            return true
        }
        node = node.parentNode
    }

    return false
}

function getAbsoluteOffset(container: Node, offset: number) {
    if (container.nodeType === Node.TEXT_NODE) {
        return offset
    }

    let absoluteOffset = 0
    for (let i = 0, len = Math.min(container.childNodes.length, offset); i < len; i++) {
        const childNode = container.childNodes[i]
        searchNode(childNode, childNode, node => {
            if (node.nodeType === Node.TEXT_NODE) {
                absoluteOffset += (node as Text).data.length
            }
            return false
        })
    }

    return absoluteOffset
}

export function getSelectionOffset(container: Node): [number, number] {
    let start = 0
    let end = 0

    const selection = window.getSelection()
    for (let i = 0, len = selection.rangeCount; i < len; i++) {
        const range = selection.getRangeAt(i)
        if (range.intersectsNode(container)) {
            const startNode = range.startContainer
            searchNode(container, container, node => {
                if (startNode === node) {
                    start += getAbsoluteOffset(node, range.startOffset)
                    return true
                }

                const dataLength = node.nodeType === Node.TEXT_NODE
                    ? (node as Text).data.length
                    : 0

                start += dataLength
                end += dataLength

                return false
            })

            const endNode = range.endContainer
            searchNode(container, startNode, node => {
                if (endNode === node) {
                    end += getAbsoluteOffset(node, range.endOffset)
                    return true
                }

                const dataLength = node.nodeType === Node.TEXT_NODE
                    ? (node as Text).data.length
                    : 0

                end += dataLength

                return false
            })

            break
        }
    }

    return [start, end]
}

export function getInnerText(container: Node) {
    const buffer = []
    searchNode(container, container, node => {
        if (node.nodeType === Node.TEXT_NODE) {
            buffer.push((node as Text).data)
        }
        return false
    })
    return buffer.join('')
}
Nikolay Makhonin
źródło
1

Refaktoryzowałem odpowiedź @ Liama. Umieściłem go w klasie metodami statycznymi, sprawiłem, że jego funkcje otrzymały element zamiast #id i kilka innych drobnych poprawek.

Ten kod jest szczególnie dobry do ustawiania kursora w bogatym polu tekstowym, które możesz tworzyć <div contenteditable="true">. Utknąłem na tym przez kilka dni, zanim dotarłem do poniższego kodu.

edytuj: Jego odpowiedź i ta odpowiedź zawierają błąd związany z naciśnięciem klawisza Enter. Ponieważ Enter nie liczy się jako znak, pozycja kursora zostaje pomieszana po naciśnięciu Enter. Jeśli będę w stanie naprawić kod, zaktualizuję swoją odpowiedź.

edit2: Oszczędź sobie wielu bólów głowy i upewnij się, że <div contenteditable=true>tak display: inline-block. To naprawia niektóre błędy związane z wprowadzaniem Chrome <div>zamiast<br> po naciśnięciu Enter.

Jak używać

let richText = document.getElementById('rich-text');
let offset = Cursor.getCurrentCursorPosition(richText);
// do stuff to the innerHTML, such as adding/removing <span> tags
Cursor.setCurrentCursorPosition(offset, richText);
richText.focus();

Kod

// Credit to Liam (Stack Overflow)
// https://stackoverflow.com/a/41034697/3480193
class Cursor {
    static getCurrentCursorPosition(parentElement) {
        var selection = window.getSelection(),
            charCount = -1,
            node;
        
        if (selection.focusNode) {
            if (Cursor._isChildOf(selection.focusNode, parentElement)) {
                node = selection.focusNode; 
                charCount = selection.focusOffset;
                
                while (node) {
                    if (node === parentElement) {
                        break;
                    }

                    if (node.previousSibling) {
                        node = node.previousSibling;
                        charCount += node.textContent.length;
                    } else {
                        node = node.parentNode;
                        if (node === null) {
                            break;
                        }
                    }
                }
            }
        }
        
        return charCount;
    }
    
    static setCurrentCursorPosition(chars, element) {
        if (chars >= 0) {
            var selection = window.getSelection();
            
            let range = Cursor._createRange(element, { count: chars });

            if (range) {
                range.collapse(false);
                selection.removeAllRanges();
                selection.addRange(range);
            }
        }
    }
    
    static _createRange(node, chars, range) {
        if (!range) {
            range = document.createRange()
            range.selectNode(node);
            range.setStart(node, 0);
        }

        if (chars.count === 0) {
            range.setEnd(node, chars.count);
        } else if (node && chars.count >0) {
            if (node.nodeType === Node.TEXT_NODE) {
                if (node.textContent.length < chars.count) {
                    chars.count -= node.textContent.length;
                } else {
                    range.setEnd(node, chars.count);
                    chars.count = 0;
                }
            } else {
                for (var lp = 0; lp < node.childNodes.length; lp++) {
                    range = Cursor._createRange(node.childNodes[lp], chars, range);

                    if (chars.count === 0) {
                    break;
                    }
                }
            }
        } 

        return range;
    }
    
    static _isChildOf(node, parentElement) {
        while (node !== null) {
            if (node === parentElement) {
                return true;
            }
            node = node.parentNode;
        }

        return false;
    }
}
AdmiralThrawn
źródło
0

Myślę, że nie jest łatwo ustawić Caret na pewnej pozycji w zadowalającym elemencie. Napisałem do tego własny kod. Pomija drzewo węzłów, uspokajając liczbę znaków i ustawia karetkę w potrzebnym elemencie. Nie testowałem tego kodu zbyt wiele.

//Set offset in current contenteditable field (for start by default or for with forEnd=true)
function setCurSelectionOffset(offset, forEnd = false) {
    const sel = window.getSelection();
    if (sel.rangeCount !== 1 || !document.activeElement) return;

    const firstRange = sel.getRangeAt(0);

    if (offset > 0) {
        bypassChildNodes(document.activeElement, offset);
    }else{
        if (forEnd)
            firstRange.setEnd(document.activeElement, 0);
        else
            firstRange.setStart(document.activeElement, 0);
    }



    //Bypass in depth
    function bypassChildNodes(el, leftOffset) {
        const childNodes = el.childNodes;

        for (let i = 0; i < childNodes.length && leftOffset; i++) {
            const childNode = childNodes[i];

            if (childNode.nodeType === 3) {
                const curLen = childNode.textContent.length;

                if (curLen >= leftOffset) {
                    if (forEnd)
                        firstRange.setEnd(childNode, leftOffset);
                    else
                        firstRange.setStart(childNode, leftOffset);
                    return 0;
                }else{
                    leftOffset -= curLen;
                }
            }else
            if (childNode.nodeType === 1) {
                leftOffset = bypassChildNodes(childNode, leftOffset);
            }
        }

        return leftOffset;
    }
}

Napisałem również kod, aby uzyskać aktualną pozycję karetki (nie testowałem):

//Get offset in current contenteditable field (start offset by default or end offset with calcEnd=true)
function getCurSelectionOffset(calcEnd = false) {
    const sel = window.getSelection();
    if (sel.rangeCount !== 1 || !document.activeElement) return 0;

    const firstRange     = sel.getRangeAt(0),
          startContainer = calcEnd ? firstRange.endContainer : firstRange.startContainer,
          startOffset    = calcEnd ? firstRange.endOffset    : firstRange.startOffset;
    let needStop = false;

    return bypassChildNodes(document.activeElement);



    //Bypass in depth
    function bypassChildNodes(el) {
        const childNodes = el.childNodes;
        let ans = 0;

        if (el === startContainer) {
            if (startContainer.nodeType === 3) {
                ans = startOffset;
            }else
            if (startContainer.nodeType === 1) {
                for (let i = 0; i < startOffset; i++) {
                    const childNode = childNodes[i];

                    ans += childNode.nodeType === 3 ? childNode.textContent.length :
                           childNode.nodeType === 1 ? childNode.innerText.length :
                           0;
                }
            }

            needStop = true;
        }else{
            for (let i = 0; i < childNodes.length && !needStop; i++) {
                const childNode = childNodes[i];
                ans += bypassChildNodes(childNode);
            }
        }

        return ans;
    }
}

Trzeba także pamiętać, że range.startOffset i range.endOffset zawierają przesunięcie znaków dla węzłów tekstowych (nodeType === 3) i przesunięcie węzła potomnego dla węzłów elementu (nodeType === 1). range.startContainer i range.endContainer mogą odnosić się do dowolnego węzła elementu dowolnego poziomu w drzewie (oczywiście mogą również odnosić się do węzłów tekstowych).

vitaliydev
źródło
0

Na podstawie odpowiedzi Tim Down, ale sprawdza ostatni znany „dobry” wiersz tekstu. Umieszcza kursor na samym końcu.

Ponadto mogłem również rekursywnie / iteracyjnie sprawdzać ostatnie dziecko każdego kolejnego ostatniego dziecka, aby znaleźć absolutny ostatni „dobry” węzeł tekstowy w DOM.

function onClickHandler() {
  setCaret(document.getElementById("editable"));
}

function setCaret(el) {
  let range = document.createRange(),
      sel = window.getSelection(),
      lastKnownIndex = -1;
  for (let i = 0; i < el.childNodes.length; i++) {
    if (isTextNodeAndContentNoEmpty(el.childNodes[i])) {
      lastKnownIndex = i;
    }
  }
  if (lastKnownIndex === -1) {
    throw new Error('Could not find valid text content');
  }
  let row = el.childNodes[lastKnownIndex],
      col = row.textContent.length;
  range.setStart(row, col);
  range.collapse(true);
  sel.removeAllRanges();
  sel.addRange(range);
  el.focus();
}

function isTextNodeAndContentNoEmpty(node) {
  return node.nodeType == Node.TEXT_NODE && node.textContent.trim().length > 0
}
<div id="editable" contenteditable="true">
  text text text<br>text text text<br>text text text<br>
</div>
<button id="button" onclick="onClickHandler()">focus</button>

Pan Polywhirl
źródło