Skip to content

Sectionview: fixed existing example + added extra examples #6455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Sectionview: fixed existing example + added extra examples #6455

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e53cd75
Sectionview: updated manifest json example + added typescript + eleme…
Yinzy00 Sep 24, 2024
5523db2
Sectionview: V15, updated manifest json example + added typescript + …
Yinzy00 Sep 24, 2024
df9cf7e
SectionView: added missing comma in manifest
Yinzy00 Oct 1, 2024
ecfb84a
Sectionview: added more project context about the ecample to make it …
Yinzy00 Oct 4, 2024
e77041c
Sectionview: removed missplaced info and added link to entrypoint docs
Yinzy00 Oct 7, 2024
4f5c67a
Sectionview: added more context + moved json & typescript manifest ex…
Yinzy00 Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 87 additions & 4 deletions 14/umbraco-cms/customizing/section-trees/sections/section-view.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,100 @@ This page is a work in progress and may undergo further revisions, updates, or a

<figure><img src="../../../.gitbook/assets/section-views.svg" alt=""><figcaption><p>Section View</p></figcaption></figure>

**Manifest**
## Creating a custom Section View

### Manifest

**Using Json**

We can create the manifest using json in the `umbraco-package.json`.

```json
{
"type": "sectionView",
"alias": "My.SectionView",
"name": "My Section View",
"element": "./my-section.element.js",
"meta": {
"sections": ["My.Section"],
"label": "My View",
"pathname": "/my-view"
}
"icon": "icon-add",
"pathname": "my-view"
},
"conditions": [
{
"alias": "Umb.Condition.SectionAlias",
"match": "My.Section",
}
]
}
```

**Using TypeScript**

The manifest can also be written in TypeScript.

```typescript
import { ManifestSectionView } from "@umbraco-cms/backoffice/extension-registry";

const sectionViews: Array<ManifestSectionView> = [
{
type: "sectionView",
alias: "My.SectionView",
name: "My Section View",
element: () => import('./my-section.element.ts'),
meta: {
label: "My View",
icon: "icon-add",
pathname: "my-view",
},
conditions: [
{
alias: 'Umb.Condition.SectionAlias',
match: 'My.Section',
}
]
}
]
```

### Lit Element

Creating the Section View Element using a Lit Element.


**my-section.element.ts:**
```typescript
import { UmbLitElement } from "@umbraco-cms/backoffice/lit-element";
import { css, html, customElement, property } from '@umbraco-cms/backoffice/external/lit';

@customElement('my-sectionview-element')
export class MySectionViewElement extends UmbLitElement {

render() {
return html`
<uui-box headline="Sectionview Title goes here">
Sectionview content goes here
</uui-box>
`
}

static override styles = [
css`
:host {
display: block;
padding: 20px;
}
`,
];

}

export default MySectionViewElement;

declare global {
interface HTMLElementTagNameMap {
'my-sectionview-element': MySectionViewElement;
}
}

```
91 changes: 87 additions & 4 deletions 15/umbraco-cms/customizing/section-trees/sections/section-view.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,100 @@ This page is a work in progress and may undergo further revisions, updates, or a

<figure><img src="../../../.gitbook/assets/section-views.svg" alt=""><figcaption><p>Section View</p></figcaption></figure>

**Manifest**
## Creating a custom Section View

### Manifest

**Using Json**

We can create the manifest using json in the `umbraco-package.json`.

```json
{
"type": "sectionView",
"alias": "My.SectionView",
"name": "My Section View",
"element": "./my-section.element.js",
"meta": {
"sections": ["My.Section"],
"label": "My View",
"pathname": "/my-view"
}
"icon": "icon-add",
"pathname": "my-view"
},
"conditions": [
{
"alias": "Umb.Condition.SectionAlias",
"match": "My.Section",
}
]
}
```

**Using TypeScript**

The manifest can also be written in TypeScript.

```typescript
import { ManifestSectionView } from "@umbraco-cms/backoffice/extension-registry";

const sectionViews: Array<ManifestSectionView> = [
{
type: "sectionView",
alias: "My.SectionView",
name: "My Section View",
element: () => import('./my-section.element.ts'),
meta: {
label: "My View",
icon: "icon-add"
pathname: "my-view",
},
conditions: [
{
alias: 'Umb.Condition.SectionAlias',
match: 'My.Section',
}
]
}
]
```

### Lit Element

Creating the Section View Element using a Lit Element.


**my-section.element.ts:**
```typescript
import { UmbLitElement } from "@umbraco-cms/backoffice/lit-element";
import { css, html, customElement, property } from '@umbraco-cms/backoffice/external/lit';

@customElement('my-sectionview-element')
export class MySectionViewElement extends UmbLitElement {

render() {
return html`
<uui-box headline="Sectionview Title goes here">
Sectionview content goes here
</uui-box>
`
}

static override styles = [
css`
:host {
display: block;
padding: 20px;
}
`,
];

}

export default MySectionViewElement;

declare global {
interface HTMLElementTagNameMap {
'my-sectionview-element': MySectionViewElement;
}
}

```
Loading