Ubuntu.Components Icon

The Icon component displays an icon from the icon theme.

Import Statement: import Ubuntu.Components 1.3
Inherits: Item
Inherited By: ProgressionSlot.

Properties

Detailed Description

The icon theme contains a set of standard icons referred to by their name. Using icons whenever possible enhances consistency accross applications. Each icon has a name and can have different visual representations depending on the size requested.

Icons can also be colorized. Setting the color property will make all pixels with the keyColor (by default #808080) colored.

Example:

Icon {
    width: 64
    height: 64
    name: "search"
}

Example of colorization:

Icon {
    width: 64
    height: 64
    name: "search"
    color: UbuntuColors.warmGrey
}

Icon themes are created following the Freedesktop Icon Theme Specification .

Property Documentation

asynchronous : bool

The property drives the image loading of the icon. Defaults to false.

color : color

The color that all pixels that originally are of color keyColor should take.

keyColor : color

The color of the pixels that should be colorized. By default it is set to #808080.

name : string

The name of the icon to display.

If both name and source are set, name will be ignored.

Note: The complete list of icons available in Ubuntu is not published yet. For now please refer to the folders where the icon themes are installed:

  • Ubuntu Touch: /usr/share/icons/suru
  • Ubuntu Desktop: /usr/share/icons/ubuntu-mono-dark

These 2 separate icon themes will be merged soon.

source : url

The source url of the icon to display. It has precedence over name.

If both name and source are set, name will be ignored.

This QML property was introduced in Ubuntu.Components 1.1.