https://github.com/GitHawkApp/Squawk

Quick & interactive iOS alerts in Swift.
https://github.com/GitHawkApp/Squawk

alert githawk swift toast uikit

Last synced: about 2 months ago
JSON representation

Quick & interactive iOS alerts in Swift.

• Host: GitHub
• URL: https://github.com/GitHawkApp/Squawk
• Owner: GitHawkApp
• License: mit
• Created: 2018-01-03T03:10:08.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-04T10:48:10.000Z (over 5 years ago)
• Last Synced: 2024-04-24T18:10:13.891Z (5 months ago)
• Topics: alert, githawk, swift, toast, uikit
• Language: Swift
• Homepage: http://githawk.com
• Size: 184 KB
• Stars: 257
• Watchers: 5
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Squawk

Show important alerts from the bottom of the screen with full customization control.

![Example](readme.png)

## Installation

Just add `Squawk` to your Podfile and pod install. Done!

```

pod 'Squawk'

```

## Usage

After installing `Squawk`, you can start displaying alerts immediately:

```swift

import Squawk

func onError() {

  Squawk.shared.show(config: Squawk.Configuration(

    text: "Something went wrong!"

  ))

}

```

Use the `view` param if you want to show the alert within a specific view.

```swift

func viewDidAppear() {

  super.viewDidAppear()

  Squawk.shared.show(

    in: view,

    config: Squawk.Configuration(

      text: "Peek-a-boo"

    )

  )

}

```

### Configuration

`Squawk.Configuration` comes with _loads_ of options:

- `text` - The text in the alert

- `textColor` - The color of the text 🙄

- `backgroundColor` - Background color of the view (note: will be blurred)

- `insets` - Inset the text and button within the alert view

- `maxWidth` - The max width of the alert view

- `hintMargin` - Margin between the "hint" (top pill) and text

- `hintSize` - The size of the hint pill

- `cornerRadius` - Corner radius of the alert view

- `bottomPadding` - Extra padding to add to subtract from the final `y` of the alert view

- `borderColor` - Border color of the alert view

- `dismissDuration` - How long, in seconds, to wait before automatically dismissing

- `buttonVisible` - Set to `true` to show the "info" button

- `buttonLeftMargin` - The margin between the button and text

- `buttonTapHandler` - A closure to execute when the "info" button is tapped

## Acknowledgements

- Created with ❤️ by [Ryan Nystrom](https://twitter.com/_ryannystrom)