Group Settings (`group`)

In the position settings for platen.display.menu, you can group entries at the top-level or nested in the entries list. These settings determine how those grouped entries are displayed.

If this setting isn’t defined at the top-level for a position, all entries for that position are added in an unordered list without a containing item to indicate that they’re semantically related.

You can use this setting for individual entries, creating a nested group of related entries.

Metadata

ID: https://platen.io/modules/platen/config/site/display/menu/group/schema.json
Type: object

JSON Schema

Definition

{
  "$id": "https://platen.io/modules/platen/config/site/display/menu/group/schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Ensures entries are added in a containing group and configures their display.\n\nhttps://platen.io/modules/platen/config/site/display/menu/group/",
  "properties": {
    "class": {
      "description": "Specifies a class to add to the group entry in the site menu.\n\nhttps://platen.io/modules/platen/config/site/display/menu/group/#class",
      "title": "Group Entry Class",
      "type": "string"
    },
    "collapse": {
      "description": "Specifies whether to collapse the group entry in the site menu.\n\nhttps://platen.io/modules/platen/config/site/display/menu/group/#collapse",
      "title": "Collapse Group Entry",
      "type": "boolean"
    },
    "flatten": {
      "description": "Specifies whether to flatten the group entry in the site menu.\n\nhttps://platen.io/modules/platen/config/site/display/menu/group/#flatten",
      "title": "Flatten Group Entry",
      "type": "boolean"
    },
    "group": {
      "$ref": "https://platen.io/modules/platen/config/site/display/menu/group/schema.json"
    },
    "href": {
      "description": "Specifies the URL clicking the group entry in the site menu should take a visitor to.\n\nhttps://platen.io/modules/platen/config/site/display/menu/group/#href",
      "title": "Group Entry URL",
      "type": "string"
    },
    "name": {
      "description": "Specifies the root section of the content folder to add to the site menu.\n\nhttps://platen.io/modules/platen/config/site/display/menu/group/#name",
      "title": "Group Entry Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "Group Settings",
  "type": "object"
}

Required Properties

Group Entry Name

Group Entry Name (`name`)

Specifies the name to use for the group entry in the site menu. This is the text value displayed in the site menu for the group.

Metadata

Type: string

Group Entry URL (`href`)

Specifies the URL clicking the group entry in the site menu should take a visitor to. If this value isn’t specified, the group entry still contains its entries but it can’t be navigated to.

Metadata

Type: string

Collapse Group Entry (`collapse`)

Specifies whether to collapse the group entry in the site menu. Collapsed entries are displayed with a clickable arrow that expands and collapses the group’s entries, defaulting to collapsed.

This setting is incompatible with flatten. A group entry can be collapsed or flattened, but not both.

Metadata

Type: boolean

Flatten Group Entry (`flatten`)

Specifies whether to flatten the group entry in the site menu. Flattened entries are displayed with the grouping entry bolded above a the group’s entries without additional spacing or indenting for those entries.

This setting is incompatible with collapse. A group entry can be collapsed or flattened, but not both.

Metadata

Type: boolean

Group Entry Class (`class`)

Specifies a class to add to the group entry in the site menu. To specify more than one class, separate each class with a space.

If this value isn’t specified, the group is added without any class injection. If this value is specified, the class declaration is injected in the top-level unordered list (<ul>) if the group is declared at the top-level for a position or in the unordered list containing the group’s entries if the group is nested in the entries list.

Top-level lists without the platen class are added to the site menu with a small margin above them. To ensure a top-level group is added to the site menu without this additional spacing, set this value to platen.

Metadata

Type: string