[Swift]UILabelの好きな場所に画像を追加し、行間を設定できる拡張メソッド

やりたい事

UILabelの先頭に画像を追加して、Labelが複数行になった際の行間を追加できるメソッドを作る。
（Labelの末尾に画像を追加するなら、比較的簡単だけど…末尾以外だとちょっとややこしい）

• Labelが複数行で行間を設定できる
• textの先頭に画像を置く

↓イメージはこんな感じです。。。（※下記のコードを実行してもこのイメージの様にはなりません）

「 ねこさんかわいい
　かわいいねこさん」

コード

.swift

extension UILabel {
    func setupSpacingAndImage(
        _ text: String, spacingHeight: Float, image: UIImage, at index: Int, size: CGSize? = nil
    ) {
        let attributedString = NSMutableAttributedString()

        let attachment = NSTextAttachment(image: image, font: font, size: size ?? image.size, alignment: .center)
        attributedString.append(NSAttributedString(attachment: attachment))
        attributedString.append(NSAttributedString(string: text))

        let style = NSMutableParagraphStyle()
        style.lineSpacing = CGFloat(spacingHeight)

        let attributes: [NSAttributedString.Key: Any] = [
            .paragraphStyle: style
        ]
        attributedString.addAttributes(attributes, range: NSRange(location: index, length: attributedString.length))

        self.attributedText = attributedString
    }
}

使い方

.swift

// 引数imageは非Optionalなので、オプショナルバインディング
guard let image = UIImage(named: "imageName")
label.setupSpacingAndImage("Labelに表示したい複数行のテキスト", spacingHeight: 6, image: image, at: 0, size: CGSize(width: 16, height: 16))

引数の簡単な説明

"Labelに表示したい複数行のテキスト"
-> Labelのtextとして設定したい文字。引数名は省略しています。

spacingHeight: 6
-> 行間の高さを設定。

image: image
-> 挿入したい画像

at: 0
-> 何文字目に画像を挿入するか。メソッド内では、 at index: Intによりatで設定した値をindexとして使用しています。

size: CGSize(width: 16, height: 16))
-> 画像のサイズです。ここを設定しない場合は、画像本来のサイズを設定します。