ADPhotoKit Documentation

Class ADPhoto​Kit​Configuration 

public class ADPhotoKitConfiguration

Class to modify ADPhotoKit's configuration.

Nested Types

ADPhotoKitConfiguration.ThumbnailControllerLayout

Layout to control thumbnail controller collection appearance.

Properties

`default` 

public static var `default`

Represents a shared configuration used across ADPhotoKit. Use this instance for modify configuration.

locale 

public var locale: Locale?

Set framework language, if set nil, framework will use system language. Default is nil.

custom​Locale​Value 

public var customLocaleValue: [Locale:[ADLocale.LocaleKey: String]]?

You can custom display text for diffent language on yourself. Default is nil.

custom​Album​Orders 

public var customAlbumOrders: [ADAlbumType]?

Custom album orders, if type not contain, it will not display. Default is ordered by ADAlbumType.allCases 's order.

custom​Alert 

public var customAlert: ADAlertConfigurable.Type?

Custom alert. Default to use alert in framework.

custom​Core​UIBundle 

public var customCoreUIBundle: Bundle?

You can custom core image Bundle by this property or simple replace image in ADPhotoKitCoreUI.bundle. Default is ADPhotoKitCoreUI.bundle.

status​Bar​Style 

public var statusBarStyle: UIStatusBarStyle?

Set status bar style, Default is .lightContent.

custom​Progress​HUDBlock 

public var customProgressHUDBlock: (() -> ADProgressHUDable)?

Bolck to generate ProgressHUD. Default to use hud in framework.

custom​Progress​Block 

public var customProgressBlock: (() -> ADProgressableable)?

Bolck to generate ProgressView. Default to use view in framework.

fetch​Timeout 

public var fetchTimeout: TimeInterval = 20

Timeout for request images from select assets. Defaults is 20.

custom​Album​List​Controller​Block 

public var customAlbumListControllerBlock: ((ADAlbumListController) -> Void)?

Block to config ADAlbumListController.

custom​Album​List​Nav​Bar​Block 

public var customAlbumListNavBarBlock: (() -> ADAlbumListNavBarable)?

Bolck to generate AlbumListNavBar. Default to use ADAlbumListNavBarView.

custom​Album​List​Cell​Registor 

public var customAlbumListCellRegistor: ((UITableView) -> Void)?

Bolck to regist cells used in albumlist controller.

custom​Album​List​Cell​Block 

public var customAlbumListCellBlock: ((UITableView, IndexPath) -> ADAlbumListCellable)?

Bolck to return custom album list cell.

auto​Scroll​Max​Speed 

public var autoScrollMaxSpeed: CGFloat = 600

The max speed (pt/s) of auto scroll. Defaults to 600.

thumbnail​Layout 

public var thumbnailLayout

Control thumbnail controller collection appearance.

custom​Thumbnail​Controller​Block 

public var customThumbnailControllerBlock: ((ADThumbnailViewController) -> Void)?

Block to config ADThumbnailViewController.

custom​Thumbnail​Nav​Bar​Block 

public var customThumbnailNavBarBlock: ((ADPickerStyle) -> ADThumbnailNavBarable)?

Bolck to generate ThumbnailNavBar. Default to use ADThumbnailNavBarView. The parameter ADPickerStyle is the style of bar.

custom​Thumbnail​Tool​Bar​Block 

public var customThumbnailToolBarBlock: ((ADPhotoKitConfig) -> ADThumbnailToolBarable)?

Bolck to generate ThumbnailToolBar. Default to use ADThumbnailToolBarView. The parameter ADPhotoKitConfig is the config pass through.

custom​Thumbnail​Cell​Registor 

public var customThumbnailCellRegistor: ((UICollectionView) -> Void)?

Bolck to regist cells used in thumbnail controller.

custom​Thumbnail​Cell​Block 

public var customThumbnailCellBlock: ((UICollectionView, IndexPath) -> ADThumbnailCellable)?

