IconLabel.qml

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Pier Luigi Fiorini <pierluigi.fiorini@gmail.com>
// SPDX-License-Identifier: MPL-2.0
 
import QtQuick
import Fluid as MD
 
Item {
    id: root
    Accessible.ignored: true
 
    enum Display {
        IconOnly,
        TextOnly,
        TextBesideIcon,
        TextUnderIcon
    }
 
    component IconData: QtObject {
        property string name
        property url source
        property real width: -1
        property real height: -1
        property color color
    }
 
    property IconData icon: IconData {}
 
    property alias text: label.text
 
    property alias typescale: label.typescale
 
    property alias lineHeight: label.lineHeight
 
    property alias color: label.color
 
    property real textOpacity: 1.0
 
    property bool mirrored: false
 
    property bool mirrorIconInRtl: false
 
    readonly property bool hasIcon: icon.name.length > 0 || icon.source.toString().length > 0
 
    readonly property bool showIcon: hasIcon && display !== MD.IconLabel.TextOnly
 
    readonly property bool showText: text.length > 0 && display !== MD.IconLabel.IconOnly
 
    property int display: MD.IconLabel.TextBesideIcon
 
    readonly property int effectiveDisplay: {
        switch (display) {
        case MD.IconLabel.TextBesideIcon:
        case MD.IconLabel.TextUnderIcon:
            if (showIcon && showText)
                return display;
            return showIcon ? MD.IconLabel.IconOnly : MD.IconLabel.TextOnly;
        default:
            return display;
        }
    }
 
    property real spacing: MD.Tokens.measurement.space100
 
    readonly property real effectiveSpacing: showIcon && showText ? spacing : 0
 
    implicitWidth: {
        switch (effectiveDisplay) {
        case MD.IconLabel.IconOnly:
            return iconItem.implicitWidth;
        case MD.IconLabel.TextOnly:
            return label.implicitWidth;
        case MD.IconLabel.TextBesideIcon:
            return iconItem.implicitWidth + label.implicitWidth + effectiveSpacing;
        case MD.IconLabel.TextUnderIcon:
            return Math.max(iconItem.implicitWidth, label.implicitWidth);
        }
    }
    implicitHeight: {
        switch (effectiveDisplay) {
        case MD.IconLabel.IconOnly:
            return iconItem.implicitHeight;
        case MD.IconLabel.TextOnly:
            return label.implicitHeight;
        case MD.IconLabel.TextBesideIcon:
            return Math.max(iconItem.implicitHeight, label.implicitHeight);
        case MD.IconLabel.TextUnderIcon:
            return iconItem.implicitHeight + label.implicitHeight + effectiveSpacing;
        }
    }
 
    Item {
        id: iconItem
        objectName: "iconLabelIcon"
 
        implicitWidth: root.icon.width
        implicitHeight: root.icon.height
        visible: root.showIcon
 
        transform: Scale {
            objectName: "iconLabelMirrorTransform"
            origin.x: iconItem.width / 2
            origin.y: iconItem.height / 2
            xScale: root.mirrorIconInRtl && root.mirrored ? -1 : 1
        }
 
        Image {
            objectName: "iconLabelSourceImage"
            anchors.fill: parent
            source: root.icon.source
            sourceSize: Qt.size(root.icon.width, root.icon.height)
            fillMode: Image.PreserveAspectFit
            visible: root.icon.source.toString().length > 0
        }
 
        MD.Symbol {
            objectName: "iconLabelSymbol"
            anchors.fill: parent
            name: root.icon.name
            iconWidth: root.icon.width
            iconHeight: root.icon.height
            color: root.icon.color.a > 0 ? root.icon.color : label.color
            visible: root.icon.source.toString().length === 0 && name.length > 0
        }
    }
 
    MD.Label {
        id: label
        objectName: "iconLabelText"
 
        font.pixelSize: typescale.fontSize
        font.weight: typescale.fontWeight
        //font.letterSpacing: typescale.tracking
 
        wrapMode: MD.Label.NoWrap
        elide: MD.Label.ElideRight
        opacity: root.textOpacity
        visible: root.showText && opacity > 0
    }
 
    states: [
        State {
            name: "iconOnly"
            when: root.effectiveDisplay === MD.IconLabel.IconOnly
 
            AnchorChanges {
                target: iconItem
                anchors.left: undefined
                anchors.right: undefined
                anchors.top: undefined
                anchors.bottom: undefined
                anchors.horizontalCenter: root.horizontalCenter
                anchors.verticalCenter: root.verticalCenter
            }
 
            AnchorChanges {
                target: label
                anchors.left: undefined
                anchors.right: undefined
                anchors.top: undefined
                anchors.bottom: undefined
                anchors.horizontalCenter: undefined
                anchors.verticalCenter: undefined
            }
        },
        State {
            name: "textOnly"
            when: root.effectiveDisplay === MD.IconLabel.TextOnly
 
            AnchorChanges {
                target: label
                anchors.left: undefined
                anchors.right: undefined
                anchors.top: undefined
                anchors.bottom: undefined
                anchors.horizontalCenter: root.horizontalCenter
                anchors.verticalCenter: root.verticalCenter
            }
 
            AnchorChanges {
                target: iconItem
                anchors.left: undefined
                anchors.right: undefined
                anchors.top: undefined
                anchors.bottom: undefined
                anchors.horizontalCenter: undefined
                anchors.verticalCenter: undefined
            }
        },
        State {
            name: "textBesideIcon"
            when: root.effectiveDisplay === MD.IconLabel.TextBesideIcon && !root.mirrored
 
            AnchorChanges {
                target: iconItem
                anchors.left: root.left
                anchors.right: undefined
                anchors.top: undefined
                anchors.bottom: undefined
                anchors.horizontalCenter: undefined
                anchors.verticalCenter: root.verticalCenter
            }
 
            AnchorChanges {
                target: label
                anchors.left: iconItem.right
                anchors.right: undefined
                anchors.top: undefined
                anchors.bottom: undefined
                anchors.horizontalCenter: undefined
                anchors.verticalCenter: root.verticalCenter
            }
 
            PropertyChanges {
                label.anchors.leftMargin: root.effectiveSpacing
                label.anchors.rightMargin: 0
                label.anchors.topMargin: 0
                label.anchors.bottomMargin: 0
            }
        },
        State {
            name: "textBesideIconMirrored"
            when: root.effectiveDisplay === MD.IconLabel.TextBesideIcon && root.mirrored
 
            AnchorChanges {
                target: iconItem
                anchors.left: undefined
                anchors.right: root.right
                anchors.top: undefined
                anchors.bottom: undefined
                anchors.horizontalCenter: undefined
                anchors.verticalCenter: root.verticalCenter
            }
 
            AnchorChanges {
                target: label
                anchors.left: undefined
                anchors.right: iconItem.left
                anchors.top: undefined
                anchors.bottom: undefined
                anchors.horizontalCenter: undefined
                anchors.verticalCenter: root.verticalCenter
            }
 
            PropertyChanges {
                label.anchors.leftMargin: 0
                label.anchors.rightMargin: root.effectiveSpacing
                label.anchors.topMargin: 0
                label.anchors.bottomMargin: 0
            }
        },
        State {
            name: "textUnderIcon"
            when: root.effectiveDisplay === MD.IconLabel.TextUnderIcon
 
            AnchorChanges {
                target: iconItem
                anchors.left: undefined
                anchors.right: undefined
                anchors.top: root.top
                anchors.bottom: undefined
                anchors.horizontalCenter: root.horizontalCenter
                anchors.verticalCenter: undefined
            }
 
            AnchorChanges {
                target: label
                anchors.left: undefined
                anchors.right: undefined
                anchors.top: iconItem.bottom
                anchors.bottom: undefined
                anchors.horizontalCenter: root.horizontalCenter
                anchors.verticalCenter: undefined
            }
 
            PropertyChanges {
                label.anchors.leftMargin: 0
                label.anchors.rightMargin: 0
                label.anchors.topMargin: root.effectiveSpacing
                label.anchors.bottomMargin: 0
            }
        }
    ]
}