MDN self-hosted library · e01.org

String.prototype.sub()

The sub() method of String values creates a string that embeds this string in a sub element (<sub>str</sub>), which causes this string to be displayed as subscript.

Open notebook · 3 cells javascript-instance-method upstream source

The sub() method of String values creates a string that embeds this string in a sub element (<sub>str</sub>), which causes this string to be displayed as subscript.

[!NOTE] All HTML wrapper methods are deprecated and only standardized for compatibility purposes. Use DOM APIs such as document.createElement() instead.

Syntax

sub()

Parameters

None.

Return value

A string beginning with a <sub> start tag, then the text str, and then a </sub> end tag.

Examples

Using sub()

The code below creates an HTML string and then replaces the document's body with it:

const contentString = "Hello, world";

document.body.innerHTML = contentString.sub();

This will create the following HTML:

<sub>Hello, world</sub>

Instead of using sub() and creating HTML text directly, you should use DOM APIs such as document.createElement(). For example:

const contentString = "Hello, world";
const elem = document.createElement("sub");
elem.innerText = contentString;
document.body.appendChild(elem);

Specifications

Browser compatibility

See also