# Caption

The HTML `<caption>` tag, implemented in Ruby.

## Parameters

This component can handle various optional configuration params and can either yield content or display what gets passed to the `text` configuration param.

### Text (optional)

Expects a string with the text that should go inside the `<caption>` tag.

### HMTL attributes (optional)

This component accepts all the canonical [HTML global attributes](https://www.w3schools.com/tags/ref_standardattributes.asp) like `id` or `class`.

## Examples

### Example 1: Render options\[:text] param

```ruby
table do
  caption text: "table caption"
  # table contents
end
```

returns

```markup
<table>
  <caption>table caption</caption>
  <!-- table contents -->
</table>
```

### Example 2: Yield a given block

```ruby
table id: 'foo', class: 'bar' do
  caption do
    plain "table caption"
  end
end
```

returns

```markup
<table id="foo" class="bar">
  <caption>table caption</caption>
</table>
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.matestack.io/matestack-ui-core/1.5.0/components-api/core-components/caption.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.