☁️ Loving our new documentation website? Provide feedback in the CloudCannon Community! ✨

Developer ReferenceConfiguration File

HREF Add Option

Table of contents

Description:

This key represents the URL add option object in a collections_config.*.add_options array.

The value is an object that defines an option available in the + Add button dropdown at the top right of the Collection browser. URL add options must contain a required href key and can contain optional name and icon keys.

Appears in:
└── collections_config
    └── *
        └── add_options
            └── [*]
                └── HREF Add Option
Type:
Object
Properties:
hrefstring Required#

This key defines the link for a URL option in the + Add button dropdown.

The value is a string that specifies a URL. Values can be an external URL or an internal URL relative to the current Site.

This key is required for URL add options in the collections_config.*.add_options array.

Show examplesHide examples

In this example, the + Add button dropdown in the team Collection browser uses a link option with the URL https://forms.gle/xxxxxxx.

Copied to clipboard
collections_config:
  team:
    add_options:
      - name: Submit Form
        icon: assignment_add
        href: https://forms.gle/xxxxxxx
{
  "collections_config": {
    "team": {
      "add_options": [
        {
          "name": "Submit Form",
          "icon": "assignment_add",
          "href": "https://forms.gle/xxxxxxx"
        }
      ]
    }
  }
}
iconstring#

This key defines the icon displayed next to the text for a URL option in the + Add button dropdown.

The value is a string that specifies an icon name from Google's Material Symbols.

Defaults to: add

Allowed values: 123 360 10k 10mp 11mp 12mp 13mp 14mp 15mp 16mp and 3574 more.

Show examplesHide examples

In this example, the + Add button dropdown in the team Collection browser uses a link option with the icon map to navigate to the Office Locations page on our live website.

Copied to clipboard
collections_config:
  team:
    add_options:
      - name: Office Locations
        icon: map
        href: /our-offices
{
  "collections_config": {
    "team": {
      "add_options": [
        {
          "name": "Office Locations",
          "icon": "map",
          "href": "/our-offices"
        }
      ]
    }
  }
}
namestring#

This key defines the text displayed for a URL option in the + Add button dropdown.

Show examplesHide examples

In this example, the + Add button dropdown in the team Collection browser uses a link option with the text "Office Locations" to navigate to the Office Locations page on our live website.

Copied to clipboard
collections_config:
  team:
    add_options:
      - name: Office Locations
        icon: map
        href: /our-offices
{
  "collections_config": {
    "team": {
      "add_options": [
        {
          "name": "Office Locations",
          "icon": "map",
          "href": "/our-offices"
        }
      ]
    }
  }
}
Examples:

In this example, the + Add button dropdown in the team Collection browser has a link to the Office Locations page on our live website.

Copied to clipboard
collections_config:
  team:
    add_options:
      - name: Office Locations
        icon: map
        href: /our-offices
{
  "collections_config": {
    "team": {
      "add_options": [
        {
          "name": "Office Locations",
          "icon": "map",
          "href": "/our-offices"
        }
      ]
    }
  }
}
Open in a new tab