TemplateDefinition
typedef
An object describing a single template definition.
{
// Mandatory fields:
title: 'Example template',
data: '<table><tr><td>Cell #1</td><td></td></tr><tr><td></td><td>Cell #2</td></tr></table>',
// Optional configuration:
icon: '<svg viewBox="0 0 45 45" xmlns="http://www.w3.org/2000/svg">...</svg>',
description: 'This template inserts a table.'
}
Properties
-
data : () => string | stringmodule:template/template~TemplateDefinition#dataAn HTML string to be inserted into the document or a callback function that returns an HTML string to be inserted into the document when the template is selected.
-
description : string | undefinedmodule:template/template~TemplateDefinition#descriptionAn optional long description of the template presented to the users.
-
icon : string | undefinedmodule:template/template~TemplateDefinition#iconAn optional SVG string representing the icon of the template. The default size of the icon is 45x45 pixels. Be sure to set the correct
viewBoxattribute in the icon source. If not provided, a generic icon will be used instead. -
title : stringmodule:template/template~TemplateDefinition#titleThe title of the template.