Table of Contents

Oqtane Modules Developer Guide

Oqtane Modules are extensions to add functionality to Oqtane system. This guide will help you get started with creating and using modules in Oqtane.

What is a Module?

A module is a collection of files that add functionality to your system. Modules include various Blazor components, CSS, JavaScript, images and more.

Since Oqtane is based on .net and Blazor, modules are built using Blazor components and these are compiled into a DLL that is loaded by the Oqtane framework.

Next Steps

Tip

Before diving too deep into modules, make sure you understand the basics of Extensions.

Read about:

To Do

  1. Parts of an Oqtane Module (coming soon)
  2. Module Build, Distribute and Install (coming soon)
  3. Module Code Explained (coming soon)
  4. Module Solution Explained (coming soon)

Tasks to complete these guides

The following topics should be covered as soon as possible (help wanted!)

  1. How to customize an existing module
  2. How to uninstall a module
  3. How to update a module
  4. How to create a module from scratch
  5. How to publish a module in the Marketplace
  6. Guidance for assets / resources
  7. Guidance for render modes and edge cases / SSR .net 8.0
  8. Guidance for responsive design
  9. Guidance for accessibility
  10. Guidance for performance & SEO
  11. Best Practices for assets - especially JS/CSS
  12. Some guidance on CSS variables / Bootstrap 5.3 conventions

Main Author

Daniel Mettler, @iJungleboy [MS MVP, Oqtane Core Team]

Content Management Expert, Chief Architect of 2sxc and cre8magic.
Forged in the jungles of Indonesia, lives in Switzerland , loves Oqtane 🩸 & 2sxc 💜.

LinkedIn | Discord: @iJungleboy | Twitter: @iJungleboy | Github: @iJungleboy

Edit this page