JavaScript получает данные буфера обмена при вставке события (кросс-браузер) - PullRequest
271 голосов
/ 01 февраля 2010

Как веб-приложение может обнаружить событие вставки и извлечь данные для вставки?

Я хотел бы удалить содержимое HTML, прежде чем текст будет вставлен в текстовый редактор.

Очистка текста после последующей вставки работает, но проблема в том, что все предыдущее форматирование потеряно. Например, я могу написать предложение в редакторе и сделать его жирным, но когда я вставляю новый текст, все форматирование теряется. Я хочу очистить только текст, который вставлен, и оставить любое предыдущее форматирование без изменений.

В идеале решение должно работать во всех современных браузерах (например, MSIE, Gecko, Chrome и Safari).

Обратите внимание, что MSIE имеет clipboardData.getData(), но я не смог найти аналогичные функции для других браузеров.

Ответы [ 20 ]

285 голосов
/ 24 июля 2011

Решение № 1 (только обычный текст и требуется Firefox 22+)

Работает для IE6 +, FF 22+, Chrome, Safari, Edge (Проверено только в IE9 +, но должно работать для более низких версий)

Если вам нужна поддержка для вставки HTML или Firefox <= 22, см. Решение № 2. </p>

HTML

<div id='editableDiv' contenteditable='true'>Paste</div>

JavaScript

function handlePaste (e) {
    var clipboardData, pastedData;

    // Stop data actually being pasted into div
    e.stopPropagation();
    e.preventDefault();

    // Get pasted data via clipboard API
    clipboardData = e.clipboardData || window.clipboardData;
    pastedData = clipboardData.getData('Text');

    // Do whatever with pasteddata
    alert(pastedData);
}

document.getElementById('editableDiv').addEventListener('paste', handlePaste);

JSFiddle: https://jsfiddle.net/swL8ftLs/12/

Обратите внимание, что это решение использует параметр «Текст» для функции getData, которая является нестандартной. Однако на момент написания он работает во всех браузерах.


