Navigation: Expand & Improve editorType/widget Docs (#8514)#8536
Conversation
There was a problem hiding this comment.
Pull request overview
This PR expands the widget property documentation for multiple toolbar-item configurations, aligning it with the more detailed guidance used in editor-related docs.
Changes:
- Updates
widgetshort descriptions to consistently describe selecting a DevExtreme component for a toolbar item. - Adds framework-specific notes (jQuery/Angular/Vue/React) about module imports when using DevExtreme modularity.
- Adds additional runtime-configuration guidance (template/render/component) for non-jQuery frameworks.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| api-reference/_hidden/dxToolbarItem/widget.md | Rewrites widget short description and expands the note with framework-specific import/runtime guidance. |
| api-reference/_hidden/dxPopupToolbarItem/widget.md | Similar expansion for Popup toolbar items, including runtime guidance links. |
| api-reference/_hidden/dxHtmlEditorToolbarItem/widget.md | Similar expansion for HtmlEditor toolbar items, adding framework-specific modularity guidance. |
| api-reference/_hidden/dxFileManagerToolbarItem/widget.md | Adds options configuration sentence and expands the note with framework-specific modularity guidance + predefined-item limitation. |
You can also share your feedback on Copilot code review. Take the survey.
| --- | ||
| ##### shortDescription | ||
| A UI component that presents a toolbar item. To configure it, use the [options](/api-reference/_hidden/dxToolbarItem/options.md '/Documentation/ApiReference/UI_Components/dxToolbar/Configuration/items/#options') object. | ||
| The DevExtreme component to use as a Toolbar item. |
There was a problem hiding this comment.
In the short description, “Toolbar” is capitalized mid-sentence. Elsewhere in these docs this is typically written as “toolbar item”; consider changing to “The DevExtreme component to use as a toolbar item.” for consistent casing.
| The DevExtreme component to use as a Toolbar item. | |
| The DevExtreme component to use as a toolbar item. |
|
|
||
| ##### jQuery | ||
|
|
||
| If you use [DevExtreme modules](/concepts/Common/Modularity/02%20DevExtreme%20Modules%20Structure '/Documentation/Guide/Common/Modularity/DevExtreme_Modules_Structure/'), import the specified editor's module from the `devextreme` folder: |
There was a problem hiding this comment.
The jQuery note says “specified editor’s module” and is not formatted as a list item. This property refers to a toolbar item UI component (not necessarily an editor), so consider changing “editor” to “UI component/component” and prefixing the sentence with a list marker (“-”) to match the formatting used in the other framework sections.
| If you use [DevExtreme modules](/concepts/Common/Modularity/02%20DevExtreme%20Modules%20Structure '/Documentation/Guide/Common/Modularity/DevExtreme_Modules_Structure/'), import the specified editor's module from the `devextreme` folder: | |
| - If you use [DevExtreme modules](/concepts/Common/Modularity/02%20DevExtreme%20Modules%20Structure '/Documentation/Guide/Common/Modularity/DevExtreme_Modules_Structure/'), import the specified UI component's module from the `devextreme` folder: |
| ##### jQuery | ||
|
|
||
| If you use [DevExtreme modules](/concepts/Common/Modularity/02%20DevExtreme%20Modules%20Structure '/Documentation/Guide/Common/Modularity/DevExtreme_Modules_Structure/'), import the specified editor's module from the `devextreme` folder: | ||
|
|
||
| import 'devextreme/ui/tag_box'; |
There was a problem hiding this comment.
The jQuery note says “specified editor’s module”, but this property is a toolbar item UI component (not necessarily an editor). Consider changing “editor” to “UI component/component” (and apply the same wording update in the Angular/Vue/React sections in this note).
| ##### jQuery | ||
|
|
||
| If you use [DevExtreme modules](/concepts/Common/Modularity/02%20DevExtreme%20Modules%20Structure '/Documentation/Guide/Common/Modularity/DevExtreme_Modules_Structure/'), import the specified editor's module from the `devextreme` folder: | ||
|
|
||
| import 'devextreme/ui/tag_box'; |
There was a problem hiding this comment.
In the jQuery section, the sentence starts without a list marker and uses “specified editor’s module”. For consistency with similar notes (and because this is a toolbar item component, not strictly an editor), consider making this a bullet item and replacing “editor” with “UI component/component” (also in the other framework sections).
| ##### jQuery | ||
|
|
||
| - If you use [DevExtreme modules](/concepts/Common/Modularity/02%20DevExtreme%20Modules%20Structure '/Documentation/Guide/Common/Modularity/DevExtreme_Modules_Structure/'), import the specified editor's module from the `devextreme` folder: | ||
|
|
||
| import 'devextreme/ui/tag_box'; |
There was a problem hiding this comment.
This note refers to importing the “specified editor’s” module, but the property is widget (a UI component used in the toolbar). Consider replacing “editor” with “UI component/component” to avoid confusion (in all occurrences within this note).
No description provided.