blob: 2e9cdefe6731d12a5a0554ca52fc8713d08453b8 [file] [log] [blame]
// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import Flutter
import Foundation
import UIKit
@objc extension UIImage {
/// Loads a UIImage from the embedded Flutter project's assets.
/// This method loads the Flutter asset that is appropriate for the current
/// screen. If you are on a 2x retina device where usually `UIImage` would be
/// loading `@2x` assets, it will attempt to load the `2.0x` variant. It will
/// load the standard image if it can't find the `2.0x` variant.
/// For example, if your Flutter project's `pubspec.yaml` lists "assets/foo.png"
/// and "assets/2.0x/foo.png", calling
/// `[UIImage flutterImageWithName:@"assets/foo.png"]` will load
/// "assets/2.0x/foo.png".
/// See also
/// Note: We don't yet support images from package dependencies (ex.
/// `AssetImage('icons/heart.png', package: 'my_icons')`).
public static func flutterImageWithName(_ name: String) -> UIImage? {
let filename = (name as NSString).lastPathComponent
let path = (name as NSString).deletingLastPathComponent
for screenScale in stride(from: Int(UIScreen.main.scale), to: 1, by: -1) {
// TODO(hellohuanlin): Fix duplicate slashes in this path construction.
let key = FlutterDartProject.lookupKey(forAsset: "\(path)/\(screenScale).0x/\(filename)")
if let image = UIImage(named: key, in: Bundle.main, compatibleWith: nil) {
return image
let key = FlutterDartProject.lookupKey(forAsset: name)
return UIImage(named: key, in: Bundle.main, compatibleWith: nil)