Решение № 2 (HTML и работает для Firefox <= 22) </h1> Протестировано в IE6 +, FF 3.5+, Chrome, Safari, Edge HTML <div id='div' contenteditable='true'>Paste</div> JavaScript var editableDiv = document.getElementById('editableDiv'); function handlepaste (e) { var types, pastedData, savedContent; // Browsers that support the 'text/html' type in the Clipboard API (Chrome, Firefox 22+) if (e && e.clipboardData && e.clipboardData.types && e.clipboardData.getData) { // Check for 'text/html' in types list. See abligh's answer below for deatils on // why the DOMStringList bit is needed. We cannot fall back to 'text/plain' as // Safari/Edge don't advertise HTML data even if it is available types = e.clipboardData.types; if (((types instanceof DOMStringList) && types.contains("text/html")) || (types.indexOf && types.indexOf('text/html') !== -1)) { // Extract data and pass it to callback pastedData = e.clipboardData.getData('text/html'); processPaste(editableDiv, pastedData); // Stop the data from actually being pasted e.stopPropagation(); e.preventDefault(); return false; } } // Everything else: Move existing element contents to a DocumentFragment for safekeeping savedContent = document.createDocumentFragment(); while(editableDiv.childNodes.length > 0) { savedContent.appendChild(editableDiv.childNodes[0]); } // Then wait for browser to paste content into it and cleanup waitForPastedData(editableDiv, savedContent); return true; } function waitForPastedData (elem, savedContent) { // If data has been processes by browser, process it if (elem.childNodes && elem.childNodes.length > 0) { // Retrieve pasted content via innerHTML // (Alternatively loop through elem.childNodes or elem.getElementsByTagName here) var pastedData = elem.innerHTML; // Restore saved content elem.innerHTML = ""; elem.appendChild(savedContent); // Call callback processPaste(elem, pastedData); } // Else wait 20ms and try again else { setTimeout(function () { waitForPastedData(elem, savedContent) }, 20); } } function processPaste (elem, pastedData) { // Do whatever with gathered data; alert(pastedData); elem.focus(); } // Modern browsers. Note: 3rd argument is required for Firefox <= 6 if (editableDiv.addEventListener) { editableDiv.addEventListener('paste', handlepaste, false); } // IE <= 8 else { editableDiv.attachEvent('onpaste', handlepaste); } JSFiddle: https://jsfiddle.net/nicoburns/wrqmuabo/23/ Объяснение

К событию onpaste div присоединена функция handlePaste, которой передан единственный аргумент: объект event для события вставки. Особый интерес для нас представляет свойство clipboardData этого события, которое обеспечивает доступ к буферу обмена в не-браузерах. В IE эквивалент window.clipboardData, хотя у него немного другой API.

См. Раздел ресурсов ниже.


Функция handlepaste:

Эта функция имеет две ветви.

Первый проверяет наличие event.clipboardData и проверяет, содержит ли его свойство types текст / html (types может быть либо DOMStringList, который проверяется с использованием метода contains, либо строка, проверяемая методом indexOf). Если все эти условия выполнены, то мы поступаем так же, как в решении № 1, за исключением «text / html» вместо «text / plain». В настоящее время это работает в Chrome и Firefox 22+.

Если этот метод не поддерживается (все остальные браузеры), тогда мы

  1. Сохранить содержимое элемента в DocumentFragment
  2. Очистить элемент
  3. вызов функции waitForPastedData

Функция waitforpastedata:

Эта функция сначала запрашивает вставленные данные (один раз в 20 мс), что необходимо, поскольку они не отображаются сразу. Когда появились данные, это:

  1. Сохраняет innerHTML редактируемого div (который теперь является вставленными данными) в переменную
  2. Восстанавливает содержимое, сохраненное в DocumentFragment
  3. Вызывает функцию 'processPaste' с полученными данными

Функция processpaste:

Делает произвольные вещи с вставленными данными. В этом случае мы просто предупреждаем данные, вы можете делать все что угодно. Возможно, вы захотите запустить вставленные данные через какой-то процесс очистки данных.


Сохранение и восстановление позиции курсора

В реальной ситуации вы, вероятно, захотите сохранить выделение раньше, а затем восстановить его ( Установить позицию курсора на contentEditable

). Затем можно вставить вставленные данные в положение, в котором находился курсор, когда пользователь инициировал действие вставки.

Ресурсы:

Спасибо Тиму Дауну, предложившему использовать DocumentFragment и облегчившему обнаружение ошибки в Firefox вследствие использования DOMStringList вместо строки для clipboardData.types

140 голосов
/ 01 февраля 2010

С момента написания этого ответа ситуация изменилась: теперь, когда Firefox добавил поддержку в версии 22, все основные браузеры теперь поддерживают доступ к данным буфера обмена в событии вставки.См., Например, ответ Нико Бернса .

В прошлом это было невозможно в кросс-браузерном режиме.В идеале можно было бы получить вставленный контент с помощью события paste, , что возможно в недавних браузерах , но не в некоторых старых браузерах (в частности, Firefox <22). </p>

Когда вам требуется поддержка более старых браузеров, вы можете сделать это довольно сложно, и это поможет вам работать с браузерами Firefox 2+, IE 5.5+ и WebKit, такими как Safari или Chrome.Последние версии как TinyMCE, так и CKEditor используют эту технику:

  1. Обнаружение события ctrl-v / shift-ins с помощью обработчика события нажатия клавиши
  2. В этом обработчике сохраните текущий выбор пользователядобавьте к документу текстовый элемент вне экрана (скажем, слева - 1000 пикселей), выключите designMode и вызовите focus() для текстовой области, переместив каретку и эффективно перенаправив вставку
  3. . Установитеочень короткий таймер (скажем, 1 миллисекунда) в обработчике событий для вызова другой функции, которая сохраняет значение текстовой области, удаляет текстовую область из документа, снова включает designMode, восстанавливает выбор пользователя и вставляет текст в.

Обратите внимание, что это будет работать только для событий вставки с клавиатуры, а не вставок из контекстного меню или меню редактирования.К моменту запуска события вставки уже слишком поздно перенаправить курсор в текстовую область (по крайней мере, в некоторых браузерах).

В маловероятном случае, когда вам потребуется поддержка Firefox 2, обратите внимание, что вынеобходимо поместить текстовую область в родительский документ, а не документ iframe редактора WYSIWYG в этом браузере.

119 голосов
/ 09 октября 2013

Простая версия:

document.querySelector('[contenteditable]').addEventListener('paste', (e) => {
    e.preventDefault();
    const text = (e.originalEvent || e).clipboardData.getData('text/plain');
    window.document.execCommand('insertText', false, text);
});

Использование clipboardData

Демо: http://jsbin.com/nozifexasu/edit?js,output

Edge, Firefox, Chrome, Safari, Opera проверено.


Примечание: Не забудьте проверить ввод / вывод на на стороне сервера также (например, PHP strip-tags )

25 голосов
/ 15 февраля 2015

Демо-версия

Проверено на Chrome / FF / IE11

Существует раздражение Chrome / IE, которое заключается в том, что эти браузеры добавляют элемент <div> для каждой новой строки. Здесь есть сообщение об этом здесь , и это можно исправить, установив для элемента contenteditable значение display:inline-block

Выберите выделенный HTML-код и вставьте его здесь:

function onPaste(e){
  var content;
  e.preventDefault();

  if( e.clipboardData ){
    content = e.clipboardData.getData('text/plain');
    document.execCommand('insertText', false, content);
    return false;
  }
  else if( window.clipboardData ){
    content = window.clipboardData.getData('Text');
    if (window.getSelection)
      window.getSelection().getRangeAt(0).insertNode( document.createTextNode(content) );
  }
}


/////// EVENT BINDING /////////
document.querySelector('[contenteditable]').addEventListener('paste', onPaste);
[contenteditable]{ 
  /* chroem bug: https://stackoverflow.com/a/24689420/104380 */
  display:inline-block;
  width: calc(100% - 40px);
  min-height:120px; 
  margin:10px;
  padding:10px;
  border:1px dashed green;
}

/* 
 mark HTML inside the "contenteditable"  
 (Shouldn't be any OFC!)'
*/
[contenteditable] *{
  background-color:red;
}
<div contenteditable></div>
15 голосов
/ 11 мая 2012

Я написал небольшое доказательство концепции для предложения Тима Даунса здесь с текстовой областью за пределами экрана. И вот код:

<html>
<head>
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script> 
<script language="JavaScript">
 $(document).ready(function()
{

var ctrlDown = false;
var ctrlKey = 17, vKey = 86, cKey = 67;

$(document).keydown(function(e)
{
    if (e.keyCode == ctrlKey) ctrlDown = true;
}).keyup(function(e)
{
    if (e.keyCode == ctrlKey) ctrlDown = false;
});

$(".capture-paste").keydown(function(e)
{
    if (ctrlDown && (e.keyCode == vKey || e.keyCode == cKey)){
        $("#area").css("display","block");
        $("#area").focus();         
    }
});

$(".capture-paste").keyup(function(e)
{
    if (ctrlDown && (e.keyCode == vKey || e.keyCode == cKey)){                      
        $("#area").blur();
        //do your sanitation check or whatever stuff here
        $("#paste-output").text($("#area").val());
        $("#area").val("");
        $("#area").css("display","none");
    }
});

});
</script>

</head>
<body class="capture-paste">

<div id="paste-output"></div>


    <div>
    <textarea id="area" style="display: none; position: absolute; left: -99em;"></textarea>
    </div>

</body>
</html>

Просто скопируйте и вставьте весь код в один HTML-файл и попробуйте вставить (используя ctrl-v) текст из буфера обмена в любом месте документа.

Я тестировал его в IE9 и новых версиях Firefox, Chrome и Opera. Работает довольно хорошо. Также хорошо, что можно использовать любую комбинацию клавиш, которую он предпочитает, чтобы активировать эту функцию. Конечно, не забудьте включить источники jQuery.

Не стесняйтесь использовать этот код, и если у вас появятся какие-либо улучшения или проблемы, пожалуйста, отправьте их обратно. Также обратите внимание, что я не являюсь разработчиком Javascript, поэтому, возможно, я что-то пропустил (=> сделайте свой собственный тест).

10 голосов
/ 09 января 2014

На основе l2aelba anwser. Это было проверено на FF, Safari, Chrome, IE (8,9,10 и 11)

    $("#editText").on("paste", function (e) {
        e.preventDefault();

        var text;
        var clp = (e.originalEvent || e).clipboardData;
        if (clp === undefined || clp === null) {
            text = window.clipboardData.getData("text") || "";
            if (text !== "") {
                if (window.getSelection) {
                    var newNode = document.createElement("span");
                    newNode.innerHTML = text;
                    window.getSelection().getRangeAt(0).insertNode(newNode);
                } else {
                    document.selection.createRange().pasteHTML(text);
                }
            }
        } else {
            text = clp.getData('text/plain') || "";
            if (text !== "") {
                document.execCommand('insertText', false, text);
            }
        }
    });
9 голосов
/ 14 декабря 2012

Этот не использует setTimeout ().

Я использовал эту замечательную статью для поддержки кросс-браузерной поддержки.

$(document).on("focus", "input[type=text],textarea", function (e) {
    var t = e.target;
    if (!$(t).data("EventListenerSet")) {
        //get length of field before paste
        var keyup = function () {
            $(this).data("lastLength", $(this).val().length);
        };
        $(t).data("lastLength", $(t).val().length);
        //catch paste event
        var paste = function () {
            $(this).data("paste", 1);//Opera 11.11+
        };
        //process modified data, if paste occured
        var func = function () {
            if ($(this).data("paste")) {
                alert(this.value.substr($(this).data("lastLength")));
                $(this).data("paste", 0);
                this.value = this.value.substr(0, $(this).data("lastLength"));
                $(t).data("lastLength", $(t).val().length);
            }
        };
        if (window.addEventListener) {
            t.addEventListener('keyup', keyup, false);
            t.addEventListener('paste', paste, false);
            t.addEventListener('input', func, false);
        }
        else {//IE
            t.attachEvent('onkeyup', function () {
                keyup.call(t);
            });
            t.attachEvent('onpaste', function () {
                paste.call(t);
            });
            t.attachEvent('onpropertychange', function () {
                func.call(t);
            });
        }
        $(t).data("EventListenerSet", 1);
    }
}); 

Этот код дополнен дескриптором выбора перед вставкой: демо

5 голосов
/ 08 октября 2013

Для очистки вставленного текста и замены текущего выбранного текста вставленным текстом дело довольно тривиально:

<div id='div' contenteditable='true' onpaste='handlepaste(this, event)'>Paste</div>

JS:

function handlepaste(el, e) {
  document.execCommand('insertText', false, e.clipboardData.getData('text/plain'));
  e.preventDefault();
}
5 голосов
/ 16 декабря 2014

Это должно работать во всех браузерах, которые поддерживают событие onpaste и наблюдателя мутаций.

Это решение выходит за рамки получения только текста, фактически позволяет редактировать вставленный контент до его вставки в элемент.

Работает, используя contenteditable, событие onpaste (поддерживается всеми основными браузерами) и наблюдатели мутаций (поддерживается Chrome, Firefox и IE11 +)

шаг 1

Создание HTML-элемента с contenteditable

<div contenteditable="true" id="target_paste_element"></div>

шаг 2

В вашем коде Javascript добавьте следующее событие

document.getElementById("target_paste_element").addEventListener("paste", pasteEventVerifierEditor.bind(window, pasteCallBack), false);

Нам нужно связать pasteCallBack, поскольку наблюдатель мутации будет вызываться асинхронно.

шаг 3

Добавьте следующую функцию в ваш код

function pasteEventVerifierEditor(callback, e)
{
   //is fired on a paste event. 
    //pastes content into another contenteditable div, mutation observer observes this, content get pasted, dom tree is copied and can be referenced through call back.
    //create temp div
    //save the caret position.
    savedCaret = saveSelection(document.getElementById("target_paste_element"));

    var tempDiv = document.createElement("div");
    tempDiv.id = "id_tempDiv_paste_editor";
    //tempDiv.style.display = "none";
    document.body.appendChild(tempDiv);
    tempDiv.contentEditable = "true";

    tempDiv.focus();

    //we have to wait for the change to occur.
    //attach a mutation observer
    if (window['MutationObserver'])
    {
        //this is new functionality
        //observer is present in firefox/chrome and IE11
        // select the target node
        // create an observer instance
        tempDiv.observer = new MutationObserver(pasteMutationObserver.bind(window, callback));
        // configuration of the observer:
        var config = { attributes: false, childList: true, characterData: true, subtree: true };

        // pass in the target node, as well as the observer options
        tempDiv.observer.observe(tempDiv, config);

    }   

}



function pasteMutationObserver(callback)
{

    document.getElementById("id_tempDiv_paste_editor").observer.disconnect();
    delete document.getElementById("id_tempDiv_paste_editor").observer;

    if (callback)
    {
        //return the copied dom tree to the supplied callback.
        //copy to avoid closures.
        callback.apply(document.getElementById("id_tempDiv_paste_editor").cloneNode(true));
    }
    document.body.removeChild(document.getElementById("id_tempDiv_paste_editor"));

}

function pasteCallBack()
{
    //paste the content into the element.
    restoreSelection(document.getElementById("target_paste_element"), savedCaret);
    delete savedCaret;

    pasteHtmlAtCaret(this.innerHTML, false, true);
}   


saveSelection = function(containerEl) {
if (containerEl == document.activeElement)
{
    var range = window.getSelection().getRangeAt(0);
    var preSelectionRange = range.cloneRange();
    preSelectionRange.selectNodeContents(containerEl);
    preSelectionRange.setEnd(range.startContainer, range.startOffset);
    var start = preSelectionRange.toString().length;

    return {
        start: start,
        end: start + range.toString().length
    };
}
};

restoreSelection = function(containerEl, savedSel) {
    containerEl.focus();
    var charIndex = 0, range = document.createRange();
    range.setStart(containerEl, 0);
    range.collapse(true);
    var nodeStack = [containerEl], node, foundStart = false, stop = false;

    while (!stop && (node = nodeStack.pop())) {
        if (node.nodeType == 3) {
            var nextCharIndex = charIndex + node.length;
            if (!foundStart && savedSel.start >= charIndex && savedSel.start <= nextCharIndex) {
                range.setStart(node, savedSel.start - charIndex);
                foundStart = true;
            }
            if (foundStart && savedSel.end >= charIndex && savedSel.end <= nextCharIndex) {
                range.setEnd(node, savedSel.end - charIndex);
                stop = true;
            }
            charIndex = nextCharIndex;
        } else {
            var i = node.childNodes.length;
            while (i--) {
                nodeStack.push(node.childNodes[i]);
            }
        }
    }

    var sel = window.getSelection();
    sel.removeAllRanges();
    sel.addRange(range);
}

function pasteHtmlAtCaret(html, returnInNode, selectPastedContent) {
//function written by Tim Down

var sel, range;
if (window.getSelection) {
    // IE9 and non-IE
    sel = window.getSelection();
    if (sel.getRangeAt && sel.rangeCount) {
        range = sel.getRangeAt(0);
        range.deleteContents();

        // Range.createContextualFragment() would be useful here but is
        // only relatively recently standardized and is not supported in
        // some browsers (IE9, for one)
        var el = document.createElement("div");
        el.innerHTML = html;
        var frag = document.createDocumentFragment(), node, lastNode;
        while ( (node = el.firstChild) ) {
            lastNode = frag.appendChild(node);
        }
        var firstNode = frag.firstChild;
        range.insertNode(frag);

        // Preserve the selection
        if (lastNode) {
            range = range.cloneRange();
            if (returnInNode)
            {
                range.setStart(lastNode, 0); //this part is edited, set caret inside pasted node.
            }
            else
            {
                range.setStartAfter(lastNode); 
            }
            if (selectPastedContent) {
                range.setStartBefore(firstNode);
            } else {
                range.collapse(true);
            }
            sel.removeAllRanges();
            sel.addRange(range);
        }
    }
} else if ( (sel = document.selection) && sel.type != "Control") {
    // IE < 9
    var originalRange = sel.createRange();
    originalRange.collapse(true);
    sel.createRange().pasteHTML(html);
    if (selectPastedContent) {
        range = sel.createRange();
        range.setEndPoint("StartToStart", originalRange);
        range.select();
    }
}

}

Что делает код:

  1. Кто-то запускает событие вставки, используя ctrl-v, contextmenu или другие средства
  2. В событии вставки создается новый элемент с contenteditable (элемент с contenteditable имеет повышенные привилегии) ​​
  3. Положение каретки целевого элемента сохранено.
  4. Фокус установлен на новый элемент
  5. Содержимое вставляется в новый элемент и отображается в DOM.
  6. Наблюдатель мутаций улавливает это (регистрирует все изменения в дереве доменов и содержимом). Затем запускается событие мутации.
  7. Дом вставленного содержимого клонируется в переменную и возвращается к обратному вызову. Временный элемент уничтожен.
  8. Обратный вызов получает клонированный DOM. Каретка восстановлена. Вы можете изменить это, прежде чем добавить его к своей цели. элемент. В этом примере я использую функции Тима Даунса для сохранения / восстановления каретки и вставки HTML в элемент.

Большое спасибо Тим Даун Смотрите этот пост для ответа:

Получение вставленного содержимого документа при вставке события

4 голосов
/ 08 июля 2015

Это было слишком долго для комментария к ответу Нико, который, я думаю, больше не работает в Firefox (согласно комментариям), и не работал для меня в Safari как есть.

Во-первых, теперь вы можете читать прямо из буфера обмена. Вместо того, чтобы код как:

if (/text\/plain/.test(e.clipboardData.types)) {
    // shouldn't this be writing to elem.value for text/plain anyway?
    elem.innerHTML = e.clipboardData.getData('text/plain');
}

использование:

types = e.clipboardData.types;
if (((types instanceof DOMStringList) && types.contains("text/plain")) ||
    (/text\/plain/.test(types))) {
    // shouldn't this be writing to elem.value for text/plain anyway?
    elem.innerHTML = e.clipboardData.getData('text/plain');
}

потому что Firefox имеет поле types, которое является DOMStringList, которое не реализует test.

Далее Firefox не разрешит вставку, если фокус не находится в поле contenteditable=true.

Наконец, Firefox не позволит надежно вставить , если только фокус не находится на textarea (или, возможно, на входе), который не только contenteditable=true, но также:

  • не display:none
  • не visibility:hidden
  • не нулевого размера

Я пытался скрыть текстовое поле, чтобы можно было выполнить вставку через эмулятор JS VNC (т. Е. Он шел к удаленному клиенту, и на самом деле textarea и т. Д. Для вставки не было). Я обнаружил, что попытка скрыть текстовое поле в приведенном выше примере приводила к появлению симптомов, когда оно иногда срабатывало, но, как правило, не удавалось при второй вставке (или когда поле очищалось, чтобы предотвратить вставку одних и тех же данных дважды), поскольку поле теряло фокус и не восстанавливалось должным образом это несмотря на focus(). Решение, которое я придумал, состояло в том, чтобы поместить его в z-order: -1000, сделать display:none, сделать его размером 1 на 1 пиксель и установить все цвета на прозрачные. Тьфу.

В Safari к вам относится вторая часть вышеперечисленного, т. Е. Вам нужно иметь textarea, который не display:none.

...