Skip to content

Commit e7bb30b

Browse files
authored
fix(docs): add instructions on customizing name, title, icon
1 parent 22875ae commit e7bb30b

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,21 @@ Widgets can be configured by passing widget-specific config:
7070
projectUsersWidget({layout: 'medium'})
7171
```
7272

73+
You can change the name, title and icon of the dashboard tool should you want to - which also allows you to configure multiple dashboards with different configurations:
74+
75+
```ts
76+
import { defineConfig } from "sanity";
77+
import { dashboardTool } from "@sanity/dashboard";
78+
import { ActivityIcon } from "@sanity/icons";
79+
80+
dashboardTool({
81+
name: "stats",
82+
title: "Statistics",
83+
icon: ActivityIcon,
84+
widgets: [/* ... */]
85+
})
86+
```
87+
7388
## How to install a widget
7489

7590
Install a Dashboard widget as you would any npm package.

0 commit comments

Comments
 (0)