Bolck to return custom thumbnail collection cell.

browse​Item​Spacing 

public var browseItemSpacing: CGFloat = 40

Space between browser controller item.

custom​Browser​Controller​Block 

public var customBrowserControllerBlock: ((ADAssetBrowserController) -> Void)?

Block to config ADAssetBrowserController.

custom​Browser​Nav​Bar​Block 

public var customBrowserNavBarBlock: ((ADAssetBrowserDataSource) -> ADBrowserNavBarable)?

Bolck to generate BrowserNavBar. Default to use ADBrowserNavBarView. The parameter ADAssetBrowserDataSource is the datasource of browser controller.

custom​Browser​Tool​Bar​Block 

public var customBrowserToolBarBlock: ((ADAssetBrowserDataSource) -> ADBrowserToolBarable)?

Bolck to generate BrowserToolBar. Default to use ADBrowserToolBarView. The parameter ADAssetBrowserDataSource is the datasource of browser controller.

custom​Browser​Cell​Registor 

public var customBrowserCellRegistor: ((UICollectionView) -> Void)?

Bolck to regist cells used in browser controller.

custom​Browser​Cell​Block 

public var customBrowserCellBlock: ((UICollectionView, IndexPath, ADAsset) -> ADBrowserCellable)?

Bolck to return custom browser collection cell. The parameter ADAsset is the asset to browser.

custom​Image​Edit​Bundle 

public var customImageEditBundle: Bundle?

You can custom image edit image Bundle by this property or simple replace image in ADPhotoKitImageEdit.bundle. Default is ADPhotoKitImageEdit.bundle.

system​Image​Edit​Tools 

public var systemImageEditTools: ADImageEditTools = .all

System image edit tools. Default is ordered by ADImageEditTools.all 's order. You can remove some tools or reorder.

custom​Image​Edit​Tools​Block 

public var customImageEditToolsBlock: ((UIImage) -> [ADImageEditTool])?

User custom image edit tools. Custom tools is default add after system tools.

Parameters

image

Original image.

line​Draw​Colors 

public var lineDrawColors: [UIColor] = [.white, .black, UIColor(hex: 0xF14F4F)!, UIColor(hex: 0xF3AA4E)!, UIColor(hex: 0x10C060)!, UIColor(hex: 0x1EB7F3)!, UIColor(hex: 0x8B69EA)!]

System line draw tool selectable colors.

line​Draw​Default​Color​Index 

public var lineDrawDefaultColorIndex: Int = 2

System line draw tool default color index.

line​Draw​Width 

public var lineDrawWidth: CGFloat = 5

System line draw tool default line width.

mosaic​Draw​Width 

public var mosaicDrawWidth: CGFloat = 25

System mosaic draw tool default line width.

image​Sticker​Data​Source 

public var imageStickerDataSource: ADImageStickerDataSource?

System image picker data source.

custom​Image​Sticker​Select​VC 

public var customImageStickerSelectVC: ADImageStickerSelectable?

Custom image sticker select controller.

custom​Text​Sticker​Edit​VCBlock 

public var customTextStickerEditVCBlock: ((ADTextSticker?) -> ADTextStickerEditable)?

Custom text sticker edit controller.

text​Sticker​Colors 

public var textStickerColors: [ADTextStickerColor] = [(.white,.black),(.black,.white),(UIColor(hex: 0xF14F4F)!,.white),(UIColor(hex: 0xF3AA4E)!,.white),(UIColor(hex: 0x10C060)!,.white),(UIColor(hex: 0x1EB7F3)!,.white),(UIColor(hex: 0x8B69EA)!,.white)]

System text sticker selectable colors.

text​Sticker​Default​Color​Index 

public var textStickerDefaultColorIndex: Int = 0

System text sticker tool default color index.

custom​Image​Clip​VCBlock 

public var customImageClipVCBlock: ((ADClipInfo) -> ADImageClipable)?

Custom image clip controller.