dgeni-alive/src/templates/lib/events.template.html

Live doc generator on top of Dgeni

{%- if doc.events %}
<h2>Events</h2>
<ul class="events">
  {%- for event in doc.events %}
  <li id="{$ event.name $}">
    <h3 class="{% if event.deprecated != null %}member-deprecated{% endif %}">
      <span class="title">{$ event.name | code $}</span>
      {$ lib.deprecatedOrSince(event) $}
    </h3>
    <div>{$ event.description | marked $}</div>
    {%- if event.eventType == 'listen' %}
    <div class="inline">
      <h4>Listen on: {$ event.eventTarget $}</h4>
    </div>
    {%- else %}
    <div class="inline">
      <h4>Type:</h4>
      <div class="type">{$ event.eventType $}</div>
    </div>
    <div class="inline">
      <h4>Target:</h4>
      <div class="target">{$ event.eventTarget $}</div>
    </div>
    {% endif -%}
    {%- if event.params %}
    <section class="api-section">
      <h3>Parameters</h3>
      {$ lib.paramTable(event.params) $}
    </section>
    {%- endif -%}
    {% block usage %}
    {%- if event.eventType == 'emit' or event.eventType == 'broadcast' %}
    <section class="api-section">
      <h4 id="usage">Usage</h4>
      <div class="usage">
        {% if doc.usage -%}
          {$ doc.usage | marked $}
        {% else -%}
          {% code %}
          {$ event.eventTarget $}.$on('{$ event.name $}', function (evt{%- for param in event.params %}, {$ param.alias or param.name $}{%- endfor %}) {
            ...
          });
          {% endcode %}
        {% endif -%}
    </section>
    {%- endif %}
    {% endblock -%}
  </li>
  {% endfor -%}
</ul>
{% endif -%}