mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-06-24 09:21:06 -04:00
88 lines
2.8 KiB
JSON
88 lines
2.8 KiB
JSON
[
|
|
{
|
|
"name": "homepageUrl",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "The url of the homepage. Defaults to /"
|
|
},
|
|
{
|
|
"name": "assetsPath",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "The public path for the assets folder. If not provided it defaults to /assets/images"
|
|
},
|
|
{
|
|
"name": "productName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Header title that is placed next to GOV.UK. Used for product names (i.e. Pay, Verify)"
|
|
},
|
|
{
|
|
"name": "serviceName",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Header title that is placed next to GOV.UK. Used for product names (i.e. Pay, Verify)"
|
|
},
|
|
{
|
|
"name": "serviceUrl",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Url for the service name anchor."
|
|
},
|
|
{
|
|
"name": "navigation",
|
|
"type": "array",
|
|
"required": false,
|
|
"description": "An array of navigation item objects.",
|
|
"params": [
|
|
{
|
|
"name": "text",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Text of the navigation item."
|
|
},
|
|
{
|
|
"name": "href",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Url of the navigation item anchor. Both `href` and `text` attributes for navigation items need to be provided to create an item."
|
|
},
|
|
{
|
|
"name": "active",
|
|
"type": "boolean",
|
|
"required": false,
|
|
"description": "Flag to mark the navigation item as active or not."
|
|
},
|
|
{
|
|
"name": "attributes",
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "HTML attributes (for example data attributes) to add to the navigation item anchor."
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "navigationClasses",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Classes for the navigation section of the header."
|
|
},
|
|
{
|
|
"name": "containerClasses",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Classes for the container, useful if you want to make the header fixed width."
|
|
},
|
|
{
|
|
"name": "classes",
|
|
"type": "string",
|
|
"required": false,
|
|
"description": "Classes to add to the header container."
|
|
},
|
|
{
|
|
"name": "attributes",
|
|
"type": "object",
|
|
"required": false,
|
|
"description": "HTML attributes (for example data attributes) to add to the header container."
|
|
}
|
|
] |