WXNavigationBar - GitLite

KO | EN

gitlite — search

#react #typescript #go #machine-learning #rust #linux #macos #java #windows #vue #awesome-list #security #ios #open-source

WXNavigationBar

(★ 137)

Handle UINavigationBar like WeChat. Simple and easy to use.

File Explorer

Download Latest Version (.zip)

- Preview.gif
- WXNavigationBar_Logo@2x.png
- - Manifest.lock
- - AppDelegate.swift
  - RootViewController.swift
- - project.pbxproj
- - contents.xcworkspacedata
- Podfile
- Podfile.lock
- Info.plist
- UIApplication+WXNavigationBar.swift
- UINavigationBar+WXNavigationBar.swift
- UINavigationController+WXNavigationBar.swift
- UIViewController+WXNavigationBar.swift
- Utility.swift
- WXNavigationBar.h
- WXNavigationBar.swift
- - WXNavigationBarTests.swift
  - XCTestManifests.swift
- LinuxMain.swift
- - contents.xcworkspacedata
- project.pbxproj
.gitignore
CHANGELOG.md
LICENSE
Package.swift
README.md
README_CN.md
WXNavigationBar.podspec

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![](https://raw.githubusercontent.com/alexiscn/WXNavigationBar/master/Assets/WXNavigationBar_Logo@2x.png)

[![Platform](https://img.shields.io/cocoapods/p/WXNavigationBar.svg?style=flat)](https://raw.githubusercontent.com/alexiscn/WXNavigationBar/master/)
[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/WXNavigationBar.svg)](https://img.shields.io/cocoapods/v/WXNavigationBar.svg)
[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![License](https://img.shields.io/cocoapods/l/WXNavigationBar.svg?style=flat)](https://raw.githubusercontent.com/alexiscn/WXNavigationBar/master/)

# WXNavigationBar

WeChat NavigationBar

![](https://raw.githubusercontent.com/alexiscn/WXNavigationBar/master/Assets/Preview.gif)

* [Features](#features)
* [Requirements](#requirements)
* [Installation](#installation)
    * [CocoaPods](#cocoapods)
    * [Carthage](#carthage)
    * [Swift Package Manager](#swift-package-manager)
* [Design Principle](#design-principle)
* [Getting Started](#getting-started)
   * [UINavigationController based configuration](#uinavigationcontroller-based-configuration)
   * [ViewController based configuration](#viewcontroller-based-configuration)
      * [Background Color](#background-color)
      * [Background Image](#background-image)
      * [System blur navigation bar](#system-blur-navigation-bar)
      * [NavigationBar bar tint color](#navigationbar-bar-tint-color)
      * [NavigationBar tint color](#navigationbar-tint-color)
      * [Shadow Image](#shadow-image)
      * [Shadow Image Tint Color](#shadow-image-tint-color)
      * [Back Button Image](#back-button-image)
      * [Back Button Custom View](#back-button-custom-view)
      * [Disable Interactive Pop Gesture](#disable-interactive-pop-gesture)
      * [fullscreen interactive pop gesture](#fullscreen-interactive-pop-gesture)
      * [interactivePopMaxAllowedDistanceToLeftEdge](#interactivepopmaxalloweddistancetoleftedge)
* [Advance usage](#advance-usage)
   * [Transparent Navigation Bar](#transparent-navigation-bar)
     * [alpha](#alpha)
     * [hidden](#hidden)
     * [background color](#background-color-1)
   * [Dynamic update navigation bar](#dynamic-update-navigation-bar)
   * [wx_navigationBar](#wx_navigationbar)
   * [Handle back button event](#handle-back-button-event)
* [Notes](#notes)
   * [Child View Controller](#child_view_controller)
* [License](#license)
* [中文文档](#中文文档)

## Features

- [x] Support transparent navigationbar
- [x] Support navigationbar background image
- [x] Support navigationbar large title mode
- [x] Support iOS 13 dark mode
- [x] Support fullscreen pop gesture
- [x] As Simple as using UINavigationBar

## Requirements

- iOS 9.0+
- Xcode 11.0+
- Swift 5.0+

## Installation

### CocoaPods

`WXNavigationBar` is available through CocoaPods. To install it, simply add the following line to your Podfile:

```bash
use_frameworks!

pod 'WXNavigationBar', '~> 2.3.6'
```

### Carthage

[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate WXNavigationBar into your Xcode project using Carthage, specify it in your Cartfile:

```bash
github alexiscn/WXNavigationBar
```

### Swift Package Manager

[The Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the swift compiler. It is in early development, but WXNavigationBar does support its use on supported platforms.

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

```
dependencies: [
    .package(url: "https://github.com/alexiscn/WXNavigationBar.git", .upToNextMajor(from: "2.3.6"))
]
```

## Design Principle

`WXNavigation` make the actual UINavigationBar transparent and add a view as a fake navigation bar to the view controller.

The actual navigation bar still handles the touch events, the fake navigation bar do the display staffs, eg: backgroundColor, backgroundImage.

So you use navigation bar as usual. when you want to handle the display things, you use `WXNavigationBar`

## Getting Started

In your `AppDelegate.swift`

```swift
import WXNavigationBar

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // ...    
    WXNavigationBar.setup()
}

```

You can customize `WXNavigationBar` if needed. There are two ways to configure WXNavigationBar: via `WXNavigationBar.NavBar` or via `UIViewController` properties.

### UINavigationController based configuration

Using `WXNavigationBar.NavBar` to configure `WXNavigationBar` will effect all viewcontrollers.

In your `AppDelegate.swift`

```swift

import WXNavigationBar

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

// ...
    
    // Customize WXNavigationBar if needed (Optional)
    // WXNavigationBar.NavBar.backImage = UIImage(named: "xxx")
}

```

You can configure following options:

```swift
/// Back Image for Navigation Bar
public static var backImage: UIImage? = Utility.backImage

/// Use custom view to create back button.
/// Note: You do not need to add tap event to custom view. It's handled in WXNavigationBar.
public static var backButtonCustomView: UIView? = nil
        
/// Background Image for NavigationBar
public static var backgroundImage: UIImage? = nil

/// Background color for NavigationBar
public static var backgroundColor: UIColor = UIColor(white: 237.0/255, alpha: 1.0)

/// Tint Color for NavigationBar
public static var tintColor = UIColor(white: 24.0/255, alpha: 1.0)

/// Shadow Image for NavigationBar
public static var shadowImage: UIImage? = UIImage()

/// Enable fullscreen pop gesture
public static var fullscreenPopGestureEnabled = false
```

### ViewController based configuration

You can also configure specific view controller by override properties that `WXNavigationBar` supported.

#### Background Color

You can configure background color of navigation bar.

```swift
/// Background color of fake NavigationBar
/// Default color is UIColor(white: 237.0/255, alpha: 1.0)
override var wx_navigationBarBackgroundColor: UIColor? {
    return .white
}
```

#### Background Image

You can confgiure navigation bar background using image.

```swift
override var wx_navigationBarBackgroundImage: UIImage? {
    return UIImage(named: "icons_navigation_bar")
}
```

#### System blur navigation bar

If you want to use system alike blured navigation bar:

```swift
override var wx_useSystemBlurNavBar: Bool {
    return true
}
```

#### NavigationBar bar tint color

By setting `wx_barBarTintColor`, you actually setting `barTintColor` of `navigationController?.navigationBar`

```swift
override var wx_barBarTintColor: UIColor? {
    return .red
}
```

#### NavigationBar tint color

By setting `wx_baTintColor`, you actually setting `tintColor` of `navigationController?.navigationBar`

```swift
override var wx_barTintColor: UIColor? {
    return .black
}
```

#### Shadow Image

You can specify navigation bar shadow image for specific view controller(eg: solid color line or gradient color line):

```swift
override var wx_shadowImage: UIImage? {
    return UIImage(named: "icons_navigation_bar_shadow_line")
}
```

#### Shadow Image Tint Color

You can create shadow image from color, this property will overwrite `wx_shadowImage`

```swift
override var wx_shadowImageTintColor: UIColor? {
    return .red
}
```

#### Back Button Image

You can specify navigation bar back image for specific view controller:

```swift
override var wx_backImage: UIImage? {
    return UIImage(named: "icons_view_controller_back_image")
}
```

#### Back Button Custom View

You can specify back button with custom view:

```swift
override var wx_backButtonCustomView: UIView? {
    let label = UILabel()
    label.text = "back"
    label.textAlignment = .center
    return label
}
```

#### Disable Interactive Pop Gesture

```swift
override var wx_disableInteractivePopGesture: Bool {
    return true
}
```

#### fullscreen interactive pop gesture

```swift
override var wx_fullScreenInteractivePopEnabled: Bool {
    return false
}
```

#### interactivePopMaxAllowedDistanceToLeftEdge

```swift
override wx_interactivePopMaxAllowedDistanceToLeftEdge: CGFloat {
    return view.bounds.width * 0.5
}
```

## Advance usage

Here is some advance usage suggestions for `WXNavigationBar`.

### Transparent Navigation Bar

There are several ways to make navigation bar transparent.

##### alpha

```swift
wx_navigationBar.alpha = 0
```

##### hidden

```swift
wx_navigationBar.isHidden = true
```

##### background color

```swift
override var wx_navigationBarBackgroundColor: UIColor? {
    return .clear
}
```

alpha and hidden make wx_navigationBar invisible, while backgroundColor just change the color of 
wx_navigationBar

### Dynamic update navigation bar

You can dynamically update navigation bar, such as dynamically update while scrolling.

See `MomentViewController` for details.

### wx_navigationBar

`wx_navigationBar` is a subclass of UIView, so you can do anything with `wx_navigationBar` that can be done with UIView.

### Handle back button event

If you want to do something when user tap back button, you can override `wx_backButtonClicked` in your view controller. For example, you can present alert when user tap back button.

```swift
override func wx_backButtonClicked() {
    let alert = UIAlertController(title: "Are you sure to exit", message: nil, preferredStyle: .alert)
    alert.addAction(UIAlertAction(title: "OK", style: .default, handler: { [weak self] _ in
        self?.navigationController?.popViewController(animated: true)
    }))
    alert.addAction(UIAlertAction(title: "Cancel", style: .cancel, handler: { _ in
        
    }))
    present(alert, animated: true, completion: nil)
}
```

## Notes

### Child View Controller

`wx_navigationBar` can be overlaid when you dynamically add child view controller. So it's your responsibility to bring `wx_navigationBar` to front.

```swift

// addChild(controller) or addSubview

view.bringSubviewToFront(wx_navigationBar)
```

## License

WXNavigationBar is MIT-licensed. [LICENSE](LICENSE)

## 中文文档

你可以参考[中文文档](README_CN.md)