Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify what gets percent-encoded in data URLs #2856

Merged
merged 2 commits into from
Mar 8, 2021
Merged

Clarify what gets percent-encoded in data URLs #2856

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bb5b53
Push the “fixable flaws” button
sideshowbarker Mar 4, 2021
1fa4bd6
Clarify what gets percent-encoded in data URLs
sideshowbarker Mar 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions files/en-us/web/http/basics_of_http/data_uris/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@ <h2 id="Syntax">Syntax</h2>

<p>The <code>mediatype</code> is a <a href="/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types">MIME type</a> string, such as <code>'image/jpeg'</code> for a JPEG image file. If omitted, defaults to <code>text/plain;charset=US-ASCII</code></p>

<p>If the data is textual, you can embed the text (using the appropriate entities or escapes based on the enclosing document's type). Otherwise, you can specify <code>base64</code> to embed base64-encoded binary data. You can find more info on MIME types <a href="/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types">here</a> and <a href="/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types">here</a>.</p>
<p>If the data contains <a href="https://tools.ietf.org/html/rfc3986#section-2.2">characters defined in RFC 3986 as reserved characters</a>, or contains space characters, newline characters, or other non-printing characters, those characters must be <a href="/en-US/docs/Glossary/percent-encoding">percent-encoded</a> (<em>aka</em> “URL-encoded”).</p>

<p>If the data is textual, you can embed the text (using the appropriate entities or escapes based on the enclosing document's type). Otherwise, you can specify <code>base64</code> to embed base64-encoded binary data. You can find more info on MIME types <a href="/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types">here</a> and <a href="/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types">here</a>.</p>

<p>A few examples:</p>

<dl>
<dt><code>data:,Hello%2C%20World!</code></dt>
<dd>Simple text/plain data. Note the use of <a href="/en-US/docs/Glossary/percent-encoding">percent-encoding</a> (URL-encoding) for the quote and space characters. Also, for CSV data (MIME type "text/csv"), percent-encoding is needed to preserve the line endings that delimit rows of the spreadsheet.</dd>
<dd>The text/plain data <code>Hello, World!</code>. Note how the comma is <a href="/en-US/docs/Glossary/percent-encoding">percent-encoded</a> as <code>%2C</code>, and the space character as <code>%20</code>.</dd>
<dt><code>data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==</code></dt>
<dd>base64-encoded version of the above</dd>
<dt><code>data:text/html,%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E</code></dt>
Expand All @@ -46,7 +48,7 @@ <h2 id="Encoding_data_into_base64_format">Encoding data into base64 format</h2>

<h3 id="Encoding_in_Javascript">Encoding in Javascript</h3>

<p>The Web APIs have native methods to encode or decode to base64: <a href="/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding">Base64 encoding and decoding</a>.</p>
<p>The Web APIs have native methods to encode or decode to base64: <a href="/en-US/docs/Glossary/Base64">Base64 encoding and decoding</a>.</p>

<h3 id="Encoding_on_a_Unix_system">Encoding on a Unix system</h3>

Expand Down Expand Up @@ -128,10 +130,10 @@ <h2 id="Browser_compatibility">Browser compatibility</h2>
<h2 id="See_also">See also</h2>

<ul>
<li><a href="/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding">Base64 encoding and decoding</a></li>
<li><a href="/en-US/docs/Glossary/Base64">Base64 encoding and decoding</a></li>
<li><a href="/en-US/docs/Glossary/percent-encoding">Percent encoding</a></li>
<li>{{domxref("WindowBase64.atob","atob()")}}</li>
<li>{{domxref("WindowBase64.btoa","btoa()")}}</li>
<li><a href="/en-US/docs/Web/CSS/uri">CSS <code>url()</code></a></li>
<li>{{domxref("WindowOrWorkerGlobalScope/atob","atob()")}}</li>
<li>{{domxref("WindowOrWorkerGlobalScope/btoa","btoa()")}}</li>
<li><a href="/en-US/docs/Web/CSS/url()">CSS <code>url()</code></a></li>
<li><a href="/en-US/docs/Glossary/URI">URI</a></li>
</ul>