i-tech-shared-components 1.0.0 → 1.0.1-7.beta

package/README.md

@@ -1,24 +1,87 @@
-# SharedComponents
+# i-tech-material-shared-components
+
+A library of Angular Material-based components designed for seamless integration and scalability.
+
+## Installation
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.0.
 
 ## Code scaffolding
+**i-tech-shared-components**
+
+***
+
+# i-tech-shared-components
+
+## Modules
+
+- [docs/components/autocomplete-select/autocomplete-select.component](docs/components/autocomplete-select/autocomplete-select.component/README.md)
+- [docs/components/button/button.component](docs/components/button/button.component/README.md)
+- [docs/components/clear-value/clear-value.component](docs/components/clear-value/clear-value.component/README.md)
+- [docs/components/date-picker/date-picker.component](docs/components/date-picker/date-picker.component/README.md)
+- [docs/components/date-range-datepicker/date-range-datepicker.component](docs/components/date-range-datepicker/date-range-datepicker.component/README.md)
+- [docs/components/icon-button/icon-button.component](docs/components/icon-button/icon-button.component/README.md)
+- [docs/components/label/label.component](docs/components/label/label.component/README.md)
+- [docs/components/menu/menu.component](docs/components/menu/menu.component/README.md)
+- [docs/components/text/text-input.component](docs/components/text/text-input.component/README.md)
+- [docs/interfaces/app-input.interface](docs/interfaces/app-input.interface/README.md)
+- [docs/interfaces/autocomplete-configs.interface](docs/interfaces/autocomplete-configs.interface/README.md)
+- [docs/interfaces/button-types.enum](docs/interfaces/button-types.enum/README.md)
+- [docs/interfaces/dropdown-selection.constants](docs/interfaces/dropdown-selection.constants/README.md)
+- [docs/interfaces/label-type.enum](docs/interfaces/label-type.enum/README.md)
+- [docs/services/input.service](docs/services/input.service/README.md)
+
+
+Install the library using npm:
+
+```bash
+npm install i-tech-shared-components
 
-Run `ng generate component component-name --project shared-components` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project shared-components`.
-> Note: Don't forget to add `--project shared-components` or else it will be added to the default project in your `angular.json` file. 
+#### **Code Blocks**
+```markdown
+### Button Component
+```html
+<i-tech-button
+  (buttonClick)="handleClick()"
+  [customClass]="'your-custom-class'"
+  [text]="'Click me'"
+  [disabled]="false"
+  [submit]="false"
+  [icon]="'add'">
+</i-tech-button>
 
-## Build
 
-Run `ng build shared-components` to build the project. The build artifacts will be stored in the `dist/` directory.
 
-## Publishing
+#### **Tables**
+```markdown
+| Input      | Type      | Default  | Description                                                                     |
+|------------|-----------|----------|---------------------------------------------------------------------------------|
+| `type`     | `string`  | `FILLED` | Button type (e.g., FILLED, TEXT).                                               |
+| `disabled` | `boolean` | `false`  | Disables the button when true.                                                  |
+| `icon`     | `string`  | `add`    | Set a material or font icon, also you can register and submit your own SVG.     |
 
-After building your library with `ng build shared-components`, go to the dist folder `cd dist/shared-components` and run `npm publish`.
 
-## Running unit tests
+```html
+<i-tech-icon-button
+   (buttonClick)="handleClick()"
+   [iconName]="'add'"
+   [tooltip]="'show info'"
+   [size]="'small'">
+</i-tech-icon-button>
 
-Run `ng test shared-components` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-## Further help
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+#### **Tables**
+```markdown
+| Input      | Type      | Default  | Description                                                                     |
+|------------|-----------|----------|---------------------------------------------------------------------------------|
+| `type`     | `string`  | `FILLED` | Button type (e.g., FILLED, TEXT).                                               |
+| `size`     | `string`  | `FILLED` | Button size (medium, small).                                                    |
+| `disabled` | `boolean` | `false`  | Disables the button when true.                                                  |
+| `iconName` | `string`  | `add`    | Set a material or font icon.                                                    |
+| `iconSvg`  | `string`  | `add`    | You can register and submit your own SVG.                                       |
+| `tooltip`  | `string`  | `add`    | Information about work of icon button.     
+                                     
+```markdown
+| Output       |  Type      | Default  | Description                                                                  |
+|--------------|------------|----------|------------------------------------------------------------------------------|
+| `buttonClick`| `void`     | `void`   | For output and handle icon click.                                            |                                        |

package/docs/README.md

@@ -0,0 +1,23 @@
+**i-tech-shared-components**
+
+***
+
+# i-tech-shared-components
+
+## Modules
+
+- [docs/components/autocomplete-select/autocomplete-select.component](components/autocomplete-select/autocomplete-select.component/README.md)
+- [docs/components/button/button.component](components/button/button.component/README.md)
+- [docs/components/clear-value/clear-value.component](components/clear-value/clear-value.component/README.md)
+- [docs/components/date-picker/date-picker.component](components/date-picker/date-picker.component/README.md)
+- [docs/components/date-range-datepicker/date-range-datepicker.component](components/date-range-datepicker/date-range-datepicker.component/README.md)
+- [docs/components/icon-button/icon-button.component](components/icon-button/icon-button.component/README.md)
+- [docs/components/label/label.component](components/label/label.component/README.md)
+- [docs/components/menu/menu.component](components/menu/menu.component/README.md)
+- [docs/components/text/text-input.component](components/text/text-input.component/README.md)
+- [docs/interfaces/app-input.interface](interfaces/app-input.interface/README.md)
+- [docs/interfaces/autocomplete-configs.interface](interfaces/autocomplete-configs.interface/README.md)
+- [docs/interfaces/button-types.enum](interfaces/button-types.enum/README.md)
+- [docs/interfaces/dropdown-selection.constants](interfaces/dropdown-selection.constants/README.md)
+- [docs/interfaces/label-type.enum](interfaces/label-type.enum/README.md)
+- [docs/services/input.service](services/input.service/README.md)

package/docs/components/autocomplete-select/autocomplete-select.component/README.md

@@ -0,0 +1,13 @@
+[**i-tech-shared-components**](../../../README.md)
+
+***
+
+[i-tech-shared-components](../../../README.md) / components/autocomplete-select/autocomplete-select.component
+
+# components/autocomplete-select/autocomplete-select.component
+
+## Index
+
+### Classes
+
+- [AutocompleteSelectComponent](classes/AutocompleteSelectComponent.md)