info.json

Outline basic information about your Element

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.

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

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

Key	Type	Notes
identifier (Required)	string	The identifier is the unique ID for your Element. We recommend using a reverse DNS format. This should be a string consisting of just lowercase characters and periods without spaces.
author (Required)	string	The name of the author of the Element. This would usually be the developer name, or the name of the company publishing the Element.
title (Required)	string	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.
group (Required)	string	One of the above categories. Components with the same category are grouped together.
tags	array	A list of tags relevant to the Elements.
helpURL	string	A URL to the location of the help documentation online.
infoURL	string	A URL to the location of the marketing page online.

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",
  "tags": [
    "simple",
    "example"
  ]
}