plugins/dali-script-v8/docs/dali-theme/partials/events.handlebars

   1 <div id="event_{{name}}" class="events item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">
   2     <h3 class="name"><code>{{name}}</code></h3>
   3     <span class="type">{{#crossLink type}}{{/crossLink}}</span>
   4
   5     {{#if deprecated}}
   6         <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span>
   7     {{/if}}
   8
   9     {{#if access}}
  10         <span class="flag {{access}}">{{access}}</span>
  11     {{/if}}
  12
  13     {{#if final}}
  14         <span class="flag final">final</span>
  15     {{/if}}
  16
  17     {{#if static}}
  18         <span class="flag static">static</span>
  19     {{/if}}
  20
  21     <div class="meta">
  22         {{#if overwritten_from}}
  23             <p>Inherited from
  24             <a href="{{crossLinkRaw overwritten_from/class}}#event_{{overwritten_from/name}}">
  25                 {{overwritten_from/class}}
  26             </a>
  27             {{#if foundAt}}
  28             but overwritten in
  29             {{/if}}
  30         {{else}}
  31             {{#if extended_from}}
  32                 <p>Inherited from
  33                 <a href="{{crossLinkRaw extended_from}}#event_{{name}}">{{extended_from}}</a>:
  34             {{else}}
  35                 {{#providedBy}}
  36                     <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p>
  37                 {{/providedBy}}
  38                 <p>
  39                 {{#if foundAt}}
  40                 Defined in
  41                 {{/if}}
  42             {{/if}}
  43         {{/if}}
  44         {{#if foundAt}}
  45         <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
  46         {{/if}}
  47         </p>
  48
  49         {{#if deprecationMessage}}
  50             <p>Deprecated: {{deprecationMessage}}</p>
  51         {{/if}}
  52
  53         {{#if since}}
  54             <p>Available since {{since}}</p>
  55         {{/if}}
  56     </div>
  57
  58     <div class="description">
  59         {{{eventDescription}}}
  60     </div>
  61
  62     {{#if params}}
  63         <div class="params">
  64             <h4>Event Payload:</h4>
  65
  66             <ul class="params-list">
  67             {{#params}}
  68                 <li class="param">
  69                     {{#if optional}}
  70                         <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
  71                         <span class="type">{{#crossLink type}}{{/crossLink}}</span>
  72                         <span class="flag optional" title="This parameter is optional.">optional</span>
  73                     {{else}}
  74                         <code class="param-name">{{name}}</code>
  75                         <span class="type">{{#crossLink type}}{{/crossLink}}</span>
  76                     {{/if}}
  77
  78                     {{#if multiple}}
  79                         <span class="flag multiple" title="This parameter may occur one or more times.">Multiple</span>
  80                     {{/if}}
  81
  82                     <div class="param-description">
  83                         {{{description}}}
  84                     </div>
  85
  86                     {{#if props}}
  87                         <ul class="params-list">
  88                             {{#props}}
  89                             <li class="param">
  90                                 {{#if optional}}
  91                                     <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
  92                                     <span class="type">{{#crossLink type}}{{/crossLink}}</span>
  93                                     <span class="flag optional" title="This parameter is optional.">optional</span>
  94                                 {{else}}
  95                                     <code class="param-name">{{name}}</code>
  96                                     <span class="type">{{#crossLink type}}{{/crossLink}}</span>
  97                                 {{/if}}
  98
  99                                 <div class="param-description">
 100                                     {{{description}}}
 101                                 </div>
 102
 103                                 {{#if props}}
 104                                     <ul class="params-list">
 105                                         {{#props}}
 106                                         <li class="param">
 107                                             <code class="param-name">{{name}}</code>
 108                                             <span class="type">{{#crossLink type}}{{/crossLink}}</span>
 109
 110                                             <div class="param-description">
 111                                                 {{{description}}}
 112                                             </div>
 113                                         </li>
 114                                         {{/props}}
 115                                     </ul>
 116                                 {{/if}}
 117                             </li>
 118                             {{/props}}
 119                         </ul>
 120                     {{/if}}
 121                 </li>
 122             {{/params}}
 123             </ul>
 124         </div>
 125     {{/if}}
 126
 127
 128     {{#example}}
 129         <div class="example">
 130             <h4>Example:</h4>
 131
 132             <div class="example-content">
 133                 {{{.}}}
 134             </div>
 135         </div>
 136     {{/example}}
 137 </div>