Categories

Group the forms on the dashboard.

  1. The categories attribute
  2. Category object

The categories attribute

The top-level categories list of config.yaml:

Attribute Comments
categories
array

Categories
🔗 valid category object

The categories group the forms together in a tree-like view. The Default category is mandatory and holds all forms without a category.

Added 3.1.0

Added nested categories

Examples:

1) Categories

categories:
- name: Default          # is mandatory
  icon: bars
- name: Provisioning
  icon: pencil-alt
- name: Decommissioning
  icon: trash-alt
  items:                 # sub categories
    - name: Linux
      icon: star
    - name: Windows
      icon: bullseye  

Category object

Each entry of the categories list:

A category groups together 1 or more forms.

Attribute Comments
name
string / required / unique

The name of the category
alphanumeric + dash + underscore + space

The name of a category has to be unique. The Default category is mandatory and holds all non-category forms.

icon
string

Category icon
Free fontawesome 6 icon

You can add a nice icon to your categories. The icon name is a free fontawesome 6 icon. You can find more information at www.fontawesome.com.

items
object
added in version 3.1.0

Sub categories
A category object

A category can have sub categories, which is again a category object.

Examples

1) Categories

categories:
- name: Default          # is mandatory
  icon: bars
- name: Provisioning
  icon: pencil-alt
- name: Decommissioning
  icon: trash-alt
  items:                 # sub categories
    - name: Linux
      icon: star
    - name: Windows
      icon: bullseye

Copyright © 2023-2026 AnsibleForms. All rights reserved.

This site uses Just the Docs, a documentation theme for Jekyll.