String.prototype.sub()

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The sub() method creates a <sub> HTML element that causes a string to be displayed as subscript.

Syntax

str.sub()

Return value

A string containing a <sub> HTML element.

Description

The sub() method embeds a string in a <sub> element: "<sub>str</sub>".

Examples

Using sub() and sup() methods

The following example uses the sub() and sup() methods to format a string:

var superText = 'superscript';
var subText = 'subscript';

console.log('This is what a ' + superText.sup() + ' looks like.');
// "This is what a <sup>superscript</sup> looks like."

console.log('This is what a ' + subText.sub() + ' looks like.');
// "This is what a <sub>subscript</sub> looks like."

Specifications

Specification
ECMAScript (ECMA-262)
The definition of 'String.prototype.sub' in that specification.

Browser compatibility

BCD tables only load in the browser

See also