Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README #7

Merged
merged 11 commits into from
Nov 17, 2015
Merged

README #7

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7845e1b
Adds some description
RamonGilabert Nov 17, 2015
be0191a
Adds some more information
RamonGilabert Nov 17, 2015
5c1f9bc
Adds more information
RamonGilabert Nov 17, 2015
b711373
Adds leaves
RamonGilabert Nov 17, 2015
572d717
Adds a comma
RamonGilabert Nov 17, 2015
6941af3
Changes the stuffs
RamonGilabert Nov 17, 2015
cb30f10
Adds more text
RamonGilabert Nov 17, 2015
e3d3333
Adds more
RamonGilabert Nov 17, 2015
bab2cf5
Duration
RamonGilabert Nov 17, 2015
2c1ea7b
Correction
RamonGilabert Nov 17, 2015
bd16d4a
Some changes
RamonGilabert Nov 17, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified ...isperDemo.xcworkspace/xcuserdata/RamonGilabert.xcuserdatad/UserInterfaceState.xcuserstate
View file
Open in desktop
Binary file not shown.
44 changes: 43 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,44 @@
[![License](https://img.shields.io/cocoapods/l/Whisper.svg?style=flat)](http://cocoadocs.org/docsets/Whisper)
[![Platform](https://img.shields.io/cocoapods/p/Whisper.svg?style=flat)](http://cocoadocs.org/docsets/Whisper)

## Description

Break the silence of your UI whispering or shouting at it. **Whisper** is a component that will make the task of display messages and in-app notifications simple. It has two different views inside.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Break the silence of your UI whispering or shouting at it.
Shouldn't it be a comma in there somewhere? 😎

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh really? I don't see it!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well sorta.


#### Whispers

![Whisper](https://github.com/hyperoslo/Whisper/blob/feature/README/Resources/permanent-whisper.png)

Display a short message at the bottom of the navigation bar, this can be anything, from a "Great Job!" to an error message. It can have images or even a loader.

#### Shouts

![In-App](https://github.com/hyperoslo/Whisper/blob/feature/README/Resources/in-app-notification.png)

Fully customizable, from colors to fonts. This view will have an optional action that will be called if the user taps the view.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This view will have an optional action that will be called if the user taps the view.

I think it's a bit confusing to refer to it as a view in this context, maybe something like.

Shouts have an optional action that will be called if the user taps on the shout.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouts have an optional action that will be called if the user taps on it.


The factory will handle the inset of the scroll view and adjust it to fit the Whisper, if you move from one view controller to another, it will animate the next controller's offset too.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The factory will handle the inset of the scroll view and adjust it to fit the Whisper, if you move from one view controller to another, it will animate the next controller's offset too.

There is no need to think about scroll view insets anymore, this will be handled automagically by 
Whisper. As and added bonus, when transitioning from one view controller to another, 
the next controllers offset will be adjusted like you would except. It just works!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OUTDATED, outrageous!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now it's fine!


## Usage

The usage of the component is so simple, you just create a message in the case of Whisper, or an announcement in the case of a Shout, it's done like this:

##### For a Whisper:

```swift
let message = Message(title: "Enter your message here.", color: UIColor.redColor())
Whisper(message, to: navigationController, action: .Present)
```

##### For a Shout:

```swift
<API>
let announcement = Announcement(title: "Your title", subtitle: "Your subtitle", image: UIImage(named: "avatar"))
Shout(announcement, to: self)
```

Shouts let you add more properties like duration or action. With this, you'll get notified when the user **taps** the view.

## Installation

**Whisper** is available through [CocoaPods](http://cocoapods.org). To install
Expand All @@ -19,6 +51,16 @@ it, simply add the following line to your Podfile:
pod 'Whisper'
```

## Roadmap

In the future the idea is to keep improving and add some features:

- Improve the offset detection and animation.
- Add more UI related components into Whisper.
- More customization points and more sizes for each whisper.
- Actions to Whispers and Shouts.
- We are open to new and awesome ideas, contribute if you like! :)

## Author

Hyper Interaktiv AS, ios@hyper.no
Expand Down
Binary file added Resources/in-app-notification.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Resources/permanent-whisper.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.