// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef IOS_CHROME_BROWSER_CONTENT_SUGGESTIONS_UI_CELLS_ICON_VIEW_CONFIGURATION_H_
#define IOS_CHROME_BROWSER_CONTENT_SUGGESTIONS_UI_CELLS_ICON_VIEW_CONFIGURATION_H_

#import <UIKit/UIKit.h>

#import "ios/chrome/browser/shared/ui/symbols/symbols.h"

enum class IconViewSourceType {
  // This icon should be retrieved from an SF symbol.
  kSymbol = 0,
  // This icon should be retrieved from a local image resource.
  kImage = 1,
  kMaxValue = kImage,
};

// Configuration for the `IconView`.
@interface IconViewConfiguration : NSObject

// Content properties.
// YES if this icon should configure itself in a smaller, compact
// size.
@property(nonatomic, assign) BOOL compactLayout;
// YES if this icon should place itself within a square enclosure.
@property(nonatomic, assign) BOOL inSquare;

// Icon properties.
// The type of resource to retrieve this icon from.
@property(nonatomic, assign) IconViewSourceType iconSource;
// The name of the image for the icon. Nil if it is a symbol.
@property(nonatomic, copy) NSString* iconName;
// The Symbol to use.
@property(nonatomic, assign) Symbol symbol;
// The color palette of the icon.
@property(nonatomic, copy) NSArray<UIColor*>* symbolColorPalette;
// The background color of the icon.
@property(nonatomic, strong) UIColor* symbolBackgroundColor;
// The width of the icon.
@property(nonatomic, assign) CGFloat iconWidth;

// Convenience initializer to create a configuration with a `symbol`.
+ (instancetype)configurationWithSymbol:(Symbol)symbol;

// Convenience initializer to create a configuration with an `image`.
+ (instancetype)configurationWithImageNamed:(NSString*)imageName;

@end

#endif  // IOS_CHROME_BROWSER_CONTENT_SUGGESTIONS_UI_CELLS_ICON_VIEW_CONFIGURATION_H_