Tag<T extends Object> class abstract

Tags are specific texts in Templates that are replaced by the TemplateEngine with other information.

A Tag:

  • Starts with some bracket and/or character combination, e.g.: {{
  • Followed by some contents
  • Ends with some closing bracket and/or character combination, e.g.: }}

A tag example: {{customer.name}}

By default the TemplateEngine Tags start with {{ and end with }} brackets, just like the popular template engines Mustache and Handlebars.

You can also define alternative Tag brackets in the TemplateEngine constructor parameters. See TemplateEngine.tagStart and TemplateEngine.tagEnd.

It is recommended to use a start and end combination that is not used elsewhere in your templates, e.g.: Do not use < > as Tag start and end if your template contains HTML or XML

The TemplateEngine comes with DefaultTags. You can replace or add your own Tags by manipulating the the TemplateEngine.tags field.

Implemented types
Implementers

Constructors

Tag.new({required String name, required List<String> description, required String exampleExpression, String? exampleResult, required ProjectFilePath exampleCode})

Properties

description List<String>
final
exampleCode ProjectFilePath
final
exampleExpression String
final
exampleResult String?
final
hashCode int
The hash code for this object.
no setterinherited
name String
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

createMarkdownDocumentation(RenderContext renderContext, int titleLevel) List<String>
override
createMarkdownExamples(RenderContext renderContext, int titleLevel) List<String>
override
createTagParser(ParserContext context) → Parser<T>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited