|
1 | 1 | # Umbraco.Community.SimpleDashboards |
2 | 2 |
|
3 | | -[](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/tree/main?tab=readme-ov-file#quick-start) |
4 | | -[](https://marketplace.umbraco.com/package/umbraco.community.simpledashboards) |
5 | | -[](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/LICENSE) |
6 | | -[](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards/) |
| 3 | +[](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards#quick-start) |
| 4 | +[](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleDashboards) |
| 5 | +[](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards?tab=MIT-1-ov-file) |
| 6 | +[](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards) |
7 | 7 | [](https://jcdc.dev/umbraco-packages/simple-dashboards) |
8 | 8 |
|
9 | | -This packages aims to help developers quickly put together Umbraco Dashboards using C# only. |
10 | 9 |
|
11 | | - |
| 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 | +
|
12 | 54 |
|
13 | 55 | ## Contributing |
14 | 56 |
|
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 | +
|
17 | 63 |
|
18 | | -## Acknowledgments (thanks!) |
19 | 64 |
|
20 | | -- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) |
|
0 commit comments