digitalmarketplace-frontend
Version:
Digital Marketplace Frontend contains assets and components used in Digital Marketplace projects
120 lines (119 loc) • 3.58 kB
JSON
[
{
"name": "link",
"type": "object",
"required": true,
"description": "Link details",
"params": [
{
"name": "href",
"type": "string",
"required": true,
"description": "The href for the attached document"
},
{
"name": "text",
"type": "string",
"required": true,
"description": "The title of the attached document"
},
{
"name": "textOnly",
"type": "boolean",
"description": "Whether to display the link only"
},
{
"name": "classes",
"type": "string",
"description": "Classes to apply to the link"
},
{
"name": "attributes",
"type": "object",
"description": "HTML attributes to add to the link"
}
]
},
{
"name": "contentType",
"type": "string",
"description": "The filetype of the attached document (eg - 'text/csv')",
"required": false
},
{
"name": "fileSize",
"type": "string",
"description": "The file size of the attached document. This should be a human-readable size like \"25 KB\" or \"1.2 MB\"",
"required": false
},
{
"name": "numberOfPages",
"type": "integer",
"description": "Number of pages in the attached document",
"required": false
},
{
"name": "lastUpdated",
"type": "object",
"description": "When the document was last updated",
"required": false,
"params": [
{
"name": "datetime",
"type": "string",
"required": true,
"description": "The datetime string"
},
{
"name": "text",
"type": "string",
"required": true,
"description": "The time string"
}
]
},
{
"name": "alternativeFormatHtml",
"type": "string",
"description": "Information on how to request an accessible format.",
"required": false
},
{
"name": "alternativeFormatContactEmail",
"type": "string",
"description": "Used to provide an email to request an accessible format",
"required": false
},
{
"name": "description",
"type": "object",
"description": "Used to provide a description of the document",
"required": false,
"params": [
{
"name": "html",
"type": "string",
"required": true,
"description": "HTML for the description. Either this or text must be provided."
},
{
"name": "text",
"type": "string",
"required": true,
"description": "Text for the description. Either this or html must be provided."
}
]
},
{
"name": "headingTag",
"type": "string",
"description": "Used to set the tag of the download link wrapper. Defaults to h2.",
"required": false
},
{
"name": "thumbnailSize",
"type": "string",
"description": "Set to \"small\" to reduce thumbnail size. Defaults to a larger size.",
"required": false
}
]