CNTimelineCell

CNTimelineCell is a helpful framework to generate a timeline with UITableView.

Sample screenshot:

---

Requirements

• iOS 11+
• Swift 5.3+

---

Installation

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding CNTimelineCell as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/chrisnyw/CNTimelineCell", from: "0.3")
]

---

How to use

- Import CNTimelineCell

Import CNTimelineCell when you need.

import CNTimelineCell

Prepare your [CNTimelineCellItem], for examples:

  let dataItem: [CNTimelineCellItem] = [CNTimelineCellItem(title: "Sample", content: "Sample for LeftTimeline\nlineType = .none", leftType: .none),
                                    CNTimelineCellItem(title: "Start", content: "lineType = .start", image: UIImage(named: "star"), leftType: .start),
                                    CNTimelineCellItem(title: "Spot", content: "lineType = .spot", leftType: .spot),
                                    CNTimelineCellItem(title: "Line", content: "lineType = .line", image: UIImage(named: "moon"), leftType: .line),
                                    CNTimelineCellItem(title: "End", content: "lineType = .end", image: UIImage(named: "school"), leftType: .end),]

Register TableViewCell as below:

    let timelineTableViewCellNib = UINib(nibName: CNTimelineCell.identifier, bundle: CNTimelineCell.bundle)
    self.tableView.register(timelineTableViewCellNib, forCellReuseIdentifier: CNTimelineCell.identifier)

Render your cell:

  override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
    let cell = tableView.dequeueReusableCell(withIdentifier: CNTimelineCell.identifier, for: indexPath) as! CNTimelineCell
    
    let timelineItem = dataItem[indexPath.row]
    cell.setCell(item: timelineItem)
    // or set pass your custom CNTimelineCellStyle:
    // cell.setCell(item: timelineItem, style: timelineStyle)
    return cell
  }

With the configuration above, you will have the result like this:

---

Configuration

CNTimelineCellItem

• var title: String message title
• var content: String? message content
• var image: UIImage? image icon
• var leftType: TimelineType left TimelineType (default: .none)
• var rightType: TimelineType right TimelineType (default: .none)

Sample CNTimelineCellItem:

  let dataItem: [CNTimelineCellItem] = [CNTimelineCellItem(title: "Good morning", content: "Today is sunny day!", image: UIImage(named: "light")),
                                        CNTimelineCellItem(title: "08:00 am", content: "Tom wakes up", image: UIImage(named: "star"), leftType: .start),
                                        CNTimelineCellItem(title: "08:05 am", content: "Breakfast time", leftType: .spot),
                                        CNTimelineCellItem(title: "08:30 am", content: "Mary wakes up", image: UIImage(named: "star"), leftType: .line, rightType: .start),
                                        CNTimelineCellItem(title: "09:00 am", content: "School time", image: UIImage(named: "school"), leftType: .spot, rightType: .spot),
                                        CNTimelineCellItem(title: "09:00 am - 12:00pm", content: "Many lessons\nMath\nEnglish\netc...", leftType: .line, rightType: .line),
                                        CNTimelineCellItem(title: "12:05 pm", content: "Lunch together", image: UIImage(named: "restaurant"), leftType: .spot, rightType: .spot),
                                        CNTimelineCellItem(title: "01:00 pm", content: "Outdoor activities, play games in sports court.", image: UIImage(named: "sports_basketball"), leftType: .spot, rightType: .spot),

                                        CNTimelineCellItem(title: "until 03:00 pm", content: "Afternoon lesson", leftType: .line, rightType: .line),
                                        CNTimelineCellItem(title: "03:00 pm", content: "Free time", leftType: .spot, rightType: .spot),
                                        CNTimelineCellItem(title: "03:30 pm", content: "Art lesson", leftType: .line, rightType: .spot),
                                        CNTimelineCellItem(title: "03:15 pm", content: "Take a nap", leftType: .end, rightType: .line),
                                        CNTimelineCellItem(title: "04:00 pm", content: "Play in playground", leftType: .none, rightType: .spot),
                                        CNTimelineCellItem(title: "04:15 pm", content: "Wake up from nap", leftType: .start, rightType: .line),
                                        CNTimelineCellItem(title: "05:00 pm", content: "Play TV games", leftType: .spot, rightType: .line),
                                        CNTimelineCellItem(title: "07:00 pm", content: "Dinner", image: UIImage(named: "restaurant"), leftType: .line, rightType: .spot),
                                        CNTimelineCellItem(title: "08:00 pm", content: "Dinner", image: UIImage(named: "restaurant"), leftType: .spot, rightType: .line),
                                        CNTimelineCellItem(title: "10:00 pm", content: "Goto sleep", image: UIImage(named: "bed"), leftType: .line, rightType: .end),
                                        CNTimelineCellItem(title: "10:30 pm", content: "Goto sleep", image: UIImage(named: "single_bed"), leftType: .end, rightType: .none),
                                        CNTimelineCellItem(title: "Awesome", content: "That's all for the day", image: UIImage(named: "auto_awesome")),]

Update style and item in cellForRowAtIndexPath

  override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
    let cell = tableView.dequeueReusableCell(withIdentifier: CNTimelineCell.identifier, for: indexPath) as! CNTimelineCell
    
    let timelineItem = dataItem[indexPath.row]
    
////    // sample for change border color
    if indexPath.row == dataItem.count-1 || indexPath.row == 0 {
      timelineStyle.bubbleStyle.borderColor = .orange
    } else {
      timelineStyle.bubbleStyle.borderColor = .init(red: 0/255, green: 147/255, blue: 51/255, alpha: 1)
    }
//
////    // sample for change backgroundColor of bubbleView
    if indexPath.row == 3 {
      timelineStyle.bubbleStyle.backgroundColor = .lightGray
      timelineStyle.messageSeparator = .orange
    } else {
      timelineStyle.bubbleStyle.backgroundColor = .clear
      timelineStyle.messageSeparator = .lightGray
    }

    cell.setCell(item: timelineItem, style: timelineStyle)
    
    return cell
  }

Output:

Styling

LineType

There are five line types in TimelineType: start, end, spot, line and none

LineType	.start	.spot	.line	.end	.none
LineType style

LineStyle

Line style can be configured by LineStyle struct.

• var lineWidth: CGFloat width of the central line (default: 6.0)
• var spotDiameter: CGFloat diameter of circle spot (default: 20.0)
• var spotColor: UIColor color of central circle spot (default .white)
• var lineColor: UIColor color of line (default RGB(0, 144, 182))
• var spotOffsetY: CGFloat vertical offset of spot (default: 29.0)

LineStyle	default	lineWidth = 10	spotDiameter = 12	spotColor = .orange	lineColor = .magenta	.spotOffsetY = 50
Output

BubbleStyle

Set the dialog style using BubbleStyle object

• var arrowOffsetY: CGFloat vertical offset of arrow (default: 30.0)
• var borderWidth: CGFloat width of border (default: 2.0)
• var borderColor: UIColor color of border (default: RBC(0, 147, 51))
• public var backgroundColor: UIColor button background color (default .clear)

BubbleStyle	Output
default
borderWidth = 8.0
borderColor = .orange
backgroundColor = .systemGray6
arrowOffsetY = 50.0

CNTimelineCellStyle

Pass the LineStyle and BubbleStyle to CNTimelineCellStyle object to configure CNTimelineCell

• var leftLineStyle: LineStyle left Timeline style (default: LineStyle())
• var rightLineStyle: LineStyle right Timeline style (default: LineStyle())
• var bubbleStyle: BubbleStyle bubble message style (default: BubbleStyle())
• var messageSeparator: UIColor color of separator line in message (default: .lightGray)

---

Author

Chris Ng (chrisnyw@gmail.com)

---

License

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