summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/templates/private/api_reference.html
blob: d2d116eca29d20a19cb5b99225898e4301de55a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
<div class="api-reference">
  {{- This is a span not a header-tag so that it doesn't show up in the TOC. -}}
  {{?api.types}}
    <h2 id="types">Types</h2>
    {{#t:api.types}}
      {{+partials.type display_name:t.name type:t/}}
    {{/}}
  {{/api.types}}
  {{?api.properties}}
    <h2 id="properties">Properties</h2>
    <table>
    {{#p:api.properties}}
      {{+partials.api_property api:api property:p/}}
    {{/}}
    </table>
  {{/api.properties}}
  {{?api.functions}}
    <h2 id="methods">Methods</h2>
    {{#f:api.functions}}
      {{+partials.function function:f api:api parentName:false/}}
    {{/}}
  {{/api.functions}}
  {{?api.events}}
    <h2 id="events">Events</h2>
    {{#e:api.events}}
      {{+partials.event event:e api:api/}}
    {{/}}
  {{/api.events}}
  {{?api.domEvents}}
    <h2 id="dom_events">DOM Events</h2>
    <dd>
      Listeners can be added for these events using the standard HTML
      <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget.addEventListener">addEventListener</a>
      API. Listeners receive a custom <code>Event</code> object which can have
      additional properties as listed with each event.</dd>
    {{#e:api.domEvents}}
      {{+partials.dom_event display_name:e.name event:e api:api/}}
    {{/api.domEvents}}
  {{/api.domEvents}}
</div>
{{?samplesForApi}}
  <h2 id="samples">Sample {{platformTitle}}</h2>
  <ul>
  {{#sample:samplesForApi}}
    <li><strong><a href="samples#search:{{sample.id}}">{{sample.name}}</a></strong>
    {{?sample.description}}
    &ndash; {{sample.description}}
    {{/sample.description}}</li>
  {{/samplesForApi}}
  </ul>
{{/samplesForApi}}