ccs-frontend/dist/ccs/components/header/macro-options.json

CCS Frontend contains assets and components used in CCS projects

[
    {
        "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": "serviceName",
        "type": "string",
        "required": false,
        "description": "The name of your service, included in the header."
    },
    {
        "name": "serviceUrl",
        "type": "string",
        "required": false,
        "description": "URL for the service name anchor."
    },
    {
        "name": "serviceAuthentication",
        "type": "array",
        "required": false,
        "description": "An array of authentication item objects (for example sign-in or register). Is placed at the top of the header.",
        "params": [
            {
                "name": "text",
                "type": "string",
                "required": true,
                "description": "Text for the authentication item. If `html` is provided, the `text` argument will be ignored."
            },
            {
                "name": "html",
                "type": "string",
                "required": true,
                "description": "HTML for the authentication item. If `html` is provided, the `text` argument will be ignored."
            },
            {
                "name": "href",
                "type": "string",
                "required": false,
                "description": "URL of the authentication item anchor."
            },
            {
                "name": "method",
                "type": "string",
                "required": false,
                "description": "The HTTP method to use instead of a link"
            },
            {
                "name": "attributes",
                "type": "object",
                "required": false,
                "description": "HTML attributes (for example data attributes) to add to the navigation item anchor."
            }
        ]
    },
    {
        "name": "navigationPrimary",
        "type": "array",
        "required": false,
        "description": "An array of navigation item objects. Is placed on the bottom of the header.",
        "params": [
            {
                "name": "text",
                "type": "string",
                "required": true,
                "description": "Text for the navigation item. If `html` is provided, the `text` argument will be ignored."
            },
            {
                "name": "html",
                "type": "string",
                "required": true,
                "description": "HTML for the navigation item. If `html` is provided, the `text` argument will be ignored."
            },
            {
                "name": "href",
                "type": "string",
                "required": false,
                "description": "URL of the navigation item anchor."
            },
            {
                "name": "method",
                "type": "string",
                "required": false,
                "description": "The HTTP method to use instead of a link"
            },
            {
                "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": "navigationSecondary",
        "type": "array",
        "required": false,
        "description": "An array of navigation item objects. Is placed on the second row of the header or the bottom if no primary navigation.",
        "params": [
            {
                "name": "text",
                "type": "string",
                "required": true,
                "description": "Text for the navigation item. If `html` is provided, the `text` argument will be ignored."
            },
            {
                "name": "html",
                "type": "string",
                "required": true,
                "description": "HTML for the navigation item. If `html` is provided, the `text` argument will be ignored."
            },
            {
                "name": "href",
                "type": "string",
                "required": false,
                "description": "URL of the navigation item anchor."
            },
            {
                "name": "method",
                "type": "string",
                "required": false,
                "description": "The HTTP method to use instead of a link"
            },
            {
                "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": "navigationLabel",
        "type": "string",
        "required": false,
        "description": "Text for the `aria-label` attribute of the navigation. Defaults to 'Navigation menu'."
    },
    {
        "name": "menuButtonLabel",
        "type": "string",
        "required": false,
        "description": "Text for the `aria-label` attribute of the button that toggles the navigation. Defaults to 'Show or hide navigation menu'."
    },
    {
        "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."
    }
]