Escape Quotes In HTML5 Data Attribute Using Javascript

Question

I'm using jQuery's .data() to work with custom HTML5 data attributes where the value of the attribute needs to be able to contain both single quotes and double quotes:

<p class="example" data-example="She said "WTF" on last night's show.">

I know using character codes like " in the data attribute value could make the above work, but I can't always control how the values are inputted. Plus, I need to be able to use HTML tags in the markup, like this:

<p class="example" data-example="
She said "<abbr title="What The F***">WTF</abbr>" on last night's show.
">

If some form of .replace() is the answer, then it needs to be done before the value is read by .data() —maybe by applying it across the entire <body> ?

Normal backslash escaping like <abbr title="te\'st">WTF</abbr> doesn't work either.

Ideally this would have the flexibility to work w/ both:

data-example="..." and data-example='...'

But if it's only possible one way then I could at least roll with that. Ideas?

Update - some more context:

I'm working on this for responsejs.com . An actual application of this might be to only load a sidebar for browsers above a certain width (and have this handled in the browser rather than PHP). In the case of WordPress for example, the sidebar could contain widgets, images, etc. The quotes within PHP tags are a non-issue b/c they are parsed into HTML before they get to the browser. Example:

<aside id="primary" class="sidebar" 

        data-oweb=' 

            <?php dynamic_sidebar( 'primary' ); ?>

        '
    >

    optional default markup for mobile and no-js browsers here

</aside>

Answer 1

There is no way around it, you have to escape the values properly, or the HTML can't be parsed properly. You can't use Javascript to correct the code after it is parsed, because then it has already failed.

Your example with proper HTML encoding would be:

<p class="example" data-example="She said &quot;&lt;abbr title=&quot;What The F***&quot;&gt;WTF&lt;/abbr&gt;&quot; on last night's show.">

You can't use backslash to escape characters, because it's not Javascript code. You use HTML entities to escape characters in HTML code.

If you can't control how the data is input, then you are screwed. You simply have to find a way to take control over it.

Answer 2

Use encodeURI to escape quotation marks in your JSON object. Parse the string with decodeURI.

 var popup = document.getElementById('popup'), msgObj = JSON.parse(decodeURI(popup.dataset.message)); console.log(msgObj);

 <a id="popup" href="#" data-message="%7B%22title%22:%22Print%22,%22message%22:%22Printing%20not%20yet%20implemented%22%7D" />

Answer 3

If they have to be HTML strings with " and ' and whatnot, why not just make separate HTML elements for them: http://jsfiddle.net/N7XXu/ .

Eg the HTML:

<p class="example" data-which="1">a</p>

<p class="example-data" data-which="1">She said "<abbr title="What The F***">WTF</abbr>" on last night's show.</p>

in combination with the following JavaScript:

$('.example').each(function() {
    var correspondingElem = $('.example-data[data-which="'
                              + $(this).data('which')
                              + '"]');
    $(this).data('example', correspondingElem.html());
});

alert($('.example').data('example'));

Of course, hide the .example-data elements.

Answer 4

Here is a simple tool I created you can use to encode html:

The trick is to escape it twice.

I added an additional \n replace to preserve multiline text since it gets discarded by text().

In addition you need to escape the quotes to make it safe for a data attribute.

<div id="esc"></div>
<textarea id="escinput" placeholder="Enter text"></textarea>
<script>
    $("#escinput").bind("change paste keyup", function(){
        $("#esc").text($(this).val().replace(/\n/g,'\\n'));
        $("#esc").text($("#esc").html().replace(/"/g, '&quot;'));
    });            
</script>

This should create a data attribute safe string.

You can test it here: http://jsfiddle.net/SplicePHP/n6HFq/

To decode it back to html simply use:

<script>
    var attr = $("#idOfElement").data('attribute');
    var decoded = $('<textarea/>').html(attr).val();
</script>

Answer 5

As I use the data attribute to transport some data together with the html element from PHP to the JavaScript, I just use base64_encode on the backend , then on the client side use base64Decode(input) to get the data back. This way I avoid any and all escaping orgy. The JavasScript code I use is located here http://www.webtoolkit.info/

Answer 6

For it to be proper html, you have to escape the troublesome characters. I'd escape them with HTML entities. This means that whatever tool is being used to input this information would have have to store them properly and/or the tool retrieving them on the back end would have to escape them.

Then if you want to use them in your JS, you'd have to run some find-and-replace functions to convert the characters back into HTML and quotes.

Most back-end dev languages have some sort of 'htmlescape/unescape' functionality, so that shouldn't be to hard.

To unescape it via jQuery, here's something found via a quick Google: http://www.naveen.com.au/javascript/jquery/encode-or-decode-html-entities-with-jquery/289

Answer 7

New to Stack Overflow so I don't have enough rep points to vote, but I wanted to clarify the solution as I misinterpreted the accepted answer by @Guffa that I was screwed.

I had a similar question regarding escape/special characters in HTML5 data-attributes. The question/solution: Escape/Special Characters from user input to HTML5 data-attributes using URL Encode/Decode

Dan Smith provided the solution I used with encodeURI()/decodeURI(). However, I dismissed it initially because it was so far down with only 1 rep points.

Any answers with manually escaping the characters become messy and time-consuming.

Any answers with escape() method are now deprecated. https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape

Answer 8

I like to store data in javascript directly. Instead of this:

<p class="example" data-oweb="<?=str_replace('\'', '\\\'', $var)?>">Content</p>
<script>
  var example = $('.example').data("example");
  DoSomething(example);
</script>

Do this:

<p class="example">Content</p>
<script>
  var example = '<?=str_replace('\'', '\\\'', $var)?>';
  DoSomething(example); 
</script>

Or if the usage is in a remote script you control, store the value(s) in a global:

<p class="example">Content</p>
<script>
  window.MyDataValues={};
  window.MyDataValues.Example = '<?=str_replace('\'', '\\\'', $var)?>';
