Skip to content

Commit a97906b

Browse files
authored
Merge pull request #107 from jcdcdev/dev/v15
15.1.11
2 parents aee5027 + 281f5ff commit a97906b

File tree

5 files changed

+127
-74
lines changed

5 files changed

+127
-74
lines changed

.github/README.md

Lines changed: 46 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,64 @@
11
# Umbraco.Community.SimpleDashboards
22

3-
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/umbraco.community.simpledashboards)
4-
[![GitHub License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.SimpleDashboards?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/LICENSE)
5-
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.SimpleDashboards?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards/)
3+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleDashboards)
4+
[![License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.SimpleDashboards?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards?tab=MIT-1-ov-file)
5+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.SimpleDashboards?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards)
66
[![Project Website](https://img.shields.io/badge/Project%20Website-jcdc.dev-jcdcdev?style=flat&color=3c4834&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0id2hpdGUiIGNsYXNzPSJiaSBiaS1wYy1kaXNwbGF5IiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik04IDFhMSAxIDAgMCAxIDEtMWg2YTEgMSAwIDAgMSAxIDF2MTRhMSAxIDAgMCAxLTEgMUg5YTEgMSAwIDAgMS0xLTF6bTEgMTMuNWEuNS41IDAgMSAwIDEgMCAuNS41IDAgMCAwLTEgMG0yIDBhLjUuNSAwIDEgMCAxIDAgLjUuNSAwIDAgMC0xIDBNOS41IDFhLjUuNSAwIDAgMCAwIDFoNWEuNS41IDAgMCAwIDAtMXpNOSAzLjVhLjUuNSAwIDAgMCAuNS41aDVhLjUuNSAwIDAgMCAwLTFoLTVhLjUuNSAwIDAgMC0uNS41TTEuNSAyQTEuNSAxLjUgMCAwIDAgMCAzLjV2N0ExLjUgMS41IDAgMCAwIDEuNSAxMkg2djJoLS41YS41LjUgMCAwIDAgMCAxSDd2LTRIMS41YS41LjUgMCAwIDEtLjUtLjV2LTdhLjUuNSAwIDAgMSAuNS0uNUg3VjJ6Ii8+Cjwvc3ZnPg==)](https://jcdc.dev/umbraco-packages/simple-dashboards)
77

8-
This packages aims to help developers quickly put together Umbraco Dashboards using C# only.
98

10-
![Basic Dashboard in the Umbraco Office](https://raw.githubusercontent.com/jcdcdev/Umbraco.Community.SimpleDashboards/v14/docs/screenshot.png)
11-
12-
## Features
13-
14-
- C# dashboard creation
15-
- No javascript or umbraco-package.json files required
16-
- Supports both Views & View Components
9+
This packages aims to help developers quickly put together Umbraco Dashboards using C#.
10+
11+
## Features
12+
13+
- C# dashboard creation
14+
- No javascript or umbraco-package.json files required
15+
- Supports both Views & View Components
1716
- Easy to define section permissions
1817

1918
## Quick Start
2019

21-
### Install Package
22-
23-
```csharp
24-
dotnet add package Umbraco.Community.SimpleDashboards
25-
```
26-
27-
### Register Dashboard
28-
29-
By default, this will display in the content section for Admins only.
20+
### Install Package
21+
22+
```csharp
23+
dotnet add package Umbraco.Community.SimpleDashboards
24+
```
25+
26+
### Register Dashboard
27+
28+
By default, this will display in the content section for Admins only.
29+
30+
```csharp title="BasicDashboard.cs"
31+
using Umbraco.Community.SimpleDashboards.Web;
32+
public class BasicDashboard : SimpleDashboard { }
33+
```
34+
35+
### Create View
36+
37+
- Your view **must** go in `/Views/Dashboard`
38+
- You view **must** be the name of your C# class (without `Dashboard`)
39+
- For example: `BasicDashboard.cs` => `/Views/Dashboard/Basic.cshtml`
40+
41+
```csharp title="Views/Dashboard/Basic.cshtml"
42+
@inherits Umbraco.Community.SimpleDashboards.Web.DashboardViewPage
43+
44+
<uui-box headline="Hello Umbraco">
45+
<p>My Dashboard is: @Model.Dashboard.Alias</p>
46+
</uui-box>
47+
```
48+
49+
### More Examples
50+
51+
[docs/examples.md](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v15/docs/examples.md)
3052
31-
```csharp
32-
using Umbraco.Community.SimpleDashboards.Web;
33-
public class BasicDashboard : SimpleDashboard { }
34-
```
3553

36-
### Create View
3754

38-
- Your view **must** go in `/Views/Dashboard`
39-
- You view **must** be the name of your C# class (without `Dashboard`)
40-
- For example: `BasicDashboard.cs` => `/Views/Dashboard/Basic.cshtml`
41-
42-
```csharp
43-
@inherits Umbraco.Community.SimpleDashboards.Web.DashboardViewPage
44-
45-
<uui-box headline="Hello Umbraco">
46-
<p>My Dashboard is: @Model.Dashboard.Alias</p>
47-
</uui-box>
48-
```
55+
## Contributing
4956

50-
### More Examples
57+
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/contribute) page.
5158
52-
[docs/examples.md](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/docs/examples.md)
59+
## Acknowledgements (Thanks)
5360

54-
## Contributing
61+
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
5562
56-
Contributions to this package are most welcome! Please read
57-
the [Contributing Guidelines](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/.github/CONTRIBUTING.md).
5863

59-
## Acknowledgments (thanks!)
6064

61-
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)

SECURITY.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,22 @@
22

33
## Supported Versions
44

5-
The following table outlines the versions of the project that are currently supported with security updates:
5+
The following table outlines the versions of the project that are currently supported with security & feature updates:
66

7-
| Version | Supported | Umbraco Version |
8-
| ------------------------------------------------------- | --------- | --------------- |
9-
| [15.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/v15) || 15 |
10-
| [14.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/v14) || 14 |
11-
| [13.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/v13) || 13 |
12-
| [10.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/v10) || 10 |
13-
| [12.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/v12) || 12 |
14-
| [0.1.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/main) || 11 |
7+
> [!NOTE]
8+
> Once a version starts its security phase, it will no longer receive feature updates. Only critical bug fixes and security updates will be provided.
9+
10+
| Package Version | Umbraco Version | Security Phase Start | End of Life |
11+
| ---------------------------------------------------------------------------------- | --------------- | -------------------- | ----------- |
12+
| [10.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/v10) | 10 | 2024-06-16 | 2025-06-16 |
13+
| [13.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/v13) | 13 | 2025-12-14 | 2026-12-14 |
14+
| [14.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/v14) | 14 | 2025-03-02 | 2025-05-30 |
15+
| [15.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/v15) | 15 | 2025-08-14 | 2025-11-14 |
16+
## Unsupported Versions
17+
18+
| Package Version | Umbraco Version | End of Life |
19+
| ---------------------------------------------------------------------------------- | --------------- | ----------- |
20+
| [12.x](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/v12) | 12 | 2024-06-29 |
1521

1622

1723
## Future Support
@@ -25,7 +31,7 @@ Project maintainers plan to support all STS (Short-Term Support) and LTS (Long-T
2531

2632
If you discover a vulnerability in this project, please follow one of these steps to report it:
2733

28-
- Create an [issue](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/security/advisories/new)
34+
- Create an [issue](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/security/advisories/new)
2935
- Contact the project author privately at [jcdc.dev/contact](https://jcdc.dev/contact)
3036

3137
### Details
@@ -36,21 +42,21 @@ Include as much information as possible about the vulnerability, including:
3642
- Potential impact
3743
- Any suggested fixes
3844

39-
4045
### Acknowledgment
4146

42-
You will receive an acknowledgment of your report as soon as possible.
47+
You will receive an acknowledgment of your report as soon as possible.
4348

4449
> [!NOTE]
4550
> Response times may vary depending on other commitments.
4651
4752
### Resolution
4853

49-
Once the vulnerability is confirmed, project maintainers will work to resolve it as quickly as possible.
54+
Once the vulnerability is confirmed, project maintainers will work to resolve it as quickly as possible.
5055

51-
You will be notified once the issue has been resolved or rejected.
56+
You will be notified once the issue has been resolved or rejected.
5257

5358
> [!TIP]
5459
> If the vulnerability is accepted, you will receive credit in the release notes.
5560
5661
Thank you for helping to keep this project secure!
62+

docs/README_nuget.md

Lines changed: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,64 @@
11
# Umbraco.Community.SimpleDashboards
22

3-
[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/main?tab=readme-ov-file#quick-start)
4-
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/umbraco.community.simpledashboards)
5-
[![GitHub License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.SimpleDashboards?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/LICENSE)
6-
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.SimpleDashboards?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards/)
3+
[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards#quick-start)
4+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleDashboards)
5+
[![License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.SimpleDashboards?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards?tab=MIT-1-ov-file)
6+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.SimpleDashboards?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards)
77
[![Project Website](https://img.shields.io/badge/Project%20Website-jcdc.dev-jcdcdev?style=flat&color=3c4834&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0id2hpdGUiIGNsYXNzPSJiaSBiaS1wYy1kaXNwbGF5IiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik04IDFhMSAxIDAgMCAxIDEtMWg2YTEgMSAwIDAgMSAxIDF2MTRhMSAxIDAgMCAxLTEgMUg5YTEgMSAwIDAgMS0xLTF6bTEgMTMuNWEuNS41IDAgMSAwIDEgMCAuNS41IDAgMCAwLTEgMG0yIDBhLjUuNSAwIDEgMCAxIDAgLjUuNSAwIDAgMC0xIDBNOS41IDFhLjUuNSAwIDAgMCAwIDFoNWEuNS41IDAgMCAwIDAtMXpNOSAzLjVhLjUuNSAwIDAgMCAuNS41aDVhLjUuNSAwIDAgMCAwLTFoLTVhLjUuNSAwIDAgMC0uNS41TTEuNSAyQTEuNSAxLjUgMCAwIDAgMCAzLjV2N0ExLjUgMS41IDAgMCAwIDEuNSAxMkg2djJoLS41YS41LjUgMCAwIDAgMCAxSDd2LTRIMS41YS41LjUgMCAwIDEtLjUtLjV2LTdhLjUuNSAwIDAgMSAuNS0uNUg3VjJ6Ii8+Cjwvc3ZnPg==)](https://jcdc.dev/umbraco-packages/simple-dashboards)
88

9-
This packages aims to help developers quickly put together Umbraco Dashboards using C# only.
109

11-
![Basic Dashboard in the Umbraco Office](https://raw.githubusercontent.com/jcdcdev/Umbraco.Community.SimpleDashboards/v14/docs/screenshot.png)
10+
This packages aims to help developers quickly put together Umbraco Dashboards using C#.
11+
12+
## Features
13+
14+
- C# dashboard creation
15+
- No javascript or umbraco-package.json files required
16+
- Supports both Views & View Components
17+
- Easy to define section permissions
18+
19+
## Quick Start
20+
21+
### Install Package
22+
23+
```csharp
24+
dotnet add package Umbraco.Community.SimpleDashboards
25+
```
26+
27+
### Register Dashboard
28+
29+
By default, this will display in the content section for Admins only.
30+
31+
```csharp title="BasicDashboard.cs"
32+
using Umbraco.Community.SimpleDashboards.Web;
33+
public class BasicDashboard : SimpleDashboard { }
34+
```
35+
36+
### Create View
37+
38+
- Your view **must** go in `/Views/Dashboard`
39+
- You view **must** be the name of your C# class (without `Dashboard`)
40+
- For example: `BasicDashboard.cs` => `/Views/Dashboard/Basic.cshtml`
41+
42+
```csharp title="Views/Dashboard/Basic.cshtml"
43+
@inherits Umbraco.Community.SimpleDashboards.Web.DashboardViewPage
44+
45+
<uui-box headline="Hello Umbraco">
46+
<p>My Dashboard is: @Model.Dashboard.Alias</p>
47+
</uui-box>
48+
```
49+
50+
### More Examples
51+
52+
[docs/examples.md](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v15/docs/examples.md)
53+
1254

1355
## Contributing
1456

15-
Contributions to this package are most welcome! Please read
16-
the [Contributing Guidelines](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/.github/CONTRIBUTING.md).
57+
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/contribute) page.
58+
59+
## Acknowledgements (Thanks)
60+
61+
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
62+
1763

18-
## Acknowledgments (thanks!)
1964

20-
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)

src/Umbraco.Community.SimpleDashboards.Client/package-lock.json

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Umbraco.Community.SimpleDashboards.Client/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"@hey-api/openapi-ts": "^0.66.5",
1717
"@umbraco-cms/backoffice": "^15.3.1",
1818
"typescript": "^5.8.3",
19-
"vite": "^6.3.2"
19+
"vite": "^6.3.4"
2020
},
2121
"volta": {
2222
"node": "22.14.0"

0 commit comments

Comments
 (0)