Skip to content

Document the icon type of web apps and extensions - #1201

Draft
dschmidt wants to merge 1 commit into
mainfrom
docs/web-image-icons
Draft

dschmidt wants to merge 1 commit into
mainfrom
docs/web-image-icons

Conversation

@dschmidt

@dschmidt dschmidt commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Documents the Icon type introduced in opencloud-eu/web#3580: an icon name, a named icon with fillType and color, or an image icon with src and srcDark.

  • New "Icons" section in the extensions docs.
  • The extension type pages and the viewer/editor apps page use icon: Icon and link to that section.
  • The sibling properties iconFillType, iconColor and fillType are described as deprecated.

Should only be merged after the web PR (is released?)

@dschmidt dschmidt self-assigned this Oct 8, 2026
@dschmidt
dschmidt marked this pull request as ready for review October 8, 2026 09:35
Copilot AI balanced review requested due to automatic review settings October 8, 2026 09:35

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

馃煛 Changes recommended

Two interface snippets omit deprecated compatibility fields retained by the linked upstream change.

2 open findings
What changed in this PR

Documents the new design-system Icon type across web apps and extensions.

Changes:

  • Adds guidance for named and image icons.
  • Updates extension interfaces and examples to use Icon.
  • Notes deprecated sibling icon properties.
File Description
viewer-editor-apps/鈥媔ndex.md Updates file-extension icons.
extensions/鈥媔ndex.md Adds shared icon documentation.
right-sidebar-panel-extensions.md Updates sidebar panel icons.
resource-indicator-extensions.md Updates indicator icons and example.
left-sidebar-menu-item-extensions.md Links to icon guidance.
folder-view-extensions.md Links to icon guidance.
floating-action-button-extensions.md Updates button icon type.
app-menu-item-extensions.md Updates menu-item icon type.
action-extensions.md Documents dynamic Icon values.
account-extensions.md Updates account extension icons.

馃 Review effort: Balanced


Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

category: 'system' | 'sharing' | 'space'
icon: string
fillType: IconFillType
icon: Icon
name: string
icon: string
iconFillType?: IconFillType
icon: Icon
@dschmidt

dschmidt commented Oct 8, 2026

Copy link
Copy Markdown
Contributor Author

Talked to @JammingBen: we both disagree with CoPilot here. We find it's confusing to have that in the docs.
The docs should reflect the current best practices. If developers need more detailed information on their old code, they can checkout actual types or old versions of the docs.

@dschmidt
dschmidt marked this pull request as draft October 8, 2026 10:00

@JammingBen JammingBen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 馃憤 Marked as draft until after the upcoming rolling release has been released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants