You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: projects/dashboards-ng/README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Usage
4
4
5
-
Check out our [dashboard demo project](../dashboards-demo/) for examples on how
5
+
Check out our [dashboard demo project](https://github.com/siemens/element/blob/main/projects/dashboards-demo/) for examples on how
6
6
to integrate the Siemens Dashboards library in your project.
7
7
8
8
### Install dependencies
@@ -173,11 +173,11 @@ The widget instance component has to implement the `WidgetInstance` interface an
173
173
editor has to implement the `WidgetInstanceEditor` interface. You have to provide a
174
174
module loader function that is used to load the widget when needed.
175
175
176
-
The library ships with a [hello-widget](./src/app/widgets/hello-widget/) example for illustration.
176
+
The library ships with a [hello-widget](https://github.com/siemens/element/blob/main/projects/dashboards-demo/src/app/widgets/hello-widget/) example for illustration.
177
177
178
178
E.g. a widget implements a user interface that is added at runtime into the body of a dashboard card.
179
179
Optionally, the widget template may include a `<ng-template/>` to provides a footer implementation like
180
-
`<ng-template #footer><a [siLink]="link">Go to issues</a></ng-template>` in the [value-widget](./src/app/widgets/charts/value-widget.component.ts).
180
+
`<ng-template #footer><a [siLink]="link">Go to issues</a></ng-template>` in the [value-widget](https://github.com/siemens/element/blob/main/projects/dashboards-demo/src/app/widgets/charts/value-widget.component.ts).
181
181
The Angular component should export the template as the public attribute `footer`.
182
182
183
183
```ts
@@ -187,7 +187,7 @@ The Angular component should export the template as the public attribute `footer
187
187
### Dashboard persistence
188
188
189
189
The library persists a dashboard configuration by the default `SiDefaultWidgetStorage` implementation
190
-
of the API [SiWidgetStorage](./projects/dashboards-ng/src/model/si-widget-storage.ts). The
190
+
of the API [SiWidgetStorage](https://github.com/siemens/element/blob/main/projects/dashboards-ng/src/model/si-widget-storage.ts). The
191
191
`SiDefaultWidgetStorage` uses the `Storage` implementation `sessionStorage`. You can set a different
192
192
`Storage` like the `localStorage` by providing the `DEFAULT_WIDGET_STORAGE_TOKEN` in the related module.
The dashboard is configurable through the Angular inputs of the exposed components and by
215
215
the usage of the configuration object `Config`, which includes a `GridConfig` and including
216
-
the [GridStackOptions](./projects/dashboards-ng/src/model/gridstack.model.ts).
216
+
the [GridStackOptions](https://github.com/siemens/element/blob/main/projects/dashboards-ng/src/model/gridstack.model.ts).
217
217
218
218
To configure all dashboard instances, you can leverage dependency injection when importing
219
219
the `SiDashboardsNgModule` using `SiDashboardsNgModule.forRoot({...})`.
220
220
Alternatively, you have the option to configure individual dashboard instances by setting
221
221
the input property `SiFlexibleDashboardComponent.config = {...}`.
222
222
223
-
Here is the [demo](./src/app/pages/fixed-widgets-dashboard/fixed-widgets-dashboard.component.ts)
223
+
Here is the [demo](https://github.com/siemens/element/blob/main/projects/dashboards-demo/src/app/pages/fixed-widgets-dashboard/fixed-widgets-dashboard.component.ts)
224
224
225
225
## License
226
226
227
227
Code and documentation Copyright (c) Siemens 2016 - 2025
228
228
229
-
See [LICENSE.md](../../LICENSE.md).
229
+
See [LICENSE.md](https://github.com/siemens/element/blob/main/LICENSE.md).
0 commit comments