JS 鼠標框選（頁面選擇）時返回對應的 HTML 或文本內容

S 鼠標框選（頁面選擇）時返回對應的 HTML 或文案內容

一、需求背景

1、項目需求

當用戶進行鼠標框選選擇了頁面上的內容時，把選擇的內容進行上報。

2、需求解析

雖然這需求就一句話的事，但是很顯然，沒那么簡單...

因為鼠標框選說起來簡單，就是選擇的內容，但是這包含很多中情況，比如：只選擇文案、選擇圖片、選擇輸入框、輸入框中的內容選擇、iframe、等。

簡單總結，分為以下幾點：

選擇文案時
選擇圖片、svg、iframe、video、audio 等標簽時
選擇 input、select、textarea 等標簽時
選擇 input、textarea 標簽內容時
選擇類似字符時
鍵盤全選時
鼠標右鍵選擇
以上各模塊結合時
當包含標簽的時候，返回 html 結構，只有文本時返回文本內容

二、技術要點

鼠標框選包含以下幾點：

debounce 防抖
addEventListener 事件監聽
Range 對象
Selection 對象

1、debounce

老生常談的技術點了，這里不能用節流，因為肯定不能你鼠標選擇的時候，隔一段時間返回一段內容，肯定是選擇之后一起返回。

這里用 debounce 主要也是用在事件監聽和事件處理上。

【debounce 掘金】
【debounce CSDN】

2、addEventListener

事件監聽，因為鼠標選擇，不僅僅是鼠標按下到鼠標抬起，還包括雙擊、右鍵、全選。

需要使用事件監聽對事件作處理。

【addEventListener MDN】

3、Range

Range 接口表示一個包含節點與文本節點的一部分的文檔片段。

Range 是瀏覽器原生的對象。

3.1. 創建 Range 實例，并設置起始位置

<body>
  <ul>
    <li>Vite</li>
    <li>Vue</li>
    <li>React</li>
    <li>VitePress</li>
    <li>NaiveUI</li>
  </ul>
</body>
<script>
  // 創建 Range 對象
  const range = new Range()
  const liDoms = document.querySelectorAll("li");
  // Range 起始位置在 li 2
  range.setStartBefore(liDoms[1]);
  // Range 結束位置在 li 3
  range.setEndAfter(liDoms[2]);
  // 獲取 selection 對象
  const selection = window.getSelection();
  // 添加光標選擇的范圍
  selection.addRange(range);
</script>

可以看到，選擇內容為第二行和第三行

3.1.1 瀏覽器兼容情況

3.2. Range 屬性

startContainer：起始節點。
startOffset：起始節點偏移量。
endContainer：結束節點。
endOffset：結束節點偏移量。
collapsed：范圍的開始和結束是否為同一點。
commonAncestorContainer：返回完整包含 startContainer 和 endContainer 的最深一級的節點。

3.2.1. 用我們上面創建的實例來看下 range 屬性的值

3.2.2. 如果我們只選擇文本內容時

只選擇 li 中的 itePres

可以看出 range 屬性對應的值

3.3. Range 方法

cloneContents()：復制范圍內容，并將復制的內容作為 DocumentFragment 返回。
cloneRange()：創建一個具有相同起點/終點的新范圍，非引用，可以隨意改變，不會影響另一方。
collapse(toStart)：如果 toStart=true 則設置 end=start，否則設置 start=end，從而折疊范圍。
compareBoundaryPoints(how, sourceRange)：兩個范圍邊界點進行比較，返回一個數字 -1、0、1。
comparePoint(referenceNode, offset)：返回-1、0、1具體取決于是 referenceNode 在之前、相同還是之后。
createContextualFragment(tagString)：返回一個 DocumentFragment。
deleteContents()：刪除框選的內容。
extractContents()：從文檔中刪除范圍內容，并將刪除的內容作為 DocumentFragment 返回。
getBoundingClientRect()：和 dom 一樣，返回 DOMRect 對象。
getClientRects()：返回可迭代的對象序列 DOMRect。
insertNode(node)：在范圍的起始處將 node 插入文檔。
intersectsNode(referenceNode)：判斷與給定的 node 是否相交。
selectNode(node)：設置范圍以選擇整個 node。
selectNodeContents(node)：設置范圍以選擇整個 node 的內容。
setStart(startNode, startOffset)：設置起點。
setEnd(endNode, endOffset)：設置終點。
setStartBefore(node)：將起點設置在 node 前面。
setStartAfter(node)：將起點設置在 node 后面。
setEndBefore(node)：將終點設置為 node 前面。
setEndAfter(node)：將終點設置為 node 后面。
surroundContents(node)：使用 node 將所選范圍內容包裹起來。

