i-tech-shared-components 1.0.16 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -52
- package/docs/README.md +57 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,61 +14,10 @@ A library of Angular Material-based components designed for seamless integration
|
|
|
14
14
|
|
|
15
15
|
## Modules
|
|
16
16
|
|
|
17
|
-
- [
|
|
18
|
-
|
|
17
|
+
- [Main Documentation](https://gitlab.com/a.karapetyan/t3_ui_kit/-/tree/documentation/projects/shared-components/docs)
|
|
19
18
|
|
|
20
19
|
|
|
21
20
|
Install the library using npm:
|
|
22
21
|
|
|
23
22
|
```bash
|
|
24
23
|
npm install i-tech-shared-components
|
|
25
|
-
|
|
26
|
-
#### **Code Blocks**
|
|
27
|
-
```markdown
|
|
28
|
-
### Button Component
|
|
29
|
-
```html
|
|
30
|
-
<i-tech-button
|
|
31
|
-
(buttonClick)="handleClick()"
|
|
32
|
-
[customClass]="'your-custom-class'"
|
|
33
|
-
[text]="'Click me'"
|
|
34
|
-
[disabled]="false"
|
|
35
|
-
[submit]="false"
|
|
36
|
-
[icon]="'add'">
|
|
37
|
-
</i-tech-button>
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
#### **Tables**
|
|
42
|
-
```markdown
|
|
43
|
-
| Input | Type | Default | Description |
|
|
44
|
-
|------------|-----------|----------|---------------------------------------------------------------------------------|
|
|
45
|
-
| `type` | `string` | `FILLED` | Button type (e.g., FILLED, TEXT). |
|
|
46
|
-
| `disabled` | `boolean` | `false` | Disables the button when true. |
|
|
47
|
-
| `icon` | `string` | `add` | Set a material or font icon, also you can register and submit your own SVG. |
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
```html
|
|
51
|
-
<i-tech-icon-button
|
|
52
|
-
(buttonClick)="handleClick()"
|
|
53
|
-
[iconName]="'add'"
|
|
54
|
-
[tooltip]="'show info'"
|
|
55
|
-
[size]="'small'">
|
|
56
|
-
</i-tech-icon-button>
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
#### **Tables**
|
|
61
|
-
```markdown
|
|
62
|
-
| Input | Type | Default | Description |
|
|
63
|
-
|------------|-----------|----------|---------------------------------------------------------------------------------|
|
|
64
|
-
| `type` | `string` | `FILLED` | Button type (e.g., FILLED, TEXT). |
|
|
65
|
-
| `size` | `string` | `FILLED` | Button size (medium, small). |
|
|
66
|
-
| `disabled` | `boolean` | `false` | Disables the button when true. |
|
|
67
|
-
| `iconName` | `string` | `add` | Set a material or font icon. |
|
|
68
|
-
| `iconSvg` | `string` | `add` | You can register and submit your own SVG. |
|
|
69
|
-
| `tooltip` | `string` | `add` | Information about work of icon button.
|
|
70
|
-
|
|
71
|
-
```markdown
|
|
72
|
-
| Output | Type | Default | Description |
|
|
73
|
-
|--------------|------------|----------|------------------------------------------------------------------------------|
|
|
74
|
-
| `buttonClick`| `void` | `void` | For output and handle icon click. | |
|
package/docs/README.md
CHANGED
|
@@ -21,3 +21,60 @@
|
|
|
21
21
|
- [docs/interfaces/dropdown-selection.constants](interfaces/dropdown-selection.constants/README.md)
|
|
22
22
|
- [docs/interfaces/label-type.enum](interfaces/label-type.enum/README.md)
|
|
23
23
|
- [docs/services/input.service](services/input.service/README.md)
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
#### **Code Blocks**
|
|
30
|
+
```markdown
|
|
31
|
+
Here shown example how can use components
|
|
32
|
+
```
|
|
33
|
+
### Button Component
|
|
34
|
+
```html
|
|
35
|
+
<i-tech-button
|
|
36
|
+
(buttonClick)="handleClick()"
|
|
37
|
+
[customClass]="'your-custom-class'"
|
|
38
|
+
[text]="'Click me'"
|
|
39
|
+
[disabled]="false"
|
|
40
|
+
[submit]="false"
|
|
41
|
+
[icon]="'add'">
|
|
42
|
+
</i-tech-button>
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
#### **Tables**
|
|
47
|
+
```markdown
|
|
48
|
+
| Input | Type | Default | Description |
|
|
49
|
+
|------------|-----------|----------|---------------------------------------------------------------------------------|
|
|
50
|
+
| `type` | `string` | `FILLED` | Button type (e.g., FILLED, TEXT). |
|
|
51
|
+
| `disabled` | `boolean` | `false` | Disables the button when true. |
|
|
52
|
+
| `icon` | `string` | `add` | Set a material or font icon, also you can register and submit your own SVG. |
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
### Icon Button Component
|
|
56
|
+
```html
|
|
57
|
+
<i-tech-icon-button
|
|
58
|
+
(buttonClick)="handleClick()"
|
|
59
|
+
[iconName]="'add'"
|
|
60
|
+
[tooltip]="'show info'"
|
|
61
|
+
[size]="'small'">
|
|
62
|
+
</i-tech-icon-button>
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
#### **Tables**
|
|
67
|
+
```markdown
|
|
68
|
+
| Input | Type | Default | Description |
|
|
69
|
+
|------------|-----------|----------|---------------------------------------------------------------------------------|
|
|
70
|
+
| `type` | `string` | `FILLED` | Button type (e.g., FILLED, TEXT). |
|
|
71
|
+
| `size` | `string` | `FILLED` | Button size (medium, small). |
|
|
72
|
+
| `disabled` | `boolean` | `false` | Disables the button when true. |
|
|
73
|
+
| `iconName` | `string` | `add` | Set a material or font icon. |
|
|
74
|
+
| `iconSvg` | `string` | `add` | You can register and submit your own SVG. |
|
|
75
|
+
| `tooltip` | `string` | `add` | Information about work of icon button.
|
|
76
|
+
|
|
77
|
+
```markdown
|
|
78
|
+
| Output | Type | Default | Description |
|
|
79
|
+
|--------------|------------|----------|------------------------------------------------------------------------------|
|
|
80
|
+
| `buttonClick`| `void` | `void` | For output and handle icon click. | |
|