Skip to content

Commit 6990b4c

Browse files
committed
feat(showcase): add more API doc layout
1 parent 91ce1b2 commit 6990b4c

2 files changed

Lines changed: 70 additions & 14 deletions

File tree

projects/showcase/src/app/feature/doc/api/api.component.ts

Lines changed: 69 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,76 @@ import { MatListModule } from '@angular/material/list';
2424
2525
<div class="flex flex-col gap-8">
2626
@for (property of interface.properties; track property.name) {
27-
<div
28-
class="flex flex-col items-baseline gap-2 md:flex-row md:gap-6 "
29-
>
30-
<div class="flex min-w-72 flex-col items-start gap-2">
31-
<code>{{ property.name }}: {{ property.type }}</code>
27+
<div class="p-4 odd:bg-gray-50 dark:odd:bg-gray-900">
28+
<div
29+
class="grid grid-cols-1 gap-2 rounded-lg md:grid-cols-4 md:gap-6"
30+
>
31+
<div class="flex flex-col items-start gap-2">
32+
<code>{{ property.name }}: {{ property.type }}</code>
33+
</div>
34+
<div class="flex-col gap-4 md:col-span-3">
35+
<p class="text-sm">
36+
{{ property.description }}
37+
@if (property.defaultValue) {
38+
<div class="pt-4">
39+
Default value
40+
<code>{{ property.defaultValue }}</code>
41+
</div>
42+
}
43+
</p>
44+
</div>
3245
</div>
33-
<p class="text-sm">
34-
{{ property.description }}
35-
@if (property.defaultValue) {
36-
<div class="pt-4">
37-
Default value <code>{{ property.defaultValue }}</code>
38-
</div>
39-
}
40-
</p>
46+
@if (property.properties?.length) {
47+
<div class="mt-10 ml-8 flex flex-col gap-10">
48+
@for (
49+
subprop of property.properties;
50+
track subprop.name
51+
) {
52+
<div
53+
class="grid grid-cols-1 gap-2 md:grid-cols-4 md:gap-6"
54+
>
55+
<div class="flex flex-col items-start gap-2">
56+
<code class="whitespace-nowrap"
57+
>{{ subprop.name }}: {{ subprop.type }}</code
58+
>
59+
</div>
60+
<div class="md:col-span-3 md:-ml-6">
61+
<p class="text-sm">
62+
{{ subprop.description }}
63+
@if (subprop.defaultValue) {
64+
<div class="pt-4">
65+
Default value
66+
<code>{{ subprop.defaultValue }}</code>
67+
</div>
68+
}
69+
@if (subprop.properties?.length) {
70+
<div class="mt-8">
71+
<div class="flex flex-col gap-4">
72+
@for (
73+
subsubprop of subprop.properties;
74+
track subsubprop.name
75+
) {
76+
<div class="flex flex-row gap-4">
77+
<div>
78+
<code class="whitespace-nowrap"
79+
>{{ subsubprop.name }}:
80+
{{ subsubprop.type }}</code
81+
>
82+
</div>
83+
<span class=" flex-1">{{
84+
subsubprop.description
85+
}}</span>
86+
</div>
87+
}
88+
</div>
89+
</div>
90+
}
91+
</p>
92+
</div>
93+
</div>
94+
}
95+
</div>
96+
}
4197
</div>
4298
}
4399
</div>

projects/showcase/src/styles.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
}
2929

3030
code {
31-
@apply bg-slate-100 dark:bg-slate-700 rounded-lg px-4 py-1 overflow-x-auto text-sm;
31+
@apply bg-slate-200 dark:bg-slate-600 rounded-xl px-3 py-1 overflow-x-auto text-sm;
3232
}
3333
}
3434

0 commit comments

Comments
 (0)