Skip to content

Commit 26b6417

Browse files
chintankavathiaspike-rabbit
authored andcommitted
docs(dashboards-ng): use absolute urls
use absolute urls as relative urls will not work on npm.
1 parent 0c8371c commit 26b6417

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

projects/dashboards-ng/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Usage
44

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
66
to integrate the Siemens Dashboards library in your project.
77

88
### Install dependencies
@@ -173,11 +173,11 @@ The widget instance component has to implement the `WidgetInstance` interface an
173173
editor has to implement the `WidgetInstanceEditor` interface. You have to provide a
174174
module loader function that is used to load the widget when needed.
175175

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.
177177

178178
E.g. a widget implements a user interface that is added at runtime into the body of a dashboard card.
179179
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).
181181
The Angular component should export the template as the public attribute `footer`.
182182

183183
```ts
@@ -187,7 +187,7 @@ The Angular component should export the template as the public attribute `footer
187187
### Dashboard persistence
188188

189189
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
191191
`SiDefaultWidgetStorage` uses the `Storage` implementation `sessionStorage`. You can set a different
192192
`Storage` like the `localStorage` by providing the `DEFAULT_WIDGET_STORAGE_TOKEN` in the related module.
193193

@@ -196,7 +196,7 @@ providers: [..., { provide: DEFAULT_WIDGET_STORAGE_TOKEN, useValue: localStorage
196196
```
197197

198198
For persistence in a backend service, you should implement your own
199-
[SiWidgetStorage](./projects/dashboards-ng/src/model/si-widget-storage.ts) and provide it in
199+
[SiWidgetStorage](https://github.com/siemens/element/blob/main/projects/dashboards-ng/src/model/si-widget-storage.ts) and provide it in
200200
the library module definition.
201201

202202
```ts
@@ -213,17 +213,17 @@ SiDashboardsNgModule.forRoot({
213213

214214
The dashboard is configurable through the Angular inputs of the exposed components and by
215215
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).
217217

218218
To configure all dashboard instances, you can leverage dependency injection when importing
219219
the `SiDashboardsNgModule` using `SiDashboardsNgModule.forRoot({...})`.
220220
Alternatively, you have the option to configure individual dashboard instances by setting
221221
the input property `SiFlexibleDashboardComponent.config = {...}`.
222222

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)
224224

225225
## License
226226

227227
Code and documentation Copyright (c) Siemens 2016 - 2025
228228

229-
See [LICENSE.md](../../LICENSE.md).
229+
See [LICENSE.md](https://github.com/siemens/element/blob/main/LICENSE.md).

0 commit comments

Comments
 (0)