podman-desktop/website/docs/extensions/developing/adding-icons.md
Charlie Drage 6526388812
docs: update the extensions section (#7061)
### What does this PR do?

* Renames the extension section to just "Extensions"
* Moved Installing to #1 in the list
* Changes "Write" to "Developing" section
* Adds redirect links
* Move publishing to bottom part

### Screenshot / video of UI

<!-- If this PR is changing UI, please include
screenshots or screencasts showing the difference -->

### What issues does this PR fix or reference?

<!-- Include any related issues from Podman Desktop
repository (or from another issue tracker). -->

Part of https://github.com/containers/podman-desktop/issues/6883
discussion (does not close it though)

### How to test this PR?

<!-- Please explain steps to verify the functionality,
do not forget to provide unit/component tests -->

Visit the site :)

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
2024-05-03 14:16:12 +00:00

1.4 KiB

sidebar_position title description tags keywords
4 Adding icons Podman Desktop and resources icons
podman-desktop
extension
writing
icons
podman desktop
extension
writing
icons

Adding icons

Podman Desktop allows extensions to register custom icons that can be used for resources based on certain condition defined by a when clause.

For example, the Kind extension register a custom icons by using the following instruction.

"icons": {
  "kind-icon": {
    "description": "Kind icon",
    "default": {
      "fontPath": "kind-icon.woff2",
      "fontCharacter": "\\EA01"
    }
  }
}

We restrict the format to the Web Open Font Format 2 (aka woff2) to use icons as text, to keep consistency across the UI, as the color and size is managed by Podman-Desktop.

Creating a .woff2 file

You probably have an existing .svg file that you want to use, to make it possible you can use the tool svgiconfont made by @nfroidure.

To ensure the produced .woff2 file contains the expected characters you created from your svg file(s). You can use the tool fontforge.org to visualize it.

:::info

To find the fontCharacter where your icons has been saved, you can search inside the FontForge tool by the name of the svg file you used.

:::