Skip to content

Commit a5eae8e

Browse files
WebVPFLukeTowers
andauthored
Clarified description for iconSvg option in Navigation menus (#241)
Co-authored-by: Luke Towers <github@luketowers.ca>
1 parent e53cc21 commit a5eae8e

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

plugin/registration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ Key | Description
389389
------------- | -------------
390390
`label` | specifies the menu label localization string key, required.
391391
`icon` | an icon name from the [Winter CMS icon collection](/docs/v1.2/ui/style/icon), optional.
392-
`iconSvg` | an SVG icon to be used in place of the standard icon, the SVG icon should be a rectangle and can support colors, optional.
392+
`iconSvg` | an image icon (svg, webp, png, jpg) to be used in place of the standard icon, the image icon should be a square and can support colors, optional. The value will be passed to `Url::asset()` before rendering.
393393
`url` | the URL the menu item should point to (ex. `Backend::url('author/plugin/controller/action')`, required.
394394
`counter` | a numeric value to output near the menu icon. The value should be a number or a callable returning a number, optional.
395395
`counterLabel` | a string value to describe the numeric reference in counter, optional.

0 commit comments

Comments
 (0)