</script>

Or if you can't control the remote script, and the info has to be stored as a data attribute you can set it with javascript after you figure out a way to target the paragraph:

<p id="example" data-oweb>Content</p>
<script>
    document.getElementById("example");
    element.dataset.oweb = '<?=str_replace('\'', '\\\'', $var)?>';
</script>

Answer 9

It is a little bit tricky but you can select dom objects with their data attributes that contains single quotes. The trick is \\'

<div id="text" data-message="Stanley Kubrick's Oranges">Hello</div>

<script>
    var message = "Stanley Kubrick\\'s Oranges";
    $("#text[data-message='"+message+"']").fadeOut("slow");
</script>

Fiddle

Answer 10

have you tried using single quotes for your data?

Like this:

<p class="example" data-example='She said "WTF" on last night's show.'>

Answer 11

As this answer suggestest, here is a possible solution:

 var popup = $('#placeholder'); popup.html(` <div data-message="${encodeURI("i could be what ever you need \' \" i will escape; ")}" > </div> `). console.log(decodeURI(popup.find('div');data("message")));

 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script> <div id="placeholder"> </div>

The key here is that:

wierdText = decodeURI(someText))

and:

someText = encodeURI(wierdText)

are reverse functions and can hold what ever string you need without causing it to be interpreted as html nor html attribut because it's used in inline href tag, it was made to do this job.

Answer 12

If you are using Lodash, then you can use _.escape() and _.unescape() . It converts the characters "&", "<", ">", '"', and "'" in string to their corresponding HTML entities.

Reference : https://lodash.com/docs/#escape

Answer 13

Use the btoa method to set the data and the atob method to get it:

 $(document).data("test2",btoa('She said "<abbr title="What The F***">WTF<\/abbr>" on last nights show.">'))

Or simply dereference the string as a variable:

 var stringer = 'She said "<abbr title="What The F***">WTF<\/abbr>" on last nights show.">'

 $(document).data("test2",stringer);

References

HTML5 Living Standard, Web application APIs: Base64 utility methods

Escape Quotes In HTML5 Data Attribute Using Javascript

Question

11 answers

solution1
36 ACCPTED 2011-08-31 17:34:26

solution2
7 2015-03-06 22:35:01

solution3
3 2011-08-31 16:53:48

solution4
2 2014-04-25 10:41:03

solution5
1

solution6
1 2011-08-31 16:25:48

solution7
0 2015-05-06 18:00:16

solution8
0 2015-12-22 08:36:42

solution9
0 2017-03-07 14:42:10

solution10
0 2022-07-15 09:42:06

solution11
0 2022-09-09 09:25:56

solution12
-1 2020-04-19 19:26:09

solution13
-2 2012-08-28 14:33:35

Escape Quotes In HTML5 Data Attribute Using Javascript

Question

11 answers

solution1 36 ACCPTED 2011-08-31 17:34:26

solution2 7 2015-03-06 22:35:01

solution3 3 2011-08-31 16:53:48

solution4 2 2014-04-25 10:41:03

solution5 1

solution6 1 2011-08-31 16:25:48

solution7 0 2015-05-06 18:00:16

solution8 0 2015-12-22 08:36:42

solution9 0 2017-03-07 14:42:10

solution10 0 2022-07-15 09:42:06

solution11 0 2022-09-09 09:25:56

solution12 -1 2020-04-19 19:26:09

solution13 -2 2012-08-28 14:33:35

solution1
36 ACCPTED 2011-08-31 17:34:26

solution2
7 2015-03-06 22:35:01

solution3
3 2011-08-31 16:53:48

solution4
2 2014-04-25 10:41:03

solution5
1

solution6
1 2011-08-31 16:25:48

solution7
0 2015-05-06 18:00:16

solution8
0 2015-12-22 08:36:42

solution9
0 2017-03-07 14:42:10

solution10
0 2022-07-15 09:42:06

solution11
0 2022-09-09 09:25:56

solution12
-1 2020-04-19 19:26:09

solution13
-2 2012-08-28 14:33:35