Skip to content

docs: improve properties and methods template #32071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve properties and methods template #32071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/src/styles/_api.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@
.docs-api-method-parameters-header-cell,
.docs-api-method-returns-header-cell {
font-size: 14px;
padding-bottom: 0;
}

.docs-api-input-marker,
Expand Down
32 changes: 32 additions & 0 deletions docs/src/styles/_tables.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,38 @@
height: 56px;
}

.docs-api-method-card,
.docs-api-properties-card {
background-color: var(--mat-sys-surface-container-lowest);
border: solid 1px var(--mat-sys-outline-variant);
border-radius: 12px;
margin: 0 0 32px;
}

.docs-api-method-table,
.docs-api-properties-table {
margin: 0 !important;
}

.docs-api-method-table tr {
border-bottom: 0;

th.docs-api-method-name-cell .docs-api-method-parameter-name {
color: var(--mat-sys-on-surface);
}
}

.docs-api-properties-table {
.docs-api-properties-row:last-of-type {
border-bottom: 0;
}

.docs-api-property-type {
color: var(--mat-sys-primary);
}
}


@media (max-width: constants.$small-breakpoint-width) {
.docs-api table,
.docs-markdown > table {
Expand Down
146 changes: 77 additions & 69 deletions tools/dgeni/templates/method.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,77 +1,85 @@
{% import "macros.html" as macros %}

<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">
{%- if method.isDeprecated -%}
<div class="docs-api-deprecated-marker" {$ macros.deprecationTitle(method) $}>
Deprecated
<div class="docs-api-method-card">
<table class="docs-api-method-table">
<thead>
<tr class="docs-api-method-name-row">
<th colspan="2" class="docs-api-method-name-cell">
{%- if method.isDeprecated -%}
<div class="docs-api-deprecated-marker" {$ macros.deprecationTitle(method) $}>
Deprecated
</div>
{%- endif -%}
{%- if method.isStatic -%}
<div class="docs-api-modifier-method-marker">
static
</div>
{%- endif -%}
{%- if method.isStatic -%}
<div class="docs-api-modifier-method-marker">
static
</div>
{%- endif -%}
{%- if method.isAsync -%}
<div class="docs-api-modifier-method-marker">
async
</div>
{%- endif -%}
{$ method.name $}
</th>
{%- endif -%}
{%- if method.isAsync -%}
<div class="docs-api-modifier-method-marker">
async
</div>
{%- endif -%}
{$ method.name $}
({%- for param in method.params -%}
<span class="docs-api-method-parameter-name">{$ param.name $}{% if param.isOptional %}<span class="docs-api-method-parameter-optional-marker">?</span>{% endif %}:
</span>
<code class="docs-api-method-parameter-type">{$ param.type $}</code>{% if not loop.last %}, {% endif %}
{%- endfor -%}
): <code class="docs-api-method-returns-type">{$ method.type $}</code>
</th>
</tr>
</thead>
{%- if method.description -%}
<tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
{$ method.description | marked | safe $}
</td>
</tr>
</thead>
{%- if method.description -%}
<tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
{$ method.description | marked | safe $}
</td>
</tr>
{%- endif -%}
{%- endif -%}

{%- if method.params.length -%}
<thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
{%- if method.params.length -%}
<thead>
<tr class="docs-api-method-parameters-header-row">
<th colspan="2" class="docs-api-method-parameters-header-cell">Parameters</th>
</tr>
</thead>
{% for parameter in method.params %}
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
{$ parameter.name $}
{%- if parameter.isOptional -%}
<span class="docs-api-method-parameter-optional-marker">?</span>
{%- endif -%}
</p>
<code class="docs-api-method-parameter-type">{$ parameter.type $}</code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
{$ parameter.description | marked | safe $}
</p>
</td>
</tr>
</thead>
{% for parameter in method.params %}
<tr class="docs-api-method-parameter-row">
<td class="docs-api-method-parameter-cell">
<p class="docs-api-method-parameter-name">
{$ parameter.name $}
{%- if parameter.isOptional -%}
<span class="docs-api-method-parameter-optional-marker">?</span>
{%- endif -%}
</p>
<code class="docs-api-method-parameter-type">{$ parameter.type $}</code>
</td>
<td class="docs-api-method-parameter-description-cell">
<p class="docs-api-method-parameter-description">
{$ parameter.description | marked | safe $}
</p>
</td>
</tr>
{% endfor %}
{%- endif -%}
{% endfor %}
{%- endif -%}

{%- if method.type and method.type !== "void" -%}
<thead>
<tr class="docs-api-method-returns-header-row">
<th colspan="2" class="docs-api-method-returns-header-cell">Returns</th>
{%- if method.type and method.type !== "void" -%}
<thead>
<tr class="docs-api-method-returns-header-row">
<th colspan="2" class="docs-api-method-returns-header-cell">Returns</th>
</tr>
</thead>
<tr>
<td class="docs-api-method-returns-type-cell">
<code class="docs-api-method-returns-type">{$ method.type $}</code>
</td>
<td class="docs-api-method-returns-description-cell">
<p class="docs-api-method-returns-description">
{$ method.returns.description | marked | safe $}
</p>
</td>
</tr>
</thead>
<tr>
<td class="docs-api-method-returns-type-cell">
<code class="docs-api-method-returns-type">{$ method.type $}</code>
</td>
<td class="docs-api-method-returns-description-cell">
<p class="docs-api-method-returns-description">
{$ method.returns.description | marked | safe $}
</p>
</td>
</tr>
{%- endif -%}
</table>
{%- endif -%}
</table>
</div>
20 changes: 11 additions & 9 deletions tools/dgeni/templates/property-list.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
{%- if propertyList.length -%}
<h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
<table class="docs-api-properties-table">
<tr class="docs-api-properties-header-row">
<th class="docs-api-properties-th">Name</th>
<th class="docs-api-properties-th">Description</th>
</tr>
{% for p in propertyList %}
{$ property(p) $}
{% endfor %}
</table>
<div class="docs-api-properties-card">
<table class="docs-api-properties-table">
<tr class="docs-api-properties-header-row">
<th class="docs-api-properties-th">Name</th>
<th class="docs-api-properties-th">Description</th>
</tr>
{% for p in propertyList %}
{$ property(p) $}
{% endfor %}
</table>
</div>
{%- endif -%}
2 changes: 1 addition & 1 deletion tools/dgeni/templates/property.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
{%- endif -%}

<p class="docs-api-property-name">
<code>{%- if property.isStatic -%}static&nbsp;{%- endif -%}{$ property.name $}: {$ property.type $}</code>
<code>{%- if property.isStatic -%}static&nbsp;{%- endif -%}{$ property.name $}: <code class="docs-api-property-type">{$ property.type $}</code></code>
</p>
</td>
<td class="docs-api-property-description">{$ property.description | marked | safe $}</td>
Expand Down
Loading