---
category_previews:
type: list
list_type: simple
default: ''
description:
en: 'Each entry should be ~ delimited using the following format:
category-slug~Preview Name~Preview Description~https://example.com~group
-
category-slug - the preview will display above this category in the category list. The slug can be found by looking at a category URL: https://example.com/c/category-slug/12
IMPORTANT: The category-slug chosen must be from a category that is visible to everyone.
- Preview Name - the bold, hyperlinked part of the preview
-
Preview Description - displayed under the Preview Name
-
https://example.com - the link that will be attached to the Preview Name
-
group - a comma-separated list of group names. Members of these groups will not see the preview. This should align with the category permission settings of the category being previewed.
IMPORTANT: The groups chosen must configured so that the "Who can see this group?" visibility setting is set to "Group owners, member" or less restrictive.
There should always be 4 "~" in the entry, but you can choose to exclude values after each "~" to omit one of the above sections
You can use the same category slug multiple times. When this is done, the previews will display in the order they appear in the setting.'
locked_icon:
type: string
default: 'lock'
description:
en: 'The name of a Font Awesome icon to display before the Preview Name. Leave blank if no icon is need.'
border_color:
type: string
default: '0088CC'
description:
en: 'The hex color associated with all category previews when the category style
site setting is not set to "none."'