@dragonworks/ngx-dashboard 20.0.0 → 20.0.1

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.
Files changed (2) hide show
  1. package/README.md +38 -52
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,63 +1,49 @@
1
- # NgxDashboard
1
+ # @dragonworks/ngx-dashboard
2
2
 
3
- This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.0.0.
3
+ Core Angular library for building drag-and-drop grid dashboards with resizable cells and customizable widgets.
4
4
 
5
- ## Code scaffolding
6
-
7
- Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
8
-
9
- ```bash
10
- ng generate component component-name
11
- ```
12
-
13
- For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
5
+ ## Installation
14
6
 
15
7
  ```bash
16
- ng generate --help
8
+ npm install @dragonworks/ngx-dashboard
17
9
  ```
18
10
 
19
- ## Building
20
-
21
- To build the library, run:
22
-
23
- ```bash
24
- ng build ngx-dashboard
25
- ```
26
-
27
- This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
28
-
29
- ### Publishing the Library
30
-
31
- Once the project is built, you can publish your library by following these steps:
32
-
33
- 1. Navigate to the `dist` directory:
34
- ```bash
35
- cd dist/ngx-dashboard
36
- ```
37
-
38
- 2. Run the `npm publish` command to publish your library to the npm registry:
39
- ```bash
40
- npm publish
41
- ```
42
-
43
- ## Running unit tests
44
-
45
- To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
46
-
47
- ```bash
48
- ng test
11
+ ## Features
12
+
13
+ - Grid-based drag and drop with collision detection
14
+ - Resizable cells with boundary constraints
15
+ - Editor and viewer modes
16
+ - NgRx Signals state management
17
+ - Context menu with Material Design
18
+ - Extensible widget system
19
+ - 100% OnPush change detection
20
+
21
+ ## Usage
22
+
23
+ ```typescript
24
+ import { DashboardComponent, createEmptyDashboard } from '@dragonworks/ngx-dashboard';
25
+ import { provideNgxDashboard } from '@dragonworks/ngx-dashboard';
26
+
27
+ @Component({
28
+ template: `
29
+ <ngx-dashboard
30
+ [dashboardData]="dashboard"
31
+ [editMode]="true"
32
+ (dashboardChange)="onDashboardChange($event)">
33
+ </ngx-dashboard>
34
+ `,
35
+ imports: [DashboardComponent],
36
+ providers: [provideNgxDashboard()]
37
+ })
38
+ export class MyComponent {
39
+ dashboard = createEmptyDashboard('my-dashboard', 12, 8);
40
+ }
49
41
  ```
50
42
 
51
- ## Running end-to-end tests
52
-
53
- For end-to-end (e2e) testing, run:
54
-
55
- ```bash
56
- ng e2e
57
- ```
43
+ ## Documentation
58
44
 
59
- Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
45
+ See the [main repository](https://github.com/dragonworks/ngx-dashboard) for full documentation and examples.
60
46
 
61
- ## Additional Resources
47
+ ## License
62
48
 
63
- For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
49
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dragonworks/ngx-dashboard",
3
- "version": "20.0.0",
3
+ "version": "20.0.1",
4
4
  "peerDependencies": {
5
5
  "@angular/common": "^20.0.0",
6
6
  "@angular/core": "^20.0.0",