|
1 | 1 | # Umbraco.Community.SimpleDashboards |
2 | 2 |
|
3 | | -[](https://marketplace.umbraco.com/package/umbraco.community.simpledashboards) |
4 | | -[](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/LICENSE) |
5 | | -[](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards/) |
| 3 | +[](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleDashboards) |
| 4 | +[](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards?tab=MIT-1-ov-file) |
| 5 | +[](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards) |
6 | 6 | [](https://jcdc.dev/umbraco-packages/simple-dashboards) |
7 | 7 |
|
8 | | -This packages aims to help developers quickly put together Umbraco Dashboards using C# only. |
9 | 8 |
|
10 | | - |
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 |
17 | 16 | - Easy to define section permissions |
18 | 17 |
|
19 | 18 | ## Quick Start |
20 | 19 |
|
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) |
30 | 52 |
|
31 | | -```csharp |
32 | | -using Umbraco.Community.SimpleDashboards.Web; |
33 | | -public class BasicDashboard : SimpleDashboard { } |
34 | | -``` |
35 | 53 |
|
36 | | -### Create View |
37 | 54 |
|
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 |
49 | 56 |
|
50 | | -### More Examples |
| 57 | +Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/contribute) page. |
51 | 58 |
|
52 | | -[docs/examples.md](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/docs/examples.md) |
| 59 | +## Acknowledgements (Thanks) |
53 | 60 |
|
54 | | -## Contributing |
| 61 | +- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) |
55 | 62 |
|
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). |
58 | 63 |
|
59 | | -## Acknowledgments (thanks!) |
60 | 64 |
|
61 | | -- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) |
|
0 commit comments