Add Widgets API documentation and enable unstableWidgetsApi feature flag #3
Conversation
![dev-docs-github-app-dev[bot]](https://avatars.githubusercontent.com/u/128262096?s=60&v=4){kind=small}
| Widgets are identified by a unique UID, which is automatically generated based on the `pluginId` and `id`: | ||
|
|
||
| - For plugin widgets: `plugin::{pluginId}.{id}` | ||
| - For global widgets: `global::{id}` |
There was a problem hiding this comment.
I don't think "global" is clear to users. Basically it's for widgets created directly within an app, not via a plugin
There was a problem hiding this comment.
But also, users shouldn't care at all about the UID, it's just useful to us to render the homepage
| ### getAll() | ||
|
|
||
| Retrieves all registered widgets: | ||
|
|
||
| ```javascript | ||
| const allWidgets = widgets.getAll(); | ||
| ``` |
There was a problem hiding this comment.
this isn't useful to users, it just allows us to render the homepage. Registering is all that matters for them so I recommend to omit the rest
| id: 'my-widget.title', | ||
| defaultMessage: 'My Widget', | ||
| }, | ||
| component: () => import('./components/MyWidget'), |
There was a problem hiding this comment.
the component function should return a component directly, not a file that has a component as a default export. so:
| component: () => import('./components/MyWidget'), | |
| component: async () => { | |
| const { Component } = await import('./components/MyWidget'); | |
| return Component |
|
|
||
| To create a widget, you need to use the `Widgets` class from the `@strapi/admin` package. Here's an example of how to create a widget: | ||
|
|
There was a problem hiding this comment.
This is wrong, what we should explain instead is:
- they should register the widgets during Strapi's register phase
- instead of importing anything, they should access the widgets register api via the app object provided as a param of the Strapi's register lifecycle. Exactly like custom fields
| import { Widgets } from '@strapi/admin'; | ||
| import RecentContentIcon from './icons/RecentContent'; | ||
|
|
||
| const widgets = new Widgets(); | ||
|
|
||
| widgets.register({ |
There was a problem hiding this comment.
same comment as before, this isn't how registration works
| id: 'dashboard.widgets.recent-content.title', | ||
| defaultMessage: 'Recent Content', | ||
| }, | ||
| component: () => import('./components/RecentContentWidget'), |
There was a problem hiding this comment.
I don't see the point of this example, it's the same thing as the one above.
What would be interesting instead is to show how to build the actual component
| - For plugin widgets: `plugin::{pluginId}.{id}` | ||
| - For global widgets: `global::{id}` | ||
|
|
||
| ## Best Practices |
There was a problem hiding this comment.
this part is quite visibly AI generated imo, most of it is common sense
This pull request adds a new page to the documentation,
widgets-api.md, which explains how to use the Widgets API to create and manage widgets in the Strapi admin panel. It also updates thefeatures.mdfile to include information about theunstableWidgetsApifuture flag, which can be used to enable the experimental Widgets API functionality.This PR is generated from the issue team-dev-docs/strapi#6