arn00s / cariocamenu

The fastest zero-tap iOS menu.

⚡️ Quicklook

The fastest zero-tap iOS menu

CariocaMenu is a simple, elegant, fast navigation menu for your iOS apps.

🏆 Features

• Accessible from a single swipe of the left/right screen edge
• Accessible with a tap on the indicator
• Customisable menu indicator
• Menu Item supports image & emoji/text
• Boomerang mode
• Supports rotation (Full AutoLayout)
• Supports iPhone X & the Notch !
• Complete Technical Documentation

📝 Requirements

• AutoLayout
• iOS 9.0+
• Swift 4.0

📢 Communication

• If you need help, use Stack Overflow. (Tag 'CariocaMenu')
• If you'd like to ask a general question, use Stack Overflow.
• If you found a bug, open an issue.
• If you have a feature request, open an issue.
• If you want to contribute, submit a pull request.
• If you use the control, contact me to mention your app on this page.

📲 Installation

CocoaPods

CariocaMenu is now available on CocoaPods. Simply add the following to your project Podfile, and you'll be good to go.

use_frameworks!

pod 'CariocaMenu', '~> 2.0.1'

Carthage

Carthage is a decentralised 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 CariocaMenu into your Xcode project using Carthage, specify it in your Cartfile:

github "arn00s/cariocamenu"

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

Manually

If you prefer, you can integrate CariocaMenu into your project manually.

Just Drag&Drop all the files under Sources/ into your project.

---

💻 Usage

Preparing your menu controller

To create and display your menu, you'll need to create a custom CariocaController (UITableViewController & CariocaDataSource)

This will define your menu settings & appearance. Check DemoMenuContentController.swift for code sample.

Creating your menu

For the complete code, check MainViewController.swift.

if let controller = self.storyboard?.instantiateViewController(withIdentifier: "DemoMenu")
    as? CariocaController {
      addChildViewController(controller)
      carioca = CariocaMenu(controller: controller,
                            hostView: self.view,
                            edges: [.right, .left],
                            delegate: self,
                            indicator: CariocaCustomIndicatorView()
                            )
      carioca.addInHostView()
}

Managing rotation

To be able to manage the rotation of the menu, you'll need to forward the rotation event to your menu instance.

override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator) {
  coordinator.animateAlongsideTransition(in: self.view, animation: nil, completion: { [weak self] _ in
    self?.carioca?.hostViewDidRotate()
  })
}

Creating your custom indicator

Here's the simplest custom indicator. Feel free to check the CariocaIndicatorConfiguration extension for more customisation possibilities.

class CariocaCustomIndicatorView: UIView, CariocaIndicatorConfiguration {
  ///This will use the basic shape, and change the color to black.
  var color: UIColor = UIColor.black
}

Boomerang

A boomerang always comes back to it's original place. By default, the boomerang is set to none. It means that the menu will stay where the user let it.

The other boomerang options are :

• horizontal : The indicator will return always on the original edge.
• vertical : The indicator will return always on the original Y position. It may switch from Edge.
• originalPosition : The indicator will always come back to it's original position

👨‍💻 TODO

• Add a check for the edges at the initialisation. (Only .left & .right are allowed)
• Add UI Tests
• Add a live tutorial to indicate users how to get the most of this menu

⚠️ Known issues

Check the (GitHub issues)

🤔 FAQ

😍 Why should I use CariocaMenu?

You're starting a new iOS app, and you want to innovate on the user experience.

🇧🇷 Why the name CariocaMenu?

I didn't want to use the same naming convention that EVERYONE uses. I could have named it ASSuperCoolMenu, but it sucks. A Carioca is someone who lives in Rio de Janeiro 🇧🇷. I lived there for two months, and this idea was born while I was there.

🤙🏼 Contact

• twitter

❤️ Contributions

This is an open source project, feel free to contribute!

• Open an issue.
• Propose your own fixes, suggestions and open a pull request with the changes.

See all contributors

Project generated with SwiftPlate

📝 License

CariocaMenu is released under the MIT license. See LICENSE for details.

cariocamenu's Issues

Not really an issue but feature request

Cocoapods support and will be good to see social sharing in this menu.

Demo project doesn't work on iOS 13

I tried to run the Demo project, but it does not respond to pan gesture in the menu, could you check this?
just try to run it :)
Very thanks, I may use this library on the app I'm developing, and once then, I'll give you the link ❤️

how change color of the button

how change color of the button?

Question: Has this library been ported to android or is there a similar looking library for android?

Firstly, thank you for an awesome library! Great work!
It would be great to have a similar library for android.

Has this library been ported to android or is there a similar looking library for android that you're aware of?

Rotation Bug

The library doesn't handle well when rotating the screen.

Steps to reproduce

• In portrait mode (Unlock rotation)
• Open the menu
• Scroll to About
• Open the menu again
• Rotate to landscape

Expected result

• The Menu Centered in landscape mode

Actual Results

• The Menu is half visible. (If you play it a couple of time, the menu button will disappear)

Many items in menu blows the app.

[x] There is no issue opened before about this.
[x] Issue is reproduceable in demo project.

What did I do?

• Downloaded the demo project.
• Wanted to check how it works with many menu items, so I copy pasted default menus 3 times. (4 times menu items at the end.) Change nothing else.
• Ran on iPhone 6s with iOS 11.2.1

What happened?

• CaroicaGestureManager.swift file, panned(yLocation:, edge:, state:, fromGesture:)method, line 76
• let yRange: ClosedRange<CGFloat> = 20.0...frameHeight - container.menuHeight
• Fatal error occured: Thread 1: Fatal error: Can't form Range with upperBound < lowerBound.
• Reason: With 4x menu items, container.menuHeight became greater than frameHeight I suppose.

Swift3 support

icon is too big

Hey! I am trying to apply icon instead of emoji but the problem is that the icon is way too big. This is how I add icon:

var menuItems: [CariocaMenuItem] = [
        CariocaMenuItem("Test1", .icon(UIImage(named: "test1Icon")!)),
        CariocaMenuItem("Test2", .icon(UIImage(named: "test2Icon")!))
    ]

This is the output:

My icon is 15x15

Dismiss Viewcontroller

Hey, I am trying to dismiss presented ViewController but instead on dismissing, it goes to Carioca's default viewcontrollerViewController. My initial ViewController is UINavigationController but I do not think that is an issue. Is it a bug or I am stupid?

And this is how I present:

let emptyViewController = EmptyViewViewController.fromStoryboard()
present(emptyViewController, animated: true, completion: nil)

Menu uses too much memory

What did I do?

• Downloaded the demo project and ran it on iPhone 6s with iOS 11.2.1 without any modification.
• Travelled between content pages many times. (Not to be a prick, just to present the menu to my collegues.)

What happened?

• Memory usage gone beyond 150 MB.

Any ideas?

I traced the memory usage while travelling between pages. I saw 2 things.

• WebView data is not released when you go to another page.
• MapView data is released but not completely when you go to another page.

I don't know if these are issues about the menu, or something else, but false alarm better than no alarm :]

Unknown error in the app after I did like example demo ?

*** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[test.MainViewController cariocaMenuDidSelect:indexPath:]: unrecognized selector sent to instance 0x7ffa48e00be0'

this happen when ever I click on cell for the menu.

Love the control. Any chance you could update it to work without requiring Storyboard changes? Just have it be programmatically added to the view with the label and image names?

Carthage support

Would you be willing to add carthage support for this?

CariocaMenuIndicatorView shape color

I can help modify the code to allow changing shape color. currently it's hard coded