# info.json

The info.json file contains important information about a Component. The file uses the JSON format and consists of a series of key and value pairs. It's required for Component to function.

### Component Categories

Every Component needs to define a category in which they belong. This tells Elements how to group components in the UI and helps users to locate components. Your Component MUST use one of the following pre-defined categories.

If you think we're missing a category, please visit the [forum and let us know](https://forums.realmacsoftware.com/c/rapidweaver-elements/developer/).

| Group             | example                                                       |
| ----------------- | ------------------------------------------------------------- |
| **Accessibility** | ARIA Lables, Contrast Checkers.                               |
| **Animation**     | Hover Effects, Animated SVG's.                                |
| **CMS**           | Content Management Systems                                    |
| **Content**       | Headings, Paragraphs, Lists.                                  |
| **Dynamic**       | Online Databases, Google Sheets.                              |
| **Ecommerce**     | Cart Integration, Product display, Add to Cart Buttons.       |
| **Forms**         | Text Fields, Text Areas, Checkboxes, Buttons.                 |
| **Interactive**   | Modals, Popovers, Accordions, Carousels.                      |
| **Layout**        | Grid, Flex, Containers, Columns.                              |
| **Media**         | Images, Video, Audio Players, Icons, Embeds (YouTube, Vimeo). |
| **Navigation**    | Menus, Nav Bars, Breadcrumbs, Tabs.                           |
| **Security**      | Password Protection, Login Forms.                             |
| **SEO**           | Keywords, SEO helpers.                                        |
| **Utility**       | Cookies, Anchors, Placeholders, Dividers.                     |

### Supported Key-Value Pairs <a href="#key-value-pairs-explained" id="key-value-pairs-explained"></a>

The Elements info.json file supports the following key-value pairs.

<table><thead><tr><th>Key</th><th width="100">Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>identifier (Required)</code></td><td>string</td><td>The identifier is the unique ID for your Element. We recommend using a <a href="https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/understanding_utis/understand_utis_conc/understand_utis_conc.html">reverse DNS format</a>. This should be a string consisting of just lowercase characters and periods without spaces.</td></tr><tr><td><code>author (Required)</code></td><td>string</td><td>The name of the author of the Element. This would usually be the developer name, or the name of the company publishing the Element.</td></tr><tr><td><code>title (Required)</code></td><td>string</td><td>The name of the Element. This will be displayed inside of RapidWeaver. A unique and descriptive name is preferable. Overly long names will get truncated, check inside of the RapidWeaver UI for readability.</td></tr><tr><td><code>group (Required)</code></td><td>string</td><td>One of the above categories. Components with the same category are grouped together.</td></tr><tr><td><code>tags</code></td><td>array</td><td>A list of tags relevant to the Elements.</td></tr><tr><td><code>helpURL</code></td><td>string</td><td>A URL to the location of the help documentation online.</td></tr><tr><td><code>infoURL</code></td><td>string</td><td>A URL to the location of the marketing page online.</td></tr><tr><td><code>deploy</code></td><td>boolean</td><td>Should this component be included when deploying a pack, true or false. Default value is true.</td></tr></tbody></table>

### info.json Example

You can use the following code as a starting point for your own info.json file.

```
{
  "identifier": "com.realmac.elementpack.helloworld",
  "author": "Realmac Software",
  "title": "Hello World",
  "group": "Utility",
  "deploy": true,
  "tags": [
    "simple",
    "example"
  ]
}
```


---

# 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.realmacsoftware.com/elements-docs/elements-language/component/info-json.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.