Skip to content

Latest commit

 

History

History
286 lines (216 loc) · 7.24 KB

README.md

File metadata and controls

286 lines (216 loc) · 7.24 KB
Raw

TagList

CI Status Version Platform Swift 3.0 Carthage compatible License

TagList, flexible tag list view, easy to use & extend. I love it.

TagList

Contents

Features

  • Tag interaction
  • Self sizing
  • Easy to use
  • Customizable
  • Easy to extend

Requirements

  • iOS 8.0+ / Mac OS X 10.11+ / tvOS 9.0+
  • Xcode 8.0+
  • Swift 3.0+

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate TagList into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'TagList', '~> 0.3.0'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate TagList into your Xcode project using Carthage, specify it in your Cartfile:

github "xiongxiong/TagList" ~> 0.3.0

Run carthage update to build the framework and drag the built TagList.framework into your Xcode project.

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate TagList into your project manually.

Demo

Open the demo project, build and run.

Protocols

TagListDelegate

public protocol TagListDelegate: NSObjectProtocol {

    func tagActionTriggered(tagList: TagList, action: TagAction, content: TagPresentable, index: Int)
    func tagListUpdated(tagList: TagList)
}

TagPresentable

public protocol TagPresentable {

    var tag: String { get }
    var isSelected: Bool { get set }

    func createTagContent() -> TagContent
}

TagActionable

public protocol TagActionable {

    var actionDelegate: TagActionDelegate? { get set }
}

TagActionDelegate

public protocol TagActionDelegate: NSObjectProtocol {

    func tagActionTriggered(action: TagAction)
}

TagStatable

public protocol TagStatable {

    var stateDelegate: TagStateDelegate? { get set }
}

TagStateDelegate

public protocol TagStateDelegate: NSObjectProtocol {

    func tagSelected(_ isSelected: Bool)
}

TagWrapperDelegate

protocol TagWrapperDelegate: TagActionable, TagActionDelegate, TagStatable, TagStateDelegate {

    func wrap(target: TagContent) -> TagWrapper
    func wrap(wrapper: TagWrapper) -> TagWrapper
}

Usage

Import SwiftTagList

import SwiftTagList

Implement TagListDelegate [Optional]

extension ViewController: TagListDelegate {

    // Called when tagList's content changed
    func tagListUpdated(tagList: TagList) {
        ...
    }

    // Tag interaction
    func tagActionTriggered(tagList: TagList, action: TagAction, content: TagPresentable, index: Int) {
        ...
    }
}

Initialize TagList

let view = TagList()
view.delegate = self
view.backgroundColor = UIColor.yellow
view.tagMargin = UIEdgeInsets(top: 3, left: 5, bottom: 3, right: 5)
view.separator.image = #imageLiteral(resourceName: "icon_arrow_right")
view.separator.size = CGSize(width: 16, height: 16)
view.separator.margin = UIEdgeInsets(top: 0, left: 5, bottom: 0, right: 5)
...

Set Frame

override func viewDidAppear(_ animated: Bool) {
        super.viewDidAppear(animated)

        tagList.frame = CGRect(origin: CGPoint.zero, size: CGSize(width: areaList.frame.width, height: 0))
    }

Customizable

TagPresentableText, TagPresentableIcon & TagPresentableIconText are already implemented, you can use it straightforwardly, or you can choose to implement TagPresentable and subclass TagContent to create your own tag.

Properties & Methods

TagList

Properties

var delegate: TagListDelegate?
var tags: [Tag] = []
var horizontalAlignment: TagHorizontalAlignment = .left | .right | .center
var verticalAlignment: TagVerticalAlignment = .left | .right | .center
var tagMargin = UIEdgeInsets(top: 3, left: 3, bottom: 3, right: 3)
var separator: SeparatorInfo = SeparatorInfo()
var isSeparatorEnabled = false
var isAutowrap = true
var selectionMode: TagSelectionMode = .none | .single | .multiple

Manage tags

func tagPresentables() -> [TagPresentable]
func selectedTagPresentables() -> [TagPresentable]

Example

let tag = Tag(content: TagPresentableText("...") {
            $0.label.font = UIFont.systemFont(ofSize: 16)
            }, onInit: {
                $0.padding = UIEdgeInsets(top: 8, left: 10, bottom: 8, right: 10)
                $0.layer.borderColor = UIColor.cyan.cgColor
                $0.layer.borderWidth = 2
                $0.layer.cornerRadius = 5
            }, onSelect: {
            $0.backgroundColor = $0.isSelected ? UIColor.orange : UIColor.white
        })
tag.wrappers = [TagWrapperRemover(onInit: {
                    $0.deleteButton.setImage(UIImage(named: "icon_delete")).withRenderingMode(.alwaysTemplate), for: .normal)
                    $0.space = 8
                }) {
                    $0.deleteButton.tintColor = $1 ? UIColor.white : UIColor.black
              }]
tagList.tags.append(tag)

Tag

Initialization

init(content: TagPresentable, onInit: ((Tag) -> Void)? = nil, onSelect: ((Tag) -> Void)? = nil)

Properties

var content: TagPresentable { get }
var wrappers: [TagWrapper] = []
var padding: UIEdgeInsets = UIEdgeInsets(top: 3, left: 3, bottom: 3, right: 3)
var isSelected: Bool

TagPresentableText

init(_ tag: String, onContentInit: ((TagContentText) -> Void)? = nil)

TagPresentableIcon

init(_ tag: String, icon: String, onContentInit: ((TagContentIcon) -> Void)? = nil)

TagPresentableIconText

init(_ tag: String, icon: String, onContentInit: ((TagContentIconText) -> Void)? = nil)

TagWrapperRemover

init(onInit: ((TagWrapperRemover) -> Void)? = nil, onSelect: ((TagWrapperRemover, Bool) -> Void)? = nil)

Author

xiongxiong, [email protected]

License

TagList is available under the MIT license. See the LICENSE file for more info.