JavaScript - caretPositionFromPoint() method

revision:


Category : document

The caretPositionFromPoint() method of the Document interface returns a CaretPosition object, containing the DOM node, along with the caret and caret's character offset within that node.

Syntax :

        caretPositionFromPoint(x, y)
    

Parameters:

x : the horizontal coordinate of a point.

y : the vertical coordinate of a point.

Examples:

            
        

Practical examples

example: insert a line reak at the point where you click

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

code:
                    <div>
                        <p>
                            Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
                            eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
                            voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita
                            kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
                        </p>
                    </div>
                    <script>
                        function insertBreakAtPoint(e) {
                            let range;
                            let textNode;
                            let offset;
                            if (document.caretPositionFromPoint) {
                                range = document.caretPositionFromPoint(e.clientX, e.clientY);
                                textNode = range.offsetNode;
                                offset = range.offset;
                            } else if (document.caretRangeFromPoint) {
                                // Use WebKit-proprietary fallback method
                                range = document.caretRangeFromPoint(e.clientX, e.clientY);
                                textNode = range.startContainer;
                                offset = range.startOffset;
                            } else {
                                // Neither method is supported, do nothing
                                return;
                            }
                            // Only split TEXT_NODEs
                            if (textNode?.nodeType === 3) {
                                let replacement = textNode.splitText(offset);
                                let br = document.createElement("br");
                                textNode.parentNode.insertBefore(br, replacement);
                            }
                        }
            
                        let paragraphs = document.getElementsByTagName("p");
                        for (const paragraph of paragraphs) {
                            paragraph.addEventListener("click", insertBreakAtPoint, false);
                        }
                    
                    </script>