zorro0799 / ionavigation Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kaevinio/ionavigation

1.0 0.0 0.0 1.35 MB

Beautiful Sidebar and Tabbar for iOS, iPadOS and macOS written in 100% SwiftUI 📱

License: MIT License

Swift 100.00%

ionavigation's Introduction

IOComponents

A simple and beautiful Sidebar, a Tabbar and a Navigationbar for iOS, iPadOS and macOS, written in 100% SwiftUI.

💰 Support

I fell in love with coding in 2016 and there has been no looking back since! If you, or your company, use any of my projects or like what I'm doing, kindly consider supporting me.

I really appreciate you buying me a coffee ☕️

👋 Let's Connect

Follow me on 👨‍💻 Github and stay updated on free and open-source software
Follow me on 🐦 Twitter to get updates on my latest projects

🪄 Features

📱 Screenshots

macOS

iPadOS

iOS

🎥 Preview

mac.mov

🛠 Installation

Requirements

iOS 15.0+ / macOS 12.0
Xcode 13+
Swift 5+

Swift Package Manager

In Xcode, go to File > Add Packages and add https://github.com/kaevinio/IONavigation.git. Add the package to all your targets.

📝 How to Use

Sidebar & Tabbar

The Sidebar consists of several groups, which contain individual views and is displayed on macOS and iPadOS. The Tabbar contains individual views and is available on iOS as well as in compact windows on iPadOS.

To use the package, you need to import IONavigation on top of the files you want to use it in
Create a new SwiftUI file and name it NavigationView (or whatever name you'd like for your navigation)
Add the respective environment value for checking the window size to determine whether the Sidebar or the Tabbar will be used (this is only available on iOS)

#if os(iOS)
@Environment(\.horizontalSizeClass) var horizontalSizeClass
#endif

In your view's body, setup the Sidebar and the Tabbar according to the horizontalSizeClass

#if os(iOS)
if horizontalSizeClass == .compact {
      Tabbar(items: tabbarItems, color: .purple)
} else {
      Sidebar(header: "IONavigation", color: .purple, itemGroups: sidebarItemGroups, actionIcon: Image(systemName: "plus.circle.fill"), action: add)
}
#else
Sidebar(header: "IONavigation", color: .purple, itemGroups: sidebarItemGroups, actionIcon: Image(systemName: "plus.circle.fill"), action: add)
#endif

Note: Header, actionIcon and action are optional. If you don't use a header, the actionIcon will not be displayed either.

You pass an array of Item for the Tabbar but an array of ItemGroup to the Sidebar. This is because the Sidebar supports different groups, which can be collapsed.

You can also select views from your sidebar programmatically. In your view, add the following property:

@StateObject private var sidebarSelection = SidebarSelection.shared

You can then set sidebarSelection with the ID of the view you want to select, e.g. in a function:

private func selectSearchTab() {
    sidebarSelection.selectedViewID = HomeTab.search.rawValue
}

You can find the respective code in the example project.

Navigationbar

Using the built-in Navigationbar is optional, as it does not belong to the Sidebar or the Tabbar. To use it, navigate to the view you'd like to use it in. First, import IONavigation at the top.

Create a VStack with zero spacing and add the NavigationBar at the top:

var body: some View {
      VStack(spacing: 0) {
          Navigationbar(title: "Header")

          // Here will be your views
          ScrollView {
              Text("Hello, world!")
                  .padding()
          }
      }
      .frame(maxWidth: .infinity, maxHeight: .infinity, alignment: .center)
      .background(Color("primaryBackground"))
}

This will display a blank Navigationbar with a header. You can also add either a BackButton, which is displayed on the leading side of the header (for deeper navigation) or you can add one or multiple NavigationItems, which will be added to trailing side of the Navigationbar. You can choose between an icon and text to be shown.

To show NavigationItems, use the built-in ViewModifier .navigationItem:

var body: some View {
      VStack(spacing: 0) {
          Navigationbar(title: "Header")
              .navigationItem(image: Image(systemName: "heart.fill"), color: .purple, action: {})
              .navigationItem(image: Image(systemName: "bookmark.fill"), color: .purple, action: {})

          // Here will be your views
          ScrollView {
              Text("Hello, world!")
                  .padding()
          }
      }
      .frame(maxWidth: .infinity, maxHeight: .infinity, alignment: .center)
      .background(Color("primaryBackground"))
}

In the Example directory you can find demo code to show how to setup all components.

Recommend Projects