mirror of
https://github.com/meteor/meteor.git
synced 2026-05-02 03:01:46 -04:00
92 lines
2.0 KiB
HTML
92 lines
2.0 KiB
HTML
<template name="apiBoxTitle">
|
|
<h3 id="{{id}}" class="api-title">
|
|
<div class="locus">
|
|
{{locus}}
|
|
</div>
|
|
|
|
<a class="name selflink" href="{{link}}">{{{name}}}</a>
|
|
<div class="subtext">
|
|
{{#if importName}}
|
|
<code>import { {{importName}} } from 'meteor/{{module}}'</code>
|
|
{{/if}}
|
|
|
|
{{#if fullApi}}
|
|
{{#if filepath}}
|
|
<a class="src-code" href="https://github.com/meteor/meteor/blob/master/packages/{{filepath}}#L{{lineno}}" target="_blank">
|
|
({{filepath}}, line {{lineno}})
|
|
</a>
|
|
{{/if}}
|
|
{{/if}}
|
|
</div>
|
|
</h3>
|
|
</template>
|
|
|
|
<template name="autoApiBox">
|
|
{{#with apiData this}}
|
|
<div class="api {{bare}} new-api-box">
|
|
{{> apiBoxTitle
|
|
name=signature
|
|
importName=importName
|
|
module=module
|
|
locus=locus
|
|
id=id filepath=filepath
|
|
lineno=lineno
|
|
}}
|
|
|
|
<div class="desc">
|
|
{{#markdown}}{{summary}}{{/markdown}}
|
|
</div>
|
|
|
|
{{#if paramsNoOptions}}
|
|
<h4>Arguments</h4>
|
|
<dl class="args">
|
|
{{#each paramsNoOptions}}
|
|
<dt>
|
|
<span class="name">{{name}}</span>
|
|
<span class="type">{{{typeNames type.names}}}</span>
|
|
</dt>
|
|
<dd>
|
|
{{{description}}}
|
|
</dd>
|
|
{{/each}}
|
|
</dl>
|
|
{{/if}}
|
|
|
|
{{#if options}}
|
|
<h4>Options</h4>
|
|
<dl class="args">
|
|
{{#each options}}
|
|
<dt>
|
|
<span class="name">{{name}}</span>
|
|
<span class="type">{{{typeNames type.names}}}</span>
|
|
</dt>
|
|
<dd>
|
|
{{{description}}}
|
|
</dd>
|
|
{{/each}}
|
|
</dl>
|
|
{{/if}}
|
|
|
|
{{#if UI.contentBlock}}
|
|
{{#markdown}}{{> UI.contentBlock}}{{/markdown}}
|
|
{{/if}}
|
|
</div>
|
|
{{/with}}
|
|
</template>
|
|
|
|
<template name="api_box_args">
|
|
<dl class="args">
|
|
{{#each this}}
|
|
<dt><span class="name">{{{name}}}</span>
|
|
<span class="type">
|
|
{{#if type_link}}
|
|
<a href="#{{type_link}}">{{{type}}}</a>
|
|
{{else}}
|
|
{{{type}}}
|
|
{{/if}}
|
|
</span></dt>
|
|
<dd>{{#markdown}}{{{descr}}}{{/markdown}}</dd>
|
|
{{/each}}
|
|
</dl>
|
|
</template>
|