3.4. 創建 Range 的方法

3.4.1. Document.createRange

const range = document.createRange();

3.4.2. Selection 的 getRangeAt() 方法

const range = window.getSelection().getRangeAt(0)

3.4.3. caretRangeFromPoint() 方法

if (document.caretRangeFromPoint) {
    range = document.caretRangeFromPoint(e.clientX, e.clientY);
}

3.4.4. Range() 構造函數

const range = new Range()

3.5. Range 兼容性

4、Selection

Selection 對象表示用戶選擇的文本范圍或插入符號的當前位置。它代表頁面中的文本選區，可能橫跨多個元素。

4.1. 獲取文本對象

window.getSelection()

4.2. Selection 術語

4.2.1. 錨點 (anchor)

錨指的是一個選區的起始點（不同于 HTML 中的錨點鏈接）。當我們使用鼠標框選一個區域的時候，錨點就是我們鼠標按下瞬間的那個點。在用戶拖動鼠標時，錨點是不會變的。

4.2.2. 焦點 (focus)

選區的焦點是該選區的終點，當你用鼠標框選一個選區的時候，焦點是你的鼠標松開瞬間所記錄的那個點。隨著用戶拖動鼠標，焦點的位置會隨著改變。

4.2.3. 范圍 (range)

范圍指的是文檔中連續的一部分。一個范圍包括整個節點，也可以包含節點的一部分，例如文本節點的一部分。用戶通常下只能選擇一個范圍，但是有的時候用戶也有可能選擇多個范圍。

4.2.4. 可編輯元素 (editing host)

一個用戶可編輯的元素（例如一個使用 contenteditable 的 HTML 元素，或是在啟用了 designMode 的 Document 的子元素）。

4.3. Selection 的屬性

首先要清楚，選擇的起點稱為錨點(anchor)，終點稱為焦點(focus)。

anchorNode：選擇的起始節點。
anchorOffset：選擇開始的 anchorNode 中的偏移量。
focusNode：選擇的結束節點。
focusOffset：選擇開始處 focusNode 的偏移量。
isCollapsed：如果未選擇任何內容（空范圍）或不存在，則為 true。
rangeCount：選擇中的范圍數，之前說過，除 Firefox 外，其他瀏覽器最多為1。
type：類型：None、Caret、Range

4.4. Selection 方法

addRange(range): 將一個 Range 對象添加到當前選區。
collapse(node, offset): 將選區折疊到指定的節點和偏移位置。
collapseToEnd(): 將選區折疊到當前選區的末尾。
collapseToStart(): 將選區折疊到當前選區的起始位置。
containsNode(node, partlyContained): 判斷選區是否包含指定的節點，可以選擇是否部分包含。
deleteFromDocument(): 從文檔中刪除選區內容。
empty(): 從選區中移除所有范圍（同 `removeAllRanges()``，已廢棄）。
extend(node, offset): 將選區的焦點節點擴展到指定的節點和偏移位置。
getRangeAt(index): 返回選區中指定索引處的 Range 對象。
removeAllRanges(): 移除所有選區中的范圍。
removeRange(range): 從選區中移除指定的 Range 對象。
selectAllChildren(node): 選中指定節點的所有子節點。
setBaseAndExtent(anchorNode, anchorOffset, focusNode, focusOffset): 設置選區的起始和結束節點及偏移位置。
setPosition(node, offset)：collapse 的別名

4.5. Selection 兼容性

三、項目實現

1、實現思路

先獲取選擇的內容，開發 getSelectContent 函數
對獲取的內容進行判斷，是否存在 selection 實例，沒有直接返回 null
判斷 selection 實例的 isCollapsed 屬性沒有選中，對 selection 進行 toString().trim() 操作，判斷內容有內容，直接返回 text 類型無內容，返回 null 有選中，則判斷內容
判斷選中的內容有沒有節點沒有節點，則和沒有選中一樣處理，進行 toString().trim() 操作，判斷內容有內容，直接返回 text 類型無內容，返回 null 有節點，進行 toString().trim() 操作，判斷內容沒有內容，判斷是否有特殊節點有 'iframe', 'svg', 'img', 'audio', 'video' 節點，返回 html 類型有 'input', 'textarea', 'select'，判斷 value 值，是否存在存在：返回 html 類型不存在：返回 null 沒有特殊節點，返回 null 有內容，返回 html 類型
對鼠標 mousedown、mouseup 事件和 selectionchange、contextmenu、dblclick 事件進行監聽，觸發 getSelectContent 函數
在需要的地方進行 debounce 防抖處理

2、簡易流程圖

2、Debounce 方法實現

2.1. JS

function debounce (fn, time = 500) {
  let timeout = null; // 創建一個標記用來存放定時器的返回值
  return function () {
    clearTimeout(timeout) // 每當觸發時，把前一個 定時器 clear 掉
    timeout = setTimeout(() => { // 創建一個新的 定時器，并賦值給 timeout
      fn.apply(this, arguments)
    }, time)
  }
}

2.2. TS

/**
 * debounce 函數類型
 */
type DebouncedFunction<F extends (...args: any[]) => any> = (...args: Parameters<F>) => void
/**
 * debounce 防抖函數
 * @param {Function} func 函數
 * @param {number} wait 等待時間
 * @param {false} immediate 是否立即執行
 * @returns {DebouncedFunction}
 */
function debounce<F extends (...args: any[]) => any>(
  func: F,
  wait = 500,
  immediate = false
): DebouncedFunction<F> {
  let timeout: ReturnType<typeof setTimeout> | null
  return function (this: ThisParameterType<F>, ...args: Parameters<F>) {
    // eslint-disable-next-line @typescript-eslint/no-this-alias
    const context = this
    const later = function () {
      timeout = null
      if (!immediate) {
        func.apply(context, args)
      }
    }
    const callNow = immediate && !timeout
    if (timeout) {
      clearTimeout(timeout)
    }
    timeout = setTimeout(later, wait)
    if (callNow) {
      func.apply(context, args)
    }
  }
}

3、獲取選擇的文本/html 元素

3.1. 獲取文本/html 元素

nterface IGetSelectContentProps {
  type: 'html' | 'text'
  content: string
}
/**
 * 獲取選擇的內容
 * @returns {null | IGetSelectContentProps} 返回選擇的內容
 */
const getSelectContent = (): null | IGetSelectContentProps => {
  const selection = window.getSelection()
  if (selection) {
    // 1. 是焦點在 input 輸入框
    // 2. 沒有選中
    // 3. 選擇的是輸入框
    if (selection.isCollapsed) {
      return selection.toString().trim().length
        ? {
            type: 'text',
            content: selection.toString().trim()
          }
        : null
    }
    // 獲取選擇范圍
    const range = selection.getRangeAt(0)
    // 獲取選擇內容
    const rangeClone = range.cloneContents()
    // 判斷選擇內容里面有沒有節點
    if (rangeClone.childElementCount > 0) {
      // 創建 div 標簽
      const container = document.createElement('div')
      // div 標簽 append 復制節點
      container.appendChild(rangeClone)
      // 如果復制的內容長度為 0
      if (!selection.toString().trim().length) {
        // 判斷是否有選擇特殊節點
        const isSpNode = hasSpNode(container)
        return isSpNode
          ? {
              type: 'html',
              content: container.innerHTML
            }
          : null
      }
      return {
        type: 'html',
        content: container.innerHTML
      }
    } else {
      return selection.toString().trim().length
        ? {
            type: 'text',
            content: selection.toString().trim()
          }
        : null
    }
  } else {
    return null
  }
}
/**
 * 判斷是否包含特殊元素
 * @param {Element} parent 父元素
 * @returns {boolean} 是否包含特殊元素
 */
const hasSpNode = (parent: Element): boolean => {
  const nodeNameList = ['iframe', 'svg', 'img', 'audio', 'video']
  const inpList = ['input', 'textarea', 'select']
  return Array.from(parent.children).some((node) => {
    if (nodeNameList.includes(node.nodeName.toLocaleLowerCase())) return true
    if (
      inpList.includes(node.nodeName.toLocaleLowerCase()) &&
      (node as HTMLInputElement).value.trim().length
    )
      return true
    if (node.children) {
      return hasSpNode(node)
    }
    return false
  })
}

3.2. 只需要文本

/**
 * 獲取框選的文案內容
 * @returns {string} 返回框選的內容
 */
const getSelectTextContent = (): string => {
  const selection = window.getSelection()
  return selection?.toString().trim() || ''
}

4、添加事件監聽

// 是否時鼠標點擊動作
let selectionchangeMouseTrack: boolean = false
const selectionChangeFun = debounce(() => {
  const selectContent = getSelectContent()
  console.log('selectContent', selectContent)
  // todo... 處理上報
  selectionchangeMouseTrack = false
})
// 添加 mousedown 監聽事件
document.addEventListener('mousedown', () => {
  selectionchangeMouseTrack = true
})
// 添加 mouseup 監聽事件
document.addEventListener(
  'mouseup',
  debounce(() => {
    selectionChangeFun()
  }, 100)
)
// 添加 selectionchange 監聽事件
document.addEventListener(
  'selectionchange',
  debounce(() => {
    if (selectionchangeMouseTrack) return
    selectionChangeFun()
  })
)
// 添加 dblclick 監聽事件
document.addEventListener('dblclick', () => {
  selectionChangeFun()
})
// 添加 contextmenu 監聽事件
document.addEventListener(
  'contextmenu',
  debounce(() => {
    selectionChangeFun()
  })
)

也可以進行封裝

/**
 * addEventlistener function 類型
 */
export interface IEventHandlerProps {
  [eventName: string]: EventListenerOrEventListenerObject
}

let selectionchangeMouseTrack: boolean = false
const eventHandlers: IEventHandlerProps = {
  // 鼠標 down 事件
  mousedown: () => {
    selectionchangeMouseTrack = true
  },
  // 鼠標 up 事件
  mouseup: debounce(() => selectionChangeFun(), 100),
  // 選擇事件
  selectionchange:  debounce(() => {
    if (selectionchangeMouseTrack) return
    selectionChangeFun()
  }),
  // 雙擊事件
  dblclick: () => selectionChangeFun(),
  // 右鍵事件
  contextmenu: debounce(() => selectionChangeFun())
}
Object.keys(eventHandlers).forEach((event) => {
  document.addEventListener(event, eventHandlers[event])
})

5、返回內容

5.1. 純文本內容

5.2. html 格式

6. 完整 JS 代碼

function debounce (fn, time = 500) {
  let timeout = null; // 創建一個標記用來存放定時器的返回值
  return function () {
    clearTimeout(timeout) // 每當觸發時，把前一個 定時器 clear 掉
    timeout = setTimeout(() => { // 創建一個新的 定時器，并賦值給 timeout
      fn.apply(this, arguments)
    }, time)
  }
}

let selectionchangeMouseTrack = false
document.addEventListener('mousedown', (e) => {
  selectionchangeMouseTrack = true
  console.log('mousedown', e)
})
document.addEventListener('mouseup', debounce((e) => {
  console.log('mouseup', e)
  selectionChangeFun()
}, 100))
document.addEventListener('selectionchange', debounce((e) => {
  console.log('selectionchange', e)
  if (selectionchangeMouseTrack) return
  selectionChangeFun()
}))
document.addEventListener('dblclick', (e) => {
  console.log('dblclick', e)
  selectionChangeFun()
})
document.addEventListener('contextmenu',debounce(() => {
  selectionChangeFun()
}))

const selectionChangeFun = debounce(() => {
  const selectContent = getSelectContent()
  selectionchangeMouseTrack = false
  console.log('selectContent', selectContent)
})

const getSelectContent = () => {
  const selection = window.getSelection();
  if (selection) {
    // 1. 是焦點在 input 輸入框
    // 2. 沒有選中
    // 3. 選擇的是輸入框
    if (selection.isCollapsed) {
      return selection.toString().trim().length ? {
        type: 'text',
        content: selection.toString().trim()
      } : null
    }
    // 獲取選擇范圍
    const range = selection.getRangeAt(0);
    // 獲取選擇內容
    const rangeClone = range.cloneContents()
    // 判斷選擇內容里面有沒有節點
    if (rangeClone.childElementCount > 0) {
      const container = document.createElement('div');
      container.appendChild(rangeClone);
      if (!selection.toString().trim().length) {
        const hasSpNode = getSpNode(container)
        return hasSpNode ? {
          type: 'html',
          content: container.innerHTML
        } : null
      }
      return {
        type: 'html',
        content: container.innerHTML
      }
    } else {
      return selection.toString().trim().length ? {
        type: 'text',
        content: selection.toString().trim()
      } : null
    }
  } else {
    return null
  }
}

const getSpNode = (parent) => {
  const nodeNameList = ['iframe', 'svg', 'img', 'audio', 'video']
  const inpList = ['input', 'textarea', 'select']
  return Array.from(parent.children).some((node) => {
    if (nodeNameList.includes(node.nodeName.toLocaleLowerCase())) return true
    if (inpList.includes(node.nodeName.toLocaleLowerCase()) && node.value.trim().length) return true
    if (node.children) {
      return getSpNode(node)
    }
    return false
  })
}

四、總結

鼠標框選上報能監控用戶在頁面的行為，能為后續的數據分析等提供便利
基于 JS 中的 Selection 和 Range 實現的，使用原生 JS
涉及到的操作比較多，包含鍵盤、鼠標右鍵、全選等
能對框選的內容進行分類，區別 html 和 text，更方便的看出用戶選擇了哪些內容

易拖拽

<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8">
<title>無標題文檔</title>
<style>
#div1 {width:200px; height:200px; background:red; position:absolute;}
</style>
<script>
window.onload=function ()
{
var oDiv=document.getElementById('div1');

var disX=0;
var disY=0;

oDiv.onmousedown=function (ev)
{
var oEvent=ev||event;

disX=oEvent.clientX-oDiv.offsetLeft; //拖拽距離
disY=oEvent.clientY-oDiv.offsetTop; //拖拽距離

oDiv.onmousemove=function (ev)
{
var oEvent=ev||event;

oDiv.style.left=oEvent.clientX-disX+'px';
oDiv.style.top=oEvent.clientY-disY+'px';
};

oDiv.onmouseup=function ()
{
oDiv.onmousemove=null;
oDiv.onmouseup=null;
};
};
};
</script>
</head>
<body>
<div id="div1"></div>
</body>
</html>

程序問題:鼠標拖拽過快,鼠標指針與拖拽div對象脫離

解決方法:直接給document加事件(因為div對象范圍太小,鼠標移動就與拖拽div對象脫離)

將oDiv改成document對象

<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8">
<title>無標題文檔</title>
<style>
#div1 {width:200px; height:200px; background:red; position:absolute;}
</style>
<script>
window.onload=function ()
{
var oDiv=document.getElementById('div1');

var disX=0;
var disY=0;

oDiv.onmousedown=function (ev)
{
var oEvent=ev||event;

disX=oEvent.clientX-oDiv.offsetLeft;
disY=oEvent.clientY-oDiv.offsetTop;

document.onmousemove=function (ev)
{
var oEvent=ev||event;

oDiv.style.left=oEvent.clientX-disX+'px';
oDiv.style.top=oEvent.clientY-disY+'px';
};

document.onmouseup=function ()
{
document.onmousemove=null;
document.onmouseup=null;
};
};
};
</script>
</head>
<body>
<div id="div1"></div>
</body>
</html>

程序問題: FF下，空Div拖拽Bug(殘影)

解決方法: 阻止默認事件

<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8">
<title>無標題文檔</title>
<style>
#div1 {width:200px; height:200px; background:red; position:absolute;}
</style>
<script>
window.onload=function ()
{
var oDiv=document.getElementById('div1');

var disX=0;
var disY=0;

oDiv.onmousedown=function (ev)
{
var oEvent=ev||event;

disX=oEvent.clientX-oDiv.offsetLeft;
disY=oEvent.clientY-oDiv.offsetTop;

document.onmousemove=function (ev)
{
var oEvent=ev||event;

oDiv.style.left=oEvent.clientX-disX+'px';
oDiv.style.top=oEvent.clientY-disY+'px';
};

document.onmouseup=function ()
{
document.onmousemove=null;
document.onmouseup=null;
};

return false; //阻止默認事件(拖動殘影)
};
};
</script>
</head>
<body>
<div id="div1"></div>
</body>
</html>

防止拖出頁面

輪事件是不同瀏覽器會有一點點區別，一個像Firefox使用DOMMouseScroll ,ff也可以使用addEventListener方法綁定DomMouseScroll事件，其他的瀏覽器滾輪事件使用mousewheel，下面我來給大家具體介紹。

Firefox使用DOMMouseScroll，其他的瀏覽器使用mousewheel。滾動事件觸發時Firefox使用detail屬性捕捉滾輪信息，其他的瀏覽器使用wheelDelta。不知道為何在該問題上其他廠商和微軟的如此一致。Firefox可以使用addEventListener方法綁定DomMouseScroll事件。

elem.addEventListener(‘DOMMouseScroll’, func, false);IE和其他的主流瀏覽器可以使用傳統的事件綁定模型。但不要使用IE專有的attachEvent方法，其他主流瀏覽器并不識別微軟的這個方法。

Firefox 鼠標滾輪向上滾動是-3，向下滾動是3

IE 鼠標滾輪向上滾動是120，向下滾動是-120

Safari 鼠標滾輪向上滾動是360，向下滾動是-360

Opera 鼠標滾輪向上滾動是120，向下滾動是-120

Chrome 鼠標滾輪向上滾動是120，向下滾動是-120

有人在Safari下做了一些測試：”只是滾動一圈的話，值為+-0.1，如果滾動地稍微快點的話（多滾動幾圈），這個值也會變大。這是因為Mac OS下有鼠標滾輪加速功能。滾動一次，瀏覽器滾動1像素，滾動3次，瀏覽器卻滾動30像素”。同時他也對Camino（基于Gecko的內核引擎）進行研究：“與Safari相似（+- 0.3 to +-Infinity），雖然使用了與firefox相同的內核引擎，但結果這個delta值卻只在+-2.666666里浮動，無論滾動速度如何

IE/Opera屬于同一類型，使用attachEvent即可添加滾輪事件。

/*IE注冊事件*/ 
if(document.attachEvent){ 
 document.attachEvent('onmousewheel',scrollFunc); 
}

Firefox使用addEventListener添加滾輪事件

/*Firefox注冊事件*/ 
if(document.addEventListener){ 
 document.addEventListener('DOMMouseScroll',scrollFunc,false); 
}

Safari與Chrome屬于同一類型，可使用HTML DOM方式添加事件

window.onmousewheel=document.onmousewheel=scrollFunc;//IE/Opera/Chrome

其中除Firefox外其余均可使用HTML DOM方式添加事件，因此添加事件使用以下方式

/*注冊事件*/ 
if(document.addEventListener){ 
 document.addEventListener('DOMMouseScroll',scrollFunc,false); 
}//W3C 
window.onmousewheel=document.onmousewheel=scrollFunc;//IE/Opera/Chromex

下面兩個參數可以獲取滾動的位置

document.documentElement.scrollTop：垂直方向

document.documentElement.scrollLeft：水平方向

放入監聽事件后就可以在鼠標滑輪滾動時給一些元素設置浮動樣式

如頭條號的發表文章界面:

下滑前

下滑后

在線咨詢

上一篇：css3滾動條樣式及美化方法
下一篇：11款流行的HTML5網站模板（完全免費，內附下載地址）

您的項目需求

*請認真填寫需求信息，我們會在24小時內與您取得聯系。

整合營銷服務商