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