mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00
65d3ddd5d1
This creates a custom dartdoc tool that will generate snippet blocks in our API docs that allow the user to copy easily to the clipboard, and will also embed the snippet code into a template to show it in a larger context with an app. This PR adds the snippet tool, a template, and a couple of HTML skeleton files, one for snippets that are designed to be in an application setting, and one where it simply puts a nice container around existing snippets, making them easier to copy to the clipboard.
35 lines
1.4 KiB
HTML
35 lines
1.4 KiB
HTML
{@inject-html}
|
|
<div class="snippet-buttons">
|
|
<button id="shortSnippetButton" onclick="showSnippet(shortSnippet);" selected>Sample</button>
|
|
<button id="longSnippetButton" onclick="showSnippet(longSnippet);">Sample in an App</button>
|
|
</div>
|
|
<div class="snippet-container">
|
|
<div class="snippet" id="shortSnippet">
|
|
<div class="snippet-description">
|
|
{@end-inject-html}
|
|
{{description}}
|
|
{@inject-html}
|
|
</div>
|
|
<div class="copyable-container">
|
|
<button class="copy-button-overlay copy-button" title="Copy to clipboard"
|
|
onclick="copyTextToClipboard();">
|
|
<i class="material-icons copy-image">assignment</i>
|
|
</button>
|
|
<pre class="language-dart"><code class="language-dart">{{code}}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="snippet" id="longSnippet" hidden>
|
|
<div class="snippet-description">To create a sample project with this code snippet, run:<br/>
|
|
<span class="snippet-create-command">flutter create --snippet={{id}} mysample</span>
|
|
</div>
|
|
<div class="copyable-container">
|
|
<button class="copy-button-overlay copy-button" title="Copy to clipboard"
|
|
onclick="copyTextToClipboard();">
|
|
<i class="material-icons copy-image">assignment</i>
|
|
</button>
|
|
<pre class="language-dart"><code class="language-dart">{{app}}</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
{@end-inject-html}
|