[mustache_template] Add example app #36
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -59,4 +59,4 @@ gradlew.bat | |
|
|
||
| .project | ||
| .classpath | ||
| .settings | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| // Copyright 2026 The Flutter Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| // ignore_for_file: avoid_print | ||
|
|
||
| import 'package:mustache_template/mustache_template.dart'; | ||
|
|
||
| /// The main entrypoint for the example app. | ||
| void main() { | ||
| exampleUsage(); | ||
| nestedPaths(); | ||
| partialsExample(); | ||
| lambdasExample(); | ||
| } | ||
|
|
||
| /// Demonstrates basic usage of mustache templates. | ||
| void exampleUsage() { | ||
| const source = ''' | ||
| {{# names }} | ||
| <div>{{ lastname }}, {{ firstname }}</div> | ||
| {{/ names }} | ||
| {{^ names }} | ||
| <div>No names.</div> | ||
| {{/ names }} | ||
| {{! I am a comment. }} | ||
| '''; | ||
|
|
||
| final template = Template(source, name: 'template-filename.html'); | ||
|
|
||
| final String output = template.renderString(<String, dynamic>{ | ||
| 'names': <Map<String, String>>[ | ||
| <String, String>{'firstname': 'Greg', 'lastname': 'Lowe'}, | ||
| <String, String>{'firstname': 'Bob', 'lastname': 'Johnson'}, | ||
| ], | ||
| }); | ||
|
|
||
| print(output); | ||
| } | ||
|
|
||
| /// Demonstrates how to access nested map properties. | ||
| void nestedPaths() { | ||
| final template = Template('The author is {{ author.name }}'); | ||
| final String output = template.renderString(<String, dynamic>{ | ||
| 'author': <String, String>{'name': 'Greg Lowe'}, | ||
| }); | ||
| print(output); | ||
| } | ||
|
|
||
| /// Demonstrates the usage of partials with a custom resolver. | ||
| void partialsExample() { | ||
| final partial = Template('{{ foo }}', name: 'partial'); | ||
|
|
||
| Template? resolver(String name) { | ||
| if (name == 'partial-name') { | ||
| // Name of partial tag. | ||
| return partial; | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| final t = Template('{{> partial-name }}', partialResolver: resolver); | ||
|
|
||
| final String output = t.renderString(<String, dynamic>{'foo': 'bar'}); | ||
| print(output); // bar | ||
| } | ||
|
|
||
| /// Demonstrates various usages of lambdas, including hidden sections and lambda contexts. | ||
| void lambdasExample() { | ||
| // Simple lambda | ||
| final t1 = Template('{{# foo }}inner{{/ foo }}'); | ||
| Object lambda1(Object? _) => 'bar'; | ||
| print(t1.renderString(<String, dynamic>{'foo': lambda1})); // bar | ||
|
|
||
| // Lambda returning text for a hidden section | ||
| final t2 = Template('{{# foo }}hidden{{/ foo }}'); | ||
| Object lambda2(Object? _) => 'shown'; | ||
| print(t2.renderString(<String, dynamic>{'foo': lambda2})); // shown | ||
|
|
||
| // Lambda Context | ||
| final t3 = Template('{{# foo }}oi{{/ foo }}'); | ||
| Object lambda3(LambdaContext ctx) => | ||
| '<b>${ctx.renderString().toUpperCase()}</b>'; | ||
| print(t3.renderString(<String, dynamic>{'foo': lambda3})); // <b>OI</b> | ||
|
|
||
| // Lambda Context with variables | ||
| final t4 = Template('{{# foo }}{{bar}}{{/ foo }}'); | ||
| Object lambda4(LambdaContext ctx) => | ||
| '<b>${ctx.renderString().toUpperCase()}</b>'; | ||
| print(t4.renderString( | ||
| <String, dynamic>{'foo': lambda4, 'bar': 'pub'})); // <b>PUB</b> | ||
|
|
||
| // Lambda Context re-parsing source | ||
| final t5 = Template('{{# foo }}{{bar}}{{/ foo }}'); | ||
| Object lambda5(LambdaContext ctx) => | ||
| ctx.renderSource('${ctx.source} {{cmd}}'); | ||
| print(t5.renderString(<String, dynamic>{ | ||
| 'foo': lambda5, | ||
| 'bar': 'pub', | ||
| 'cmd': 'build', | ||
| })); // pub build | ||
| } |
|
Collaborator
There was a problem hiding this comment. What is the purpose of having this file? All of the code appears to exactly duplicate code in main.dart. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| // Copyright 2026 The Flutter Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| // This file exists solely to host compiled excerpts for README.md, and is not | ||
| // intended for use as an actual example application. | ||
|
|
||
| // ignore_for_file: avoid_print | ||
| // ignore_for_file: omit_local_variable_types | ||
| // ignore_for_file: strict_raw_type | ||
| // ignore_for_file: prefer_final_locals | ||
|
Collaborator
There was a problem hiding this comment. Why have you disabled core style rules? We have a consistent style for a reason. |
||
|
|
||
| import 'package:mustache_template/mustache_template.dart'; | ||
|
|
||
| /// Example for basic usage of a mustache template. | ||
| void exampleUsageSnippet() { | ||
| // #docregion example_usage | ||
| var source = ''' | ||
| {{# names }} | ||
| <div>{{ lastname }}, {{ firstname }}</div> | ||
| {{/ names }} | ||
| {{^ names }} | ||
| <div>No names.</div> | ||
| {{/ names }} | ||
| {{! I am a comment. }} | ||
| '''; | ||
|
|
||
| var template = Template(source, name: 'template-filename.html'); | ||
|
|
||
| String output = template.renderString(<String, dynamic>{ | ||
| 'names': <Map<String, String>>[ | ||
| <String, String>{'firstname': 'Greg', 'lastname': 'Lowe'}, | ||
| <String, String>{'firstname': 'Bob', 'lastname': 'Johnson'} | ||
| ] | ||
| }); | ||
| // #enddocregion example_usage | ||
|
|
||
| print(output); | ||
| } | ||
|
|
||
| /// Example for rendering nested paths in a template. | ||
| void nestedPathsSnippet() { | ||
| // #docregion nested_paths | ||
| var template = Template('{{ author.name }}'); | ||
| String output = template.renderString(<String, dynamic>{ | ||
| 'author': <String, String>{'name': 'Greg Lowe'} | ||
| }); | ||
| // #enddocregion nested_paths | ||
| print(output); | ||
| } | ||
|
|
||
| /// Example for using partials. | ||
| void partialsSnippet() { | ||
| // #docregion partials | ||
| var partial = Template('{{ foo }}', name: 'partial'); | ||
|
|
||
| Template? resolver(String name) { | ||
| if (name == 'partial-name') { | ||
| // Name of partial tag. | ||
| return partial; | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| var t = Template('{{> partial-name }}', partialResolver: resolver); | ||
|
|
||
| String output = t.renderString(<String, dynamic>{'foo': 'bar'}); | ||
| // #enddocregion partials | ||
| print(output); // bar | ||
| } | ||
|
|
||
| /// Example for using lambdas in a template. | ||
| void lambdasSnippet() { | ||
| // #docregion lambdas | ||
| // Simple lambda | ||
| var t1 = Template('{{# foo }}inner{{/ foo }}'); | ||
| Object lambda1(Object? _) => 'bar'; | ||
| // #enddocregion lambdas | ||
| print(t1.renderString(<String, dynamic>{'foo': lambda1})); // bar | ||
|
|
||
| // #docregion lambdas | ||
| // Lambda returning text for a hidden section | ||
| var t2 = Template('{{# foo }}hidden{{/ foo }}'); | ||
| Object lambda2(Object? _) => 'shown'; | ||
| // #enddocregion lambdas | ||
| print(t2.renderString(<String, dynamic>{'foo': lambda2})); // shown | ||
|
|
||
| // #docregion lambdas | ||
| // Lambda Context | ||
| var t3 = Template('{{# foo }}oi{{/ foo }}'); | ||
| Object lambda3(LambdaContext ctx) => | ||
| '<b>${ctx.renderString().toUpperCase()}</b>'; | ||
| // #enddocregion lambdas | ||
| print(t3.renderString(<String, dynamic>{'foo': lambda3})); // <b>OI</b> | ||
|
|
||
| // #docregion lambdas | ||
| // Lambda Context with variables | ||
| var t4 = Template('{{# foo }}{{bar}}{{/ foo }}'); | ||
| Object lambda4(LambdaContext ctx) => | ||
| '<b>${ctx.renderString().toUpperCase()}</b>'; | ||
| // #enddocregion lambdas | ||
| print(t4.renderString( | ||
| <String, dynamic>{'foo': lambda4, 'bar': 'pub'})); // <b>PUB</b> | ||
|
|
||
| // #docregion lambdas | ||
| // Lambda Context re-parsing source | ||
| var t5 = Template('{{# foo }}{{bar}}{{/ foo }}'); | ||
| Object lambda5(LambdaContext ctx) => | ||
| ctx.renderSource('${ctx.source} {{cmd}}'); | ||
| // #enddocregion lambdas | ||
| print(t5.renderString(<String, dynamic>{ | ||
| 'foo': lambda5, | ||
| 'bar': 'pub', | ||
| 'cmd': 'build' | ||
| })); // pub build | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please revert the change to this file.