Skip to content

Commit cae7a28

Browse files
authored
Merge pull request #44 from jcdcdev/dev/v15
15.1.3
2 parents 8eec998 + e6836a0 commit cae7a28

2 files changed

Lines changed: 20 additions & 69 deletions

File tree

.github/README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# Umbraco.Community.SimpleTrees
1+
# Simple Trees
22

3+
[![Documentation](https://img.shields.io/badge/Documentation-123?color=394933&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0iY3VycmVudENvbG9yIiBjb2xvcj0id2hpdGUiIGNsYXNzPSJiaSBiaS1ib29rIiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik0xIDIuODI4Yy44ODUtLjM3IDIuMTU0LS43NjkgMy4zODgtLjg5MyAxLjMzLS4xMzQgMi40NTguMDYzIDMuMTEyLjc1MnY5Ljc0NmMtLjkzNS0uNTMtMi4xMi0uNjAzLTMuMjEzLS40OTMtMS4xOC4xMi0yLjM3LjQ2MS0zLjI4Ny44MTF6bTcuNS0uMTQxYy42NTQtLjY4OSAxLjc4Mi0uODg2IDMuMTEyLS43NTIgMS4yMzQuMTI0IDIuNTAzLjUyMyAzLjM4OC44OTN2OS45MjNjLS45MTgtLjM1LTIuMTA3LS42OTItMy4yODctLjgxLTEuMDk0LS4xMTEtMi4yNzgtLjAzOS0zLjIxMy40OTJ6TTggMS43ODNDNy4wMTUuOTM2IDUuNTg3LjgxIDQuMjg3Ljk0Yy0xLjUxNC4xNTMtMy4wNDIuNjcyLTMuOTk0IDEuMTA1QS41LjUgMCAwIDAgMCAyLjV2MTFhLjUuNSAwIDAgMCAuNzA3LjQ1NWMuODgyLS40IDIuMzAzLS44ODEgMy42OC0xLjAyIDEuNDA5LS4xNDIgMi41OS4wODcgMy4yMjMuODc3YS41LjUgMCAwIDAgLjc4IDBjLjYzMy0uNzkgMS44MTQtMS4wMTkgMy4yMjItLjg3NyAxLjM3OC4xMzkgMi44LjYyIDMuNjgxIDEuMDJBLjUuNSAwIDAgMCAxNiAxMy41di0xMWEuNS41IDAgMCAwLS4yOTMtLjQ1NWMtLjk1Mi0uNDMzLTIuNDgtLjk1Mi0zLjk5NC0xLjEwNUMxMC40MTMuODA5IDguOTg1LjkzNiA4IDEuNzgzIi8+Cjwvc3ZnPg==)](https://docs.jcdc.dev/umbraco-community-simpletrees/latest)
34
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco%20Marketplace-%23f5c1bc?logo=umbraco&logoColor=162335)](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleTrees)
45
[![GitHub](https://img.shields.io/badge/GitHub-1?logo=github&color=232925)](https://github.com/jcdcdev/Umbraco.Community.SimpleTrees)
56
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.SimpleTrees?labelColor=4536d3&color=4536d3&label=NuGet&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.SimpleTrees)
@@ -21,11 +22,21 @@ This packages aims to help developers quickly put together Umbraco Trees using C
2122
2223
> Please review the [security policy](https://github.com/jcdcdev/Umbraco.Community.SimpleTrees?tab=security-ov-file#supported-versions) for more information.
2324
25+
## Security
26+
27+
> [!NOTE]
28+
> This project takes security and support seriously.
29+
> Please visit the [Security](https://github.com/jcdcdev/Umbraco.Community.SimpleTrees?tab=security-ov-file) page for more information.
30+
31+
32+
2433
## Contributing
2534

2635
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleTrees/contribute) page.
2736

28-
## Acknowledgements (Thanks)
37+
## Acknowledgements
38+
39+
Thank you to the following projects and individuals for their contributions. High five, you rock! 🤘🦄
2940

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

docs/README_nuget.md

Lines changed: 7 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Umbraco.Community.SimpleTrees
1+
# Simple Trees
22

33
[![Documentation](https://img.shields.io/badge/Documentation-123?color=394933&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0iY3VycmVudENvbG9yIiBjb2xvcj0id2hpdGUiIGNsYXNzPSJiaSBiaS1ib29rIiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik0xIDIuODI4Yy44ODUtLjM3IDIuMTU0LS43NjkgMy4zODgtLjg5MyAxLjMzLS4xMzQgMi40NTguMDYzIDMuMTEyLjc1MnY5Ljc0NmMtLjkzNS0uNTMtMi4xMi0uNjAzLTMuMjEzLS40OTMtMS4xOC4xMi0yLjM3LjQ2MS0zLjI4Ny44MTF6bTcuNS0uMTQxYy42NTQtLjY4OSAxLjc4Mi0uODg2IDMuMTEyLS43NTIgMS4yMzQuMTI0IDIuNTAzLjUyMyAzLjM4OC44OTN2OS45MjNjLS45MTgtLjM1LTIuMTA3LS42OTItMy4yODctLjgxLTEuMDk0LS4xMTEtMi4yNzgtLjAzOS0zLjIxMy40OTJ6TTggMS43ODNDNy4wMTUuOTM2IDUuNTg3LjgxIDQuMjg3Ljk0Yy0xLjUxNC4xNTMtMy4wNDIuNjcyLTMuOTk0IDEuMTA1QS41LjUgMCAwIDAgMCAyLjV2MTFhLjUuNSAwIDAgMCAuNzA3LjQ1NWMuODgyLS40IDIuMzAzLS44ODEgMy42OC0xLjAyIDEuNDA5LS4xNDIgMi41OS4wODcgMy4yMjMuODc3YS41LjUgMCAwIDAgLjc4IDBjLjYzMy0uNzkgMS44MTQtMS4wMTkgMy4yMjItLjg3NyAxLjM3OC4xMzkgMi44LjYyIDMuNjgxIDEuMDJBLjUuNSAwIDAgMCAxNiAxMy41di0xMWEuNS41IDAgMCAwLS4yOTMtLjQ1NWMtLjk1Mi0uNDMzLTIuNDgtLjk1Mi0zLjk5NC0xLjEwNUMxMC40MTMuODA5IDguOTg1LjkzNiA4IDEuNzgzIi8+Cjwvc3ZnPg==)](https://docs.jcdc.dev/umbraco-community-simpletrees/latest)
44
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco%20Marketplace-%23f5c1bc?logo=umbraco&logoColor=162335)](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleTrees)
@@ -17,78 +17,18 @@ This packages aims to help developers quickly put together Umbraco Trees using C
1717
- Easy to define section permissions
1818
- ✨ Custom Entity Actions!
1919

20-
## Installation
20+
## Security
2121

22-
### Install Package
23-
24-
```powershell
25-
dotnet add package Umbraco.Community.SimpleTrees
26-
```
27-
28-
## Quick Start
29-
30-
### Register Tree
31-
32-
By default, this will display in the content section.
33-
34-
```csharp title="ExampleTree.cs"
35-
using Umbraco.Cms.Core.Models;
36-
using Umbraco.Community.SimpleTrees.Core.Models;
37-
38-
namespace Umbraco.Community.SimpleTrees.TestSite.Trees;
39-
40-
public class MyTree : SimpleTree
41-
{
42-
public override Task<PagedModel<ISimpleTreeItem>> GetTreeRootAsync(int skip, int take, bool foldersOnly)
43-
{
44-
var data = new List<ISimpleTreeItem>
45-
{
46-
CreateRootItem("James", Guid.NewGuid().ToString(), "icon-user"),
47-
CreateRootItem("Tim", Guid.NewGuid().ToString(), "icon-user"),
48-
};
49-
50-
return Task.FromResult(new PagedModel<ISimpleTreeItem>(data.Count, data));
51-
}
52-
53-
public override Task<PagedModel<ISimpleTreeItem>> GetTreeChildrenAsync(string entityType, string parentUnique, int skip, int take, bool foldersOnly) => Task.FromResult(EmptyResult());
54-
55-
public override string Name => "My Tree";
56-
}
57-
```
58-
59-
### Create Views
60-
61-
- Your views **must** go in `/Views/Trees`
62-
- You views **must** be the name of your tree entities
63-
- For example: `MyTree.cs` => `/Views/Trees/MyItem.cshtml` & `/Views/Trees/MyRoot.cshtml`
64-
65-
```csharp title="Views/Trees/MyItem.cshtml"
66-
@inherits Umbraco.Community.SimpleTrees.Web.SimpleTreeViewPage
67-
68-
<uui-box headline="This is a custom tree item">
69-
<div>
70-
<table>
71-
<thead>
72-
<tr>
73-
<th>Entity Type</th>
74-
<th>Unique</th>
75-
</tr>
76-
</thead>
77-
<tbody>
78-
<tr>
79-
<td>@Model.EntityType</td>
80-
<td>@Model.Unique</td>
81-
</tr>
82-
</table>
83-
</div>
84-
</uui-box>
85-
```
22+
This project takes security and support seriously.
23+
Please visit the [Security](https://github.com/jcdcdev/Umbraco.Community.SimpleTrees?tab=security-ov-file) page for more information.
8624

8725
## Contributing
8826

8927
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleTrees/contribute) page.
9028

91-
## Acknowledgements (Thanks)
29+
## Acknowledgements
30+
31+
Thank you to the following projects and individuals for their contributions. High five, you rock! 🤘🦄
9232

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

0 commit comments

Comments
 (0)