README

SwiftEntryKit 







!

 🤗 Donations can be made here.

 Table of Contents

 Overview
   Features
 Example Project
   Example Project Installation
   Presets
   Playground
 Requirements
 Installation
 Usage
   Quick Usage
   Entry Attributes
     Entry Name
     Window Level
     Display Position
     Precedence
       Override
       Enqueue
         Heuristics
       Display Priority
     Display Duration
     Position Constraints
     User Interaction
     Scroll Behavior
     Haptic Feedback
     Lifecycle Events
     Display Mode
     Background Style
     Shadow
     Round Corners
     Border
     Animations
     Pop Behavior
     Status Bar
   Presets Usage Example
   Custom View Usage Example
   Displaying a View Controller
   Alternative Rollback Window
   Dismissing an Entry
   Swiping and Rubber Banding
   Dealing With Safe Area
   Dealing With Orientation Change
   Swift and Objective-C Interoperability
 Author
 Donations
 License

 Overview

SwiftEntryKit is a simple yet versatile content presenter written in Swift.

 Features

Banners or pop-ups are called Entries.

- Entries are displayed inside a separate UIWindow (of type EKWindow), so users are able to navigate the app freely while entries are being displayed in a non intrusive manner.
- The kit offers beautiful presets that can be themed with your own colors and fonts.
- Customization: Entries are highly customizable
  - [x] Can be positioned either at the top, center, or the bottom of the screen.
  - [x] Can be displayed within or outside the screen safe area.
  - [x] Can be stylized: have a border, drop-shadow and round corners.
  - [x] Their content and the surrounding background can be blurred, dimmed, colored or have a gradient style.
  - [x] Transition animations are customizable - entrance, exit and pop (by another entry).
  - [x] The user interaction with the entry or the screen can be intercepted.
  - [x] Entries can be enqueued or override previous entries using the precedence attribute.
  - [x] Each entry has a display priority attribute. That means that it can be dismissed only by other entry with an equal or higher priority. 
  - [x] Presets support accessibility.
  - [x] Entries have an optional rubber banding effect while panning.
  - [x] Entries can be optionally dismissed using a simple swipe gesture.
  - [x] Entries can be optionally injected with lifecycle events: will and did appear/disappear.
  - [x] The status bar style is settable for the display duration of the entry.
  - [x] Supports navigation controllers & custom views as well!

 Example Project

The example project contains various presets and examples you can use and modify as your like.

 Example Project Installation 

You can either use the terminal or git client such as Source Tree.

 Terminal Users

bash
$ git clone https://github.com/huri000/SwiftEntryKit.git


 Git Client (Source Tree)
Clone https://github.com/huri000/SwiftEntryKit.git 

 Presets

| Toasts | Notes | Floats | Popups |
| --- |