Elements API

A brief introduction to the Elements templating language

The Elements language is a simple, yet powerful templating language for RapidWeaver Elements, it's often referred to as the Elements API.

The Elements language allows third-party developers to create custom Elements that can be used within the RapidWeaver Elements layout engine. Element Dev Packs (.elementsdevpack) are a bundle of files, usually a mixture of HTML, JS, CSS, JSON, and images.

The only thing you need to start building your own custom Elements is a copy of RapidWeaver Elements. Previous web development experience is recommend, but not required.

Open Source Components 🛠️

The Core Components built into Elements are now open source 🎉 You can learn more about our Open Source Core Components that power Elements here. You may also want to take a look at the associated Build Tools.

We also offer a simpler collection of example Element Components to help you get started. These simple component packs provide ready-to-use Components and configuration files you can explore, modify, and build upon to create your own custom Components for Elements.It’s the best place to learn by example and understand how a complete Dev Pack is structured.

What's Required?

The following is a list of suggested tools to make developing Elements easier.

• A copy of RapidWeaver Elements (Required).

• Text editor, we recommend Visual Studio Code.

• Our Elements Syntax Highlighter for Visual Studio.

• SF Symbol app for icon name reference.

Distributing Elements Packs

Dev Packs (.devpack) are for development only. They’re uncompiled and unencrypted, allowing live editing and real-time updates during development.

⚠️ Do not share or sell Dev Packs: They’re not optimised for distribution and can cause performance issues if misused.

✅ If you want to share or monitise your Dev Packs, they must be compiled into Element Packs (.elementpack) via the Elements Platform.

Learn more about distributing Element Packs.

Developer Community

We have a Component Development area on the Elements Forum. It's open to anyone interested in using or building addons for the RapidWeaver Elements ecosystem.

We're always around to offer help with getting started or if you just need a hand while developing your next great addon for Elements. Come join us, we're a friendly bunch ☺️

Got questions? email [email protected]