Skip to content

Update sidebar API documentation to clarify icon and iconClass usage #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xthree wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update sidebar API documentation to clarify icon and iconClass usage #404

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/api/ui/sidebar/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ Property | Description
`id` | The unique id for this tab.
`label` | The text to display on the sidebar tab. This should not be too long.
`name` | The name of the tab displayed in the sidebar menu.
`iconClass` | The FontAwesome 4 class of the icon to use. For example, `"fa fa-database"`
`icon` | (optional) A URL to an SVG file to use as the tab icon. The SVG is used as a CSS mask-image, so it will be rendered using the current text color. Either `icon` or `iconClass` can be used, but not both.
`iconClass` | (optional) The FontAwesome 4 class of the icon to use. For example, `"fa fa-database"`. Either `icon` or `iconClass` can be used, but not both.
`content` | The DOM element containing the content of the sidebar.
`toolbar` | (optional) A DOM element to display in the sidebar toolbar when this tab is active.
`enableOnEdit` | (optional) If set to `true`, this tab will be accessible whilst the edit dialog is open. Default: `false`.
Expand Down