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

   1 <div id="attr_{{name}}" class="attr item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">
   2     <a name="config_{{name}}"></a> {{! For backwards compatibility }}
   3     <h3 class="name"><code>{{name}}</code></h3>
   4     <span class="type">{{#crossLink type}}{{/crossLink}}</span>
   5
   6     {{#if deprecated}}
   7         <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span>
   8     {{/if}}
   9
  10     {{#if access}}
  11         <span class="flag {{access}}">{{access}}</span>
  12     {{/if}}
  13
  14     {{#if final}}
  15         <span class="flag final">final</span>
  16     {{/if}}
  17
  18     {{#if static}}
  19         <span class="flag static">static</span>
  20     {{/if}}
  21
  22     {{#if optional}}
  23         <span class="flag optional">optional</span>
  24     {{/if}}
  25
  26     {{#if required}}
  27         <span class="flag required">required</span>
  28     {{/if}}
  29
  30     {{#if readonly}}
  31         <span class="flag readonly">readonly</span>
  32     {{/if}}
  33
  34     <div class="meta">
  35         {{#if overwritten_from}}
  36             <p>Inherited from
  37             <a href="{{crossLinkRaw overwritten_from/class}}#attr_{{overwritten_from/name}}">
  38                 {{overwritten_from/class}}
  39             </a>
  40             {{#if foundAt}}
  41             but overwritten in
  42             {{/if}}
  43         {{else}}
  44             {{#if extended_from}}
  45                 <p>Inherited from
  46                 <a href="{{crossLinkRaw extended_from}}#attr_{{name}}">{{extended_from}}</a>:
  47             {{else}}
  48                 {{#providedBy}}
  49                     <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p>
  50                 {{/providedBy}}
  51                 <p>
  52                 {{#if foundAt}}
  53                 Defined in
  54                 {{/if}}
  55             {{/if}}
  56         {{/if}}
  57         {{#if foundAt}}
  58         <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
  59         {{/if}}
  60         </p>
  61
  62         {{#if deprecationMessage}}
  63             <p>Deprecated: {{deprecationMessage}}</p>
  64         {{/if}}
  65
  66         {{#if since}}
  67             <p>Available since {{since}}</p>
  68         {{/if}}
  69     </div>
  70
  71     <div class="description">
  72         {{{attrDescription}}}
  73     </div>
  74
  75     {{#if default}}
  76         <p><strong>Default:</strong> {{default}}</p>
  77     {{/if}}
  78
  79     {{#if emit}}
  80         <div class="emits box">
  81             <h4>Fires event <code>{{name}}Change</code></h4>
  82
  83             <p>
  84             Fires when the value for the configuration attribute `{{{name}}}` is
  85             changed. You can listen for the event using the `on` method if you
  86             wish to be notified before the attribute's value has changed, or
  87             using the `after` method if you wish to be notified after the
  88             attribute's value has changed.
  89             </p>
  90
  91             <div class="params">
  92                 <h4>Parameters:</h4>
  93
  94                 <ul class="params-list">
  95                     <li class="param">
  96                         <code class="param-name">e</code>
  97                         <span class="type">{{#crossLink "EventFacade"}}{{/crossLink}}</span>
  98
  99                         <div class="param-description">
 100                             An Event Facade object with the following
 101                             attribute-specific properties added:
 102                         </div>
 103
 104                         <ul class="params-list">
 105                             <li class="param">
 106                                 <code class="param-name">prevVal</code>
 107                                 <span class="type">Any</span>
 108                                 <div class="param-description">The value of the attribute, prior to it being set.</div>
 109                             </li>
 110                             <li class="param">
 111                                 <code class="param-name">newVal</code>
 112                                 <span class="type">Any</span>
 113                                 <div class="param-description">The value the attribute is to be set to.</div>
 114                             </li>
 115                             <li class="param">
 116                                 <code class="param-name">attrName</code>
 117                                 <span class="type">{{#crossLink "String"}}{{/crossLink}}</span>
 118                                 <div class="param-description">The name of the attribute being set.</div>
 119                             </li>
 120                             <li class="param">
 121                                 <code class="param-name">subAttrName</code>
 122                                 <span class="type">{{#crossLink "String"}}{{/crossLink}}</span>
 123                                 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
 124                             </li>
 125                         </ul>
 126                     </li>
 127                 </ul>
 128             </div>
 129         </div>
 130     {{/if}}
 131
 132     {{#example}}
 133         <div class="example">
 134             <h4>Example:</h4>
 135
 136             <div class="example-content">
 137                 {{{.}}}
 138             </div>
 139         </div>
 140     {{/example}}
 141 </div>