Back to Content

HTMLTableElement: createCaption() method

files/en-us/web/api/htmltableelement/createcaption/index.md

latest1.3 KB
Original Source

{{APIRef("HTML DOM")}}

The HTMLTableElement.createCaption() method returns the {{HtmlElement("caption")}} element associated with a given {{HtmlElement("table")}}. If no <caption> element exists on the table, this method creates it, and then returns it.

[!NOTE] If no caption exists, createCaption() inserts a new caption directly into the table. The caption does not need to be added separately as would be the case if {{domxref("Document.createElement()")}} had been used to create the new <caption> element.

Syntax

js-nolint
createCaption()

Parameters

None.

Return value

{{domxref("HTMLTableCaptionElement")}}

Examples

This example uses JavaScript to add a caption to a table that initially lacks one.

HTML

html
<table>
  <tbody>
    <tr>
      <td>Cell 1.1</td>
      <td>Cell 1.2</td>
      <td>Cell 1.3</td>
    </tr>
    <tr>
      <td>Cell 2.1</td>
      <td>Cell 2.2</td>
      <td>Cell 2.3</td>
    </tr>
  </tbody>
</table>

JavaScript

js
let table = document.querySelector("table");
let caption = table.createCaption();
caption.textContent = "This caption was created by JavaScript!";

Result

{{EmbedLiveSample("Examples")}}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}