@meshmakers/shared-ui 3.3.34 → 3.3.390

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 CHANGED
@@ -1,24 +1,52 @@
1
- # SharedUi
1
+ # @meshmakers/shared-ui
2
2
 
3
- This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.2.0.
3
+ Angular UI component library for Octo Mesh Platform applications.
4
4
 
5
- ## Code scaffolding
5
+ Includes list views, confirmation dialogs, cron builder, tree view, entity select input, file upload, and more.
6
6
 
7
- Run `ng generate component component-name --project shared-ui` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project shared-ui`.
8
- > Note: Don't forget to add `--project shared-ui` or else it will be added to the default project in your `angular.json` file.
7
+ Part of the [@meshmakers](https://www.npmjs.com/org/meshmakers) package ecosystem.
9
8
 
10
- ## Build
9
+ **Note:** This library requires a [Kendo UI for Angular](https://www.telerik.com/kendo-angular-ui) license.
10
+
11
+ ## Installation
12
+
13
+ ```bash
14
+ npm install @meshmakers/shared-ui
15
+ ```
16
+
17
+ ## Key Components
11
18
 
12
- Run `ng build shared-ui` to build the project. The build artifacts will be stored in the `dist/` directory.
19
+ | Component | Selector | Description |
20
+ |-----------|----------|-------------|
21
+ | `ListViewComponent` | `mm-list-view` | Configurable list/grid view with search, pagination |
22
+ | `ConfirmationWindowComponent` | - | Confirmation dialog via `ConfirmationService` |
23
+ | `CronBuilderComponent` | `mm-cron-builder` | Visual cron expression editor |
24
+ | `TreeComponent` | `mm-tree` | Hierarchical tree view |
25
+ | `EntitySelectInputComponent` | `mm-entity-select-input` | Entity autocomplete input |
26
+ | `BaseFormComponent` | `mm-base-form` | Form wrapper with save/cancel |
27
+ | `CopyableTextComponent` | `mm-copyable-text` | Text with copy-to-clipboard |
13
28
 
14
- ## Publishing
29
+ ## Key Services
30
+
31
+ | Service | Description |
32
+ |---------|-------------|
33
+ | `ConfirmationService` | Show confirmation dialogs |
34
+ | `FileUploadService` | File upload dialog |
35
+ | `InputService` | Text input dialog |
36
+ | `NotificationDisplayService` | Toast notifications |
37
+
38
+ ## Build
15
39
 
16
- After building your library with `ng build shared-ui`, go to the dist folder `cd dist/shared-ui` and run `npm publish`.
40
+ ```bash
41
+ npm run build:shared-ui
42
+ ```
17
43
 
18
- ## Running unit tests
44
+ ## Test
19
45
 
20
- Run `ng test shared-ui` to execute the unit tests via [Karma](https://karma-runner.github.io).
46
+ ```bash
47
+ npm test -- --project=@meshmakers/shared-ui --watch=false
48
+ ```
21
49
 
22
- ## Further help
50
+ ## Documentation
23
51
 
24
- To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
52
+ See [Octo Mesh Platform documentation](https://docs.meshmakers.cloud).