Git Product home page Git Product logo

cfnotify's Introduction

CFNotify

Travis branch GitHub issues Swift GitHub forks GitHub stars GitHub license Carthage compatible

CFNotify is written in Swift. Using UIKit Dynamics as animator. It can make ANY UIView object draggable and throwable. This library mainly use for in-app notification and alerts. Let's notice and alert your users in more playable and fun way !

Demo1 Demo2 Demo3

Features

  • Work with ANY UIView object !
  • Using UIKit Dynamics. Light and Smooth !
  • Highly Customizable
  • Included three ready to use views: CyberView, ClassicView, ToastView
  • Simple to implement

Requirements

  • Swift 4.0+
  • Xcode 9
  • iOS 9.0+

Installation

  • Carthage (Recommended)

    Add the following lines into Cartfile

    #CFNotify
    github "hallelujahbaby/CFNotify"

    Run carthage update and then add CFNotify.framework and CFResources.bundle into your project

  • Add the following lines into Podfile

    pod "CFNotify"

Getting Started

There is an example project inside the source code. You are suggested to have a look first and get familiar with this framework.

The Basics

This is the basic function with all default settings, design your own UIView or use CFNotifyView to create one easily.

CFNotify.present(view: UIView)

If you need more custom settings, create your own Config and use the following function.

CFNotify.present(config: Config, view: UIView)

if you want custom tap action, use the following function. (If you use tapHandler, it will override the default tap to hide action)

CFNotify.present(config: Config, view: UIView, tapHandler: (()->Void)?)

CFNotify will put all the views to be shown in queue (First In First Out). You can hide the view programmatically using the following functions.

CFNotify.hide() // hide the current view

CFNotify.hideAll() // hide all the views in queue (Clear the queue)

CFNotifyView

You can create an alert view quickly and easily by using CFNotifyView class.

CFNotifyView included 3 views currently: Cyber, Classic, Toast.

Each style has 4 themes: Info, Success, Fail, Warning

Each theme has 2 styles: Light and Dark

  • Cyber

    CyberView
    let cyberView = CFNotifyView.cyberWith(title: "Title",
                                            body: "Body",
                                           theme: .Info(.Light))
    
    //More customizations
    let customCyberView = CFNotifyView.cyberWith(titleFont: UIFont,
                                                titleColor: UIColor,
                                                  bodyFont: UIFont,
                                                 bodyColor: UIColor,
                                           backgroundColor: UIColor,
                                                 blurStyle: UIBlurEffectStyle)
  • Classic

    ClassicView
    let classicView = CFNotifyView.classicWith(title: "Title",
                                                body: "Body",
                                               theme: .Success(.Light))
    
    //More customizations
    let customClassicView = CFNotifyView.classicWith(titleFont: UIFont,
                                                    titleColor: UIColor,
                                                      bodyFont: UIFont,
                                                     bodyColor: UIColor,
                                               backgroundColor: UIColor)
  • Toast

    ToastView
    let toastView = CFNotifyView.toastWith(text: "Text",
                                          theme: .Fail(.Dark))
    
    //More customizations
    let customToastView = CFNotifyView.toastWith(text: String,
                                             textFont: UIFont,
                                            textColor: UIColor,
                                      backgroundColor: UIColor)                                    

Config

You can config CFNotify using Config class. Config class included lots of properties, the following three are the most common:

  • initPosition : where the view is born
  • appearPosition : where the view appear position
  • hideTime : the view will automatically hide after hideTime (default is 3 sec)

Example:

var classicViewConfig = CFNotify.Config()
classicViewConfig.initPosition = .top(.random) //the view is born at the top randomly out of the boundary of screen
classicViewConfig.appearPosition = .top //the view will appear at the top of screen
classicViewConfig.hideTime = .never //the view will never automatically hide

Delegate

CFNotify provides Delegate methods for some of common events. You need to conform to the CFNotifyDelegate.

func cfNotifyDidAppear() {}

func cfNotifyStartDragging(atPoint: CGPoint) {}

func cfNotifyIsDragging(atPoint: CGPoint) {}

func cfNotifyEndDragging(atPoint: CGPoint) {}

func cfNotifyDidDisappear() {}

func cfNotifyIsTapped() {}

To-Do List

  • Add SPM support
  • Improve the example app
  • Add alert view with buttons
  • Full documentation

Bugs and issues

If you find any bugs or encounter some issues regard to this framework, please feel free to open a new issue in Issues page.

Contribute

You are welcome to contribute into this project, feel free to Pull Request.

License

CFNotify is released under an MIT License. See LICENSE for details.

cfnotify's People

Contributors

jt501 avatar

Stargazers

MohsinAli avatar

Watchers

MohsinAli avatar  avatar

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.