Skip to content

Commit 0f10594

Browse files
committed
docs: dashboard is on the design system, its docs name the Edit and Settings buttons and the Lucide default menu icon AdminForth/2005
1 parent 210722b commit 0f10594

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

‎adminforth/design/adoption.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Which packages follow the [design concepts](./system-concepts.md): tokens instea
1212
| @adminforth/bulk-ai-flow | |
1313
| @adminforth/clone-row | |
1414
| @adminforth/crud-approve-plugin | |
15-
| @adminforth/dashboard | |
15+
| @adminforth/dashboard | ✓ |
1616
| @adminforth/email-invite | |
1717
| @adminforth/email-password-reset | |
1818
| @adminforth/foreign-inline-list | |
@@ -54,5 +54,5 @@ Which packages follow the [design concepts](./system-concepts.md): tokens instea
5454

5555
- If simple - get of flowbite, prefer pure AFCL + Tailwind, move features we luck to AFCL
5656
- Existing icon fonts apart lucide - try to get rid of them if not complex
57-
- Core uses only Lucide icons and `flag-icons` flags (`afcl/CountryFlag.vue`). `vue-flowbite` and `vue-heroicons` stay in `spa/package.json` while plugins import them (flowbite: bulk-ai-flow, clone-row, dashboard, email-invite, email-password-reset, foreign-inline-list, inline-create, json-editor, markdown, open-signup, two-factors-auth, user-soft-delete; heroicons: dashboard, markdown). After plugins rework it they should disappear.
57+
- Core uses only Lucide icons and `flag-icons` flags (`afcl/CountryFlag.vue`). `vue-flowbite` and `vue-heroicons` stay in `spa/package.json` while plugins import them (flowbite: bulk-ai-flow, clone-row, email-invite, email-password-reset, foreign-inline-list, inline-create, json-editor, markdown, open-signup, two-factors-auth, user-soft-delete, and dashboard only for `flowbite:chart-pie-solid`, the old default menu icon which stored dashboard configs may name; heroicons: markdown). After plugins rework it they should disappear.
5858
- i18n shows language flags with its own `flag-icon-css`, a 445 KB stylesheet loaded on every page: move `LanguageFlag.vue` to AFCL `CountryFlag`.

‎documentation/docs/tutorial/09-Plugins/27-0-dashboard.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ new DashboardPlugin({
199199
});
200200
```
201201

202-
Users with a role from `viewRoles` see the **Dashboards** sidebar group and can open dashboards, but they do not get the edit mode button and receive a `403` response from all dashboard mutation endpoints. Roles from `editRoles` can always view dashboards, so there is no need to repeat them in `viewRoles`.
202+
Users with a role from `viewRoles` see the **Dashboards** sidebar group and can open dashboards, but they do not get the **Edit** button and receive a `403` response from all dashboard mutation endpoints. Roles from `editRoles` can always view dashboards, so there is no need to repeat them in `viewRoles`.
203203

204204
Users whose role is listed in neither option do not see the **Dashboards** sidebar group and receive a `403` response from dashboard configuration and widget-data endpoints. The dashboard configs resource itself stays available only to `editRoles`.
205205

@@ -236,17 +236,17 @@ widgets: []
236236
If you need to configure dashboards without using the AI Agent, you can do so manually via the AdminForth interface:
237237
238238
1. **Access Dashboards**: Open the **Dashboards** group in the sidebar and choose a dashboard page.
239-
2. **Interactive UI Editor**: Users with a role listed in the plugin's `editRoles` option (defaults to `superadmin`) see a wrench button in the dashboard header that toggles edit mode. Turning it on reveals the controls to add, rename, reorder, and remove groups or widgets directly from the user interface. With edit mode off, the dashboard looks the same as it does for read-only viewers.
239+
2. **Interactive UI Editor**: Users with a role listed in the plugin's `editRoles` option (defaults to `superadmin`) see an **Edit** button in the dashboard header that turns on edit mode. In edit mode the **⋯** menu of every group and widget edits its YAML, moves it up or down, or removes it, and **Add group** and **Add widget** create new ones. **Done** turns edit mode off, and the dashboard looks the same as it does for read-only viewers.
240240
3. **YAML Configuration Editor**: The dashboard builder has built-in code editors. When editing a widget or a group manually, you write configurations using a YAML-based DSL.
241241

242242
### Editing dashboard settings
243243

244-
Turn on edit mode with the wrench button and click the gear icon next to it to edit the dashboard itself. The YAML editor accepts these fields:
244+
Turn on edit mode with **Edit** and click **Settings** next to it to edit the dashboard itself. The YAML editor accepts these fields:
245245

246246
```yaml
247247
label: Sales Overview
248248
slug: sales-overview
249-
icon: flowbite:chart-pie-solid
249+
icon: lucide:chart-pie
250250
```
251251

252252
- `label` is the page title and sidebar label.
@@ -263,7 +263,7 @@ To create a new dashboard page manually, add a new record to your dashboard conf
263263

264264
```yaml title="dashboard_configs.config"
265265
version: 1
266-
icon: flowbite:chart-pie-solid
266+
icon: lucide:chart-pie
267267
groups:
268268
- id: sales
269269
label: Sales

0 commit comments

Comments
 (0)