build(aio): improve the API Pipe pages (#22702)

This change adds:

* an impure badge for Pipes that are marked as  `pure: false`
* a pipe specific overview that shows the syntax for using a pipe in a template.
* an "input value" section describing the type of the value that the pipe expects.
* a "pipe params" section describing any additional params that a pipe expects.

PR Close #22702
This commit is contained in:
Pete Bacon Darwin
2018-03-11 09:42:49 +00:00
committed by Kara Erickson
parent cd2ebd22fd
commit d509bd6849
10 changed files with 123 additions and 2 deletions

View File

@ -11,19 +11,20 @@
{%- if returnType %}: {$ returnType | escape $}{% endif -%}
{%- endmacro -%}
{%- macro renderParameters(parameters, containerClass, parameterClass) -%}
{%- macro renderParameters(parameters, containerClass, parameterClass, showType) -%}
{%- if parameters.length -%}
<table class="is-full-width list-table parameters-table {$ containerClass $}">
<tbody>
{% for parameter in parameters %}
<tr class="{$ parameterClass $}">
<td class="param-name"><a id="{$ parameter.anchor $}"></a>{$ parameter.name $}</td>
{% if showType %}<td class="param-type"><code>{$ parameter.type $}</code></td>{% endif %}
<td class="param-description">
{% marked %}
{% if parameter.isOptional or parameter.defaultValue !== undefined %}Optional. Default is `{$ parameter.defaultValue === undefined and 'undefined' or parameter.defaultValue $}`.{% endif %}
{% if parameter.description | trim %}{$ parameter.description $}
{% elseif parameter.type %}<code>{$ parameter.type $}</code>
{% elseif not showType and parameter.type %}<p>Type: <code>{$ parameter.type $}</code>.</p>
{% endif %}
{% endmarked %}
</td>