Code Monkey home page Code Monkey logo

perimetermenu's Introduction

PerimeterMenu

CI Status Version License Platform

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Example in a gif

Example gif here

Requirements

iOS 10+

Installation

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

pod 'PerimeterMenu'

Configuring

This section describes how to configure your PerimeterMenu for your needs.

Delegate / Datasource

Implement PerimeterMenuDelegate for datasource.

Note: Datasource is mandatory.

func perimeterMenu(_ menu: PerimeterMenu,
  configurationFor itemPosition: Int,
  withButton button: UIButton)

Implement PerimeterMenuDelegate for delegate methods.

Note: All delegate methods are optional and self explanatory.

func perimeterMenu(_ menu: PerimeterMenu,
  didSelectItem button: UIButton,
  at position: Int)

func perimeterMenu(_ menu: PerimeterMenu,
  didStartHoveringOver button: UIButton,
  at position: Int)

func perimeterMenu(_ menu: PerimeterMenu,
  didEndHoveringOver button: UIButton,
  at position: Int)

func perimeterMenuWillCollapse(_ menu: PerimeterMenu)

func perimeterMenuWillExpand(_ menu: PerimeterMenu)

func perimeterMenuDidCollapse(_ menu: PerimeterMenu)

func perimeterMenuDidExpand(_ menu: PerimeterMenu)

Note: Please make sure you specify/connect your delegate and datasource either thru code or thru the storyboard.

Callbacks

There are two callbacks available on the PerimeterMenu instance. Both are optional.

  • onButtonTap is called when the PerimeterMenu main button is tapped.
  • onButtonLongPress is called when the PerimeterMenu main button is long pressed.

Both callbacks are expected to return a boolean. Return true if the default action (expanding the menu) should still fire. Return false if you want to completely override the default action with your own provided as the body of the closure/block.

IMPORTANT: Never return true if you are planning to performSegue to another controller. If you do so the menu will expand and overlap the newly presented controller.

Authors

  • Alex Kremer, godexsoft at gmail dot com
  • Valera Chevtaev, myltik at gmail dot com

License

PerimeterMenu is available under the MIT license. See the LICENSE file for more info.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.