Skip to content

Fixed some minor errors in the custom dashboard tutorials #7040

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.

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

Merged
merged 3 commits into from
Apr 29, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
12 changes: 10 additions & 2 deletions 15/umbraco-cms/customizing/development-flow/vite-package-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@

3. When prompted:
* Enter **client** as the **Project Name**.
* Enter **client** as the **Package name**.
* Select **Lit** as the framework.
* Select **TypeScript** as the variant.

Expand All @@ -46,6 +45,15 @@

{% endhint %}

{% hint style="info" %}

Check warning on line 48 in 15/umbraco-cms/customizing/development-flow/vite-package-setup.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). Raw Output: {"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "15/umbraco-cms/customizing/development-flow/vite-package-setup.md", "range": {"start": {"line": 48, "column": 4}}}, "severity": "WARNING"}
For Windows environments, especially when using PowerShell, the command above should be as shown below (note the extra -) or you will still see the interactive prompts:

```typescript
npm create vite@latest client --- --template lit-ts
```

{% endhint %}

4. Navigate into the new **client** folder and install the packages:

```bash
Expand Down Expand Up @@ -146,7 +154,7 @@

## Umbraco Package declaration

Declare your package to Umbraco via a file called `umbraco-package.json`. This should be added at the root of your package. The `umbraco-package.json` file should be located at `/App_Plugins/` or `/App_Plugins/{YourPackageName}` for Umbraco to detect it.
Declare your package to Umbraco via a file called `umbraco-package.json`. This should be added in the `public` folder under the root of your package. Once built the `umbraco-package.json` file should be located at `/App_Plugins/` or `/App_Plugins/{YourPackageName}` for Umbraco to detect it.

This example declares a Dashboard as part of your Package, using the Vite example element.

Expand Down
24 changes: 20 additions & 4 deletions 15/umbraco-cms/tutorials/creating-a-custom-dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ At each step, you will find a dropdown for `welcome-dashboard.element.ts`, `and
## Setting up a package

1. Follow the [Vite Package Setup](../../customizing/development-flow/vite-package-setup.md) by creating a new project folder called "`welcome-dashboard`" in `App_Plugins`.
2. Create a manifest file named `umbraco-package.json` at the root of the `welcome-dashboard` folder. Here we define and configure our dashboard.
2. Create a manifest file named `umbraco-package.json` within the `public` folder, located at the root of the `welcome-dashboard` folder. Here we define and configure our dashboard.
3. Add the following code to `umbraco-package.json`:

{% code title="umbraco-package.json" lineNumbers="true" %}
Expand All @@ -65,7 +65,7 @@ At each step, you will find a dropdown for `welcome-dashboard.element.ts`, `and
"type": "dashboard",
"alias": "my.welcome.dashboard",
"name": "My Welcome Dashboard",
"element": "/App_Plugins/welcome-dashboard/dist/welcome-dashboard.js",
"element": "/App_Plugins/welcome-dashboard/welcome-dashboard.js",
"elementName": "my-welcome-dashboard",
"weight": 30,
"meta": {
Expand Down Expand Up @@ -140,10 +140,26 @@ declare global {
```
{% endcode %}

3. In the `vite.config.ts` file replace the `entry` to our newly created `.ts` file:
3. In the `vite.config.ts` file update the `entry` to point to our newly created `.ts` file, and also ensure that the `outDir' and 'base' attributes are pointing to the welcome-dashboard folder:

```typescript
entry: "src/welcome-dashboard.element.ts"
import { defineConfig } from "vite";

export default defineConfig({
build: {
lib: {
entry: "src/welcome-dashboard.element.ts", // your web component source file
formats: ["es"],
},
outDir: "../App_Plugins/welcome-dashboard", // all compiled files will be placed here
emptyOutDir: true,
sourcemap: true,
rollupOptions: {
external: [/^@umbraco/], // ignore the Umbraco Backoffice package in the build
},
},
base: "/App_Plugins/welcome-dashboard/", // the base path of the app in the browser (used for assets)
});
```

4. In the `welcome-dashboard` folder run `npm run build` and then run the project. Then in the content section of the Backoffice you will see our new dashboard:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ import { UUIInterfaceColor, UUIInterfaceLook } from '@umbraco-cms/backoffice/ext

private _renderUser(user: UmbUserDetailModel) {
if (!user) return;
const state = this.getLookAndColorFromUserState(user.state);
const state = this.getLookAndColorFromUserState(user.state!);
return html`<uui-table-row class="user">
<uui-table-cell>${user.name}</uui-table-cell>
<uui-table-cell>${user.email}</uui-table-cell>
Expand Down
Loading