d509bd6849
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
22 lines
947 B
HTML
22 lines
947 B
HTML
{% import "lib/memberHelpers.html" as memberHelpers -%}
|
|
{% import "lib/paramList.html" as params -%}
|
|
|
|
<section class="{$ doc.docType $}-overview">
|
|
<code-example hideCopy="true" class="no-box api-heading">{{ {$ doc.valueParam.name $}_expression | <span class="kwd nocode">{$ doc.pipeName $}</span>
|
|
{%- for param in doc.pipeParams %}
|
|
{%- if param.isOptional or param.defaultValue !== undefined %} [{% endif %} : {$ param.name $}
|
|
{%- endfor %}
|
|
{%- for param in doc.pipeParams %}
|
|
{%- if param.isOptional or param.defaultValue !== undefined %} ]{% endif %}
|
|
{%- endfor %} }}</code-example>
|
|
|
|
{% if doc.valueParam.type %}
|
|
<h2>Input Value</h2>
|
|
{$ params.renderParameters([doc.valueParam], 'pipe-parameters', 'pipe-parameter', true) $}
|
|
{% endif %}
|
|
{% if doc.pipeParams.length %}
|
|
<h2>Parameters</h2>
|
|
{$ params.renderParameters(doc.pipeParams, 'pipe-parameters', 'pipe-parameter', true) $}
|
|
{% endif %}
|
|
</section>
|