Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edekhayser/FrostedSidebar
Hamburger Menu using Swift and iOS 8 API's
https://github.com/edekhayser/FrostedSidebar
Last synced: 3 months ago
JSON representation
Hamburger Menu using Swift and iOS 8 API's
- Host: GitHub
- URL: https://github.com/edekhayser/FrostedSidebar
- Owner: edekhayser
- License: mit
- Created: 2014-07-11T14:21:52.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-04-18T03:40:23.000Z (over 7 years ago)
- Last Synced: 2024-08-08T09:19:36.428Z (3 months ago)
- Language: Swift
- Size: 12.1 MB
- Stars: 430
- Watchers: 21
- Forks: 59
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - FrostedSidebar - Hamburger Menu using Swift and iOS 8 API's (UI / Menu)
- awesome-ios-star - FrostedSidebar - Hamburger Menu using Swift and iOS 8 API's (UI / Menu)
- awesome-swift-cn - FrostedSidebar - Hamburger Menu using Swift and iOS 8 API's. (Libs / UI)
- Awesome-Mobile-UI - FrostedSidebar
README
FrostedSidebar
==============
Hamburger Menu using Swift and iOS 8 API's
Heavily influenced by @_ryannystrom's [RNFrostedSidebar](https://github.com/rnystrom/RNFrostedSidebar)
This implementation uses iOS 8's new UIVisualEffectView to apply the blur to the sidebar. Among other changes, this sidebar has a view that dims the background to shift the focus to the presented content.
The buttons have the same ring effect on click. The buttons are more customizable as I will go into later.
##Usage##
In the example project, the sidebar is added quite easily.
Create a property in your UIViewController subclass.
```swift
var frostedSidebar: FrostedSidebar = FrostedSidebar(images: imageArray, colors: colorArray, selectionStyle: chosenSelectionStyle)
```
where `images` contains the icons for the buttons, `colors` contains the border colors for the icons, and `selectionStyle` is the sidebar items' selection behavior (either `.None`, `.Single`, or `.All`).
The `colors` parameter is optional, and can either be nil or be the same length as `images`.
The buttons can be set to use a closure when tapped using
```swift
frostedSidebar.actionForIndex[idx] = { /* actions */ }
```
To show the sidebar, use the following code in your view controller:
```swift
frostedSidebar.showInViewController( self, animated: true )
```
It can be dismissed in a similar way:
```swift
frostedSidebar.dismissAnimated(true, completion: nil)
```
The class that conforms to the FrostedSidebarDelegate must implement the following methods:
```swift
func sidebar(sidebar: FrostedSidebar, willShowOnScreenAnimated animated: Bool)
func sidebar(sidebar: FrostedSidebar, didShowOnScreenAnimated animated: Bool)
func sidebar(sidebar: FrostedSidebar, willDismissFromScreenAnimated animated: Bool)
func sidebar(sidebar: FrostedSidebar, didDismissFromScreenAnimated animated: Bool)
func sidebar(sidebar: FrostedSidebar, didTapItemAtIndex index: Int)
func sidebar(sidebar: FrostedSidebar, didEnable itemEnabled: Bool, itemAtIndex index: Int)
```
## Installation
#### CocoaPods
You can use [CocoaPods](http://cocoapods.org/) to install `FrostedSidebar` by adding it to your `Podfile`:
```ruby
platform :ios, '8.0'
use_frameworks!
pod 'FrostedSidebar'
```
To get the full benefits import `FrostedSidebar` wherever you import UIKit
``` swift
import UIKit
import FrostedSidebar
```
#### Manually
1. Download and drop ```FrostedSidebar.swift``` in your project.
2. Congratulations!
##Conclusion##
This would not be possible without the impressive work by Ryan Nystrom, and the great design by [Jakub Antalík on Dribbble](https://dribbble.com/shots/1194205-Sidebar-calendar-animation).
Hopefully someone finds this useful!