Skip to content

Add icon theming support #2065

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

Closed
wants to merge 1 commit into from
Closed

Add icon theming support #2065

Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions docs/2_4_common_schema.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1863,6 +1863,22 @@ This enables high quality rendering and printing in importers.
The point (`x1`, `y1`) maps to the left lower corner of the PNG image or SVG viewport.
The point (`x2`, `y2`) maps to the right upper corner of the PNG image or SVG viewport.

====== Icon Theming

To support different user interface themes (e.g., light and dark mode), additional themed icon files may be provided alongside the default icon files.
Importers should select the appropriate icon file based on their current theme.

The naming convention for themed icon files is:

* `terminalsAndIcons/icon.png` and optionally `terminalsAndIcons/icon.svg` - Default icon (light theme)
* `terminalsAndIcons/icon-dark.png` and optionally `terminalsAndIcons/icon-dark.svg` - Dark theme variant
* `terminalsAndIcons/icon-{theme}.png` and optionally `terminalsAndIcons/icon-{theme}.svg` - Custom theme variants

All themed icon variants should use the same coordinate positioning as defined in the `<Icon>` element, as changing layout when switching themes would be undesirable.

_[Importers should check for themed icon files matching their current theme before falling back to the default icon._
_The default icon file (`icon.png`) should always be provided to ensure backward compatibility with importers that do not support theming.]_

====== Placement, Extent, and Painting Order of Graphical Items

image::images/GraphicalRepresentation.svg[width=70%, pdfwidth=70%, align="center"]
Expand Down Expand Up @@ -2105,6 +2121,19 @@ An additional SVG file with extension '.svg' is optional.

_[Note that this specification is functionally equivalent to looking up image sources from the `terminalsAndIcons` folder of the FMU ZIP archive after dot removal from the path as per section 5.2.4 of RFC 3986.]_

Similar to FMU icons, terminal icons may be provided in multiple theme variants to support different user interface themes.
The naming convention for themed terminal icon files follows the FMU icon pattern:

* `terminalsAndIcons/{iconBaseName}.png` and optionally `{iconBaseName}.svg` - Default terminal icon (light theme)
* `terminalsAndIcons/{iconBaseName}-dark.png` and optionally `{iconBaseName}-dark.svg` - Dark theme variant
* `terminalsAndIcons/{iconBaseName}-{theme}.png` and optionally `{iconBaseName}-{theme}.svg` - Custom theme variants

All themed terminal icon variants should use the same coordinate positioning as defined in the `<TerminalGraphicalRepresentation>` element.

_[Importers should check for themed terminal icon files matching their current theme before falling back to the default icon._
_The default icon file (with no theme suffix) should always be provided to ensure backward compatibility._
_Note that theme-specific connection colors cannot be specified in the XML, so the `defaultConnectionColor` applies to all themes.]_

The `defaultConnectionStrokeSize` and `defaultConnectionColor` can be provided to define the intended connection line layout in the importer.
The stroke size is given relative to the coordinate system extent.
The stroke color is given in RGB values from 0 to 255. E.g.: `255 255 0`.
Expand Down
21 changes: 21 additions & 0 deletions docs/2_5_fmu_distribution.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ terminalsAndIcons // FMU and terminal icons (optional)
terminalsAndIcons.xml // description of terminals and icons (optional)
icon.png // image file of icon without terminals (optional)
icon.svg // if existing the icon.png is required (optional)
icon-dark.png // image file for dark theme (optional)
icon-dark.svg // if existing the icon-dark.png is required (optional)
icon-{theme}.png // image file for custom theme icons (optional)
icon-{theme}.svg // SVG file for custom theme icons (optional)
// all terminal and fmu icons referenced in the
// graphical representation
sources // directory containing the C sources (optional)
Expand Down Expand Up @@ -79,6 +83,23 @@ _This will help the users to comply with license conditions when passing source

See <<fmiTerminalsAndIcons>> for a definition of the directory `terminalsAndIcons`.

The `terminalsAndIcons` directory contains the graphical representation metadata and icon image files.
Icon files may be provided in multiple theme variants to support different user interface themes (e.g., light and dark mode).

The following files may be present:

* `terminalsAndIcons.xml` - XML file defining terminals and graphical representations
* `icon.png` - FMU icon (required if any icons are provided)
* `icon.svg` - Optional SVG version of the FMU icon
* `icon-dark.png` - Optional dark theme variant of the FMU icon
* `icon-dark.svg` - Optional SVG version of the dark theme icon
* `icon-{theme}.png` - Optional custom theme variants of the FMU icon
* `icon-{theme}.svg` - Optional SVG versions of custom theme icons
* Terminal icon files following the naming convention: `{iconBaseName}.png`, `{iconBaseName}-dark.png`, `{iconBaseName}-{theme}.png`, and their optional `.svg` counterparts, as specified by `iconBaseName` attributes in `terminalsAndIcons.xml`

_[When providing themed icon variants, the default icon file (without theme suffix) must always be provided to ensure backward compatibility with importers that do not support theming._
_All themed variants should have the same dimensions and positioning as defined in the `terminalsAndIcons.xml` file.]_

===== Directory `sources` [[sources-directory]]

A source code FMU contains the sources of the model in the `sources` directory together with a `buildDescription.xml` that contains at least one <<BuildConfiguration>> element for the supported platforms.
Expand Down