Use Enums for Tags

#swiftui #swift

This article assumes you know what an Enum or Enumeration in Swift is, and will explain why they are a perfect use case for tags in iOS and macOS development. If you want to read more about Enums, the Swift website is a great resource!

What are tags?

A tag is an Int that is assigned in a view. If you create a new iOS app in Xcode that is a Tabbed app, you'll notice that the 2 tab views have a .tag() associated with each view. In the gist below, you can see that on lines 16 and 25.

	import SwiftUI

	struct ContentView: View {
	@State private var selection = 0

	var body: some View {
	TabView(selection: $selection){
	Text("First View")
	.font(.title)
	.tabItem {
	VStack {
	Image("first")
	Text("First")
	}
	}
	.tag(0)
	Text("Second View")
	.font(.title)
	.tabItem {
	VStack {
	Image("second")
	Text("Second")
	}
	}
	.tag(1)
	}
	}
	}

	struct ContentView_Previews: PreviewProvider {
	static var previews: some View {
	ContentView()
	}
	}

view raw use-enums-for-tags_001.swift hosted with ❤ by GitHub

If you have a lot of tabs in this view, then you might get confused about which tag number is associate with which tab. Enums can help make these tags more descriptive and more readable.

How do Enums help?

Enums have cases that are labeled and can conform to the Hashable protocol, which is needed for tags in SwiftUI.

An example of an Enum for views in a todo app can look like this

	private enum Tabs: Hashable {
	case inbox
	case projects
	case settings
	}

view raw use-enums-for-tags_002.swift hosted with ❤ by GitHub

When declaring the enum, we need to make sure that it conforms to the Hashable protocol. We don't need to do anything else besides adopt it since there are no associated values with the cases. If there were associated values, then we would need to make sure those values are conforming to the protocol.

Those enum cases in the gist above are a lot more readable than the numbers. We know from a glance what view will be taken by pressing that tab.

How to implement the Enum in the app

Now, I am going to implement Tabs into the SwiftUI app created earlier. After declaring the enum in ContentView.swift, I need to change the State to be the inbox view, so the value of state needs to be Tabs.inbox. Next, I need to change the tags values to Tabs.inbox, Tabs.projects, and Tabs.settings. The gist below shows the final code of the project.

	import SwiftUI

	struct ContentView: View {
	@State private var selection = Tabs.inbox

	private enum Tabs: Hashable {
	case inbox
	case projects
	case settings
	}

	var body: some View {
	TabView(selection: $selection){
	Text("This will be inbox")
	.font(.title)
	.tabItem {
	VStack {
	Image(systemName: "tray.fill")
	Text("Inbox")
	}
	}
	.tag(Tabs.inbox)
	Text("This will be projects")
	.font(.title)
	.tabItem {
	VStack {
	Image(systemName: "folder.fill")
	Text("Projects")
	}
	}
	.tag(Tabs.projects)
	Text("This will be settings")
	.font(.title)
	.tabItem {
	VStack {
	Image(systemName: "gear")
	Text("Settings")
	}
	}
	.tag(Tabs.settings)
	}
	}
	}

	struct ContentView_Previews: PreviewProvider {
	static var previews: some View {
	ContentView()
	}
	}