Skip to content

Commit b7e56e5

Browse files
authored
docs: add installation step (#268)
* docs: add installation step * feat: remove tests
1 parent 5ebbb80 commit b7e56e5

File tree

12 files changed

+42
-358
lines changed

12 files changed

+42
-358
lines changed

projects/docs/src/app/blueprint/source-tree/source-tree.component.html

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
11
<div
22
class="mb-3 flex flex-col items-start justify-between lg:flex-row lg:items-center"
33
>
4-
<h5 class="my-0 mb-3 text-lg font-medium">Source code</h5>
5-
<div class="flex items-center gap-2">
6-
<app-checkbox [(ngModel)]="includeTests" labelAlign="start"
7-
>Include Tests</app-checkbox
8-
>
9-
<button appButton color="primary" variant="outline" (click)="download()">
10-
Download (.zip)
11-
</button>
12-
</div>
4+
<h5 class="text-lg font-medium">Source code</h5>
135
</div>
146

157
<div class="mb-3 flex items-center justify-between">

projects/docs/src/app/blueprint/source-tree/source-tree.component.ts

+1-18
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
import { Component, inject, input, model, OnInit, signal } from '@angular/core';
22
import { FormsModule } from '@angular/forms';
3-
import { ButtonComponent } from '@/ui/button/button.component';
4-
import { CheckboxComponent } from '@/ui/checkbox/checkbox.component';
53
import { FileService } from '../../services/file.service';
64
import { SourceCodeComponent } from '../source-code/source-code.component';
75
import {
@@ -14,13 +12,7 @@ import { SourceTreeResolver } from './source-tree.resolver';
1412

1513
@Component({
1614
selector: 'doc-source-tree',
17-
imports: [
18-
SourceCodeComponent,
19-
SourceTreeSelectComponent,
20-
ButtonComponent,
21-
CheckboxComponent,
22-
FormsModule,
23-
],
15+
imports: [SourceCodeComponent, SourceTreeSelectComponent, FormsModule],
2416
templateUrl: './source-tree.component.html',
2517
styleUrl: './source-tree.component.css',
2618
})
@@ -59,13 +51,4 @@ export class SourceTreeComponent implements OnInit {
5951
this.code.set(data);
6052
});
6153
}
62-
63-
download() {
64-
const sourceTree = this.sourceTreeAlpha();
65-
this.fileService.downloadSourceTree(
66-
this.name(),
67-
sourceTree,
68-
!!this.includeTests()
69-
);
70-
}
7154
}

projects/docs/src/app/features/installation-page/installation-page.component.html

+23-4
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,15 @@
1010
<ul>
1111
<li>
1212
<a href="https://material.angular.io/cdk/categories" target="_blank">
13-
<code>&#64;angular/cdk</code>
13+
&#64;angular/cdk
1414
</a>
1515
</li>
1616
<li>
17-
<a href="https://tailwindcss.com/" target="_blank"
18-
><code>Tailwind CSS</code></a
17+
<a href="https://tailwindcss.com/" target="_blank">Tailwind CSS</a>
18+
</li>
19+
<li>
20+
<a href="https://ng-icons.github.io/ng-icons/#/" target="_blank"
21+
>ng-icons</a
1922
>
2023
</li>
2124
</ul>
@@ -63,7 +66,23 @@ <h2>Install tailwind (v4)</h2>
6366
<h2>Add Angular animations</h2>
6467
<p>We use Angular animations for smooth transition between states</p>
6568
<doc-source-code language="ts" [code]="animationsCode"></doc-source-code>
66-
69+
<h2>Installing an Icons Library (Optional)</h2>
70+
<p>
71+
Some components, such as the <code>select</code> component, require icons.
72+
We use the
73+
<a href="https://ng-icons.github.io/ng-icons/#/" target="_blank"
74+
>ng-icons</a
75+
>
76+
library (Material Icons preset) for this purpose.
77+
</p>
78+
<p>
79+
If you prefer not to use this library, you can skip this step and update the
80+
components manually when needed.
81+
</p>
82+
<doc-source-code
83+
language="bash"
84+
code=" npm install @ng-icons/core @ng-icons/material-icons"
85+
></doc-source-code>
6786
<h2>Update typescript import</h2>
6887
<p>
6988
In <doc-project-name [code]="true"></doc-project-name>, UI components use

0 commit comments

Comments
 (0)