info.json

Outline basic information about your Element

The info.json file outlines the basic information about a Component. The file consists of a series of key and value pairs. It's required for Component to function.

Component Categories

Every Component needs to have a defined category so Elements knows where to show it in the UI, it also helps users locate the Component. Your Component MUST use one of the categories. I you think we're missing a category, pleae visit the developer forum and let us know.

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

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	Elements are grouped in the Elements Catalogue inside of RapidWever . You can use this key to group your Elements together.
build (Required)	string	The build number of an Element. The number should be an integer value, like "100". We recommend increasing the value with each release.
version (Required)	string	The version of an Element. We recommend the following convention (as used by many apps): major.minor.patch. and in practice that might look like "1.0.0" for an initial release.
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.
missingURL	string	The URL to redirect users to when this Element is uninstalled or missing.
framework	string	Elements are grouped in the Elements Catalogue inside of RapidWever . You can use this key to group Elements from the same Framework togther.
assets	array	A list of required assets for the Element. This can be a mixed list of images and files for example.

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",
    "tags": [
    "simple",
    "example"
  ],
  "group": "Fun",
  "build": "001",
  "version": "0.0.1",
  "assets": [
    {
      "filename": "assets/image-square.png"
    }
  ]
}

}

Example info.json file inside of an Element.