Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/KrauseFx/TSMessages

💌 Easy to use and customizable messages/notifications for iOS à la Tweetbot
https://github.com/KrauseFx/TSMessages

cocoapods ios library notifications objective-c tsmessages

Last synced: 2 months ago
JSON representation

💌 Easy to use and customizable messages/notifications for iOS à la Tweetbot

Lists

README 

        
**Notice: TSMessages is no longer being maintained/updated. We recommend everyone migrate to [RMessage](https://github.com/donileo/RMessage).**



**This repository will be kept as is for those who want to continue using TSMessages or are in the process of migrating. If an issue you submitted to TSMessages still applies to RMessage feel free to create a new issue in RMessage's repository.**



**If your project is Swift based, you might want to check out [SwiftMessages](https://github.com/SwiftKickMobile/SwiftMessages), which offers the same features, but is written completely in Swift.**



TSMessages

==========



This library provides an easy to use class to show little notification views on the top of the screen. (à la Tweetbot).



[![Twitter: @KauseFx](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/KrauseFx)

[![Version](https://img.shields.io/cocoapods/v/TSMessages.svg?style=flat)](http://cocoadocs.org/docsets/TSMessages)

[![License](https://img.shields.io/cocoapods/l/TSMessages.svg?style=flat)](http://cocoadocs.org/docsets/TSMessages)

[![Platform](https://img.shields.io/cocoapods/p/TSMessages.svg?style=flat)](http://cocoadocs.org/docsets/TSMessages)



The notification moves from the top of the screen underneath the navigation bar and stays there for a few seconds, depending on the length of the displayed text. To dismiss a notification before the time runs out, the user can swipe it to the top or just tap it.



There are 4 different types already set up for you: Success, Error, Warning, Message (take a look at the screenshots)



It is very easy to add new notification types with a different design. Add the new type to the notificationType enum, add the needed design properties to the configuration file and set the name of the theme (used in the config file and images) in TSMessagesView.m inside the switch case.



**Take a look at the Example project to see how to use this library.** You have to open the workspace, not the project file, since the Example project uses cocoapods.



Get in contact with the developer on Twitter: [KrauseFx](https://twitter.com/KrauseFx) (Felix Krause)



# Screenshots



    

    

    



# Installation



## From CocoaPods

TSMessages is available through [CocoaPods](https://cocoapods.org/). To install

it, simply add the following line to your Podfile:



    pod "TSMessages"

    

## Manually

Copy the source files TSMessageView and TSMessage into your project. Also copy the TSMessagesDesignDefault.json.



# Usage



To show notifications use the following code:



```objective-c

    [TSMessage showNotificationWithTitle:@"Your Title"

                                subtitle:@"A description"

                                    type:TSMessageNotificationTypeError];



    // Add a button inside the message

    [TSMessage showNotificationInViewController:self

                                          title:@"Update available"

                                       subtitle:@"Please update the app"

                                          image:nil

                                           type:TSMessageNotificationTypeMessage

                                       duration:TSMessageNotificationDurationAutomatic

                                       callback:nil

                                    buttonTitle:@"Update"

                                 buttonCallback:^{

                                     NSLog(@"User tapped the button");

                                 }

                                     atPosition:TSMessageNotificationPositionTop

                           canBeDismissedByUser:YES];



    // Use a custom design file

    [TSMessage addCustomDesignFromFileWithName:@"AlternativeDesign.json"];

```



You can define a default view controller in which the notifications should be displayed:

```objective-c

   [TSMessage setDefaultViewController:myNavController];

```



You can define a default view controller in which the notifications should be displayed:

```objective-c

   [TSMessage setDelegate:self];

   

   ...

   

   - (CGFloat)messageLocationOfMessageView:(TSMessageView *)messageView

   {

    return messageView.viewController...; // any calculation here

   }

```



You can customize a message view, right before it's displayed, like setting an alpha value, or adding a custom subview

```objective-c

   [TSMessage setDelegate:self];

   

   ...

   

   - (void)customizeMessageView:(TSMessageView *)messageView

   {

      messageView.alpha = 0.4;

      [messageView addSubview:...];

   }

```



You can customize message view elements using UIAppearance

```objective-c

#import 

@implementation TSAppDelegate

....



- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

{

//If you want you can overidde some properties using UIAppearance

[[TSMessageView appearance] setTitleFont:[UIFont boldSystemFontOfSize:6]];

[[TSMessageView appearance] setTitleTextColor:[UIColor redColor]];

[[TSMessageView appearance] setContentFont:[UIFont boldSystemFontOfSize:10]];

[[TSMessageView appearance]setContentTextColor:[UIColor greenColor]];

[[TSMessageView appearance]setErrorIcon:[UIImage imageNamed:@"NotificationButtonBackground"]];

[[TSMessageView appearance]setSuccessIcon:[UIImage imageNamed:@"NotificationButtonBackground"]];

[[TSMessageView appearance]setMessageIcon:[UIImage imageNamed:@"NotificationButtonBackground"]];

[[TSMessageView appearance]setWarningIcon:[UIImage imageNamed:@"NotificationButtonBackground"]];

//End of override



return YES;

}

```



The following properties can be set when creating a new notification:



* **viewController**: The view controller to show the notification in. This might be the navigation controller.

* **title**: The title of the notification view

* **subtitle**: The text that is displayed underneath the title (optional)

* **image**: A custom icon image that is used instead of the default one (optional)

* **type**: The notification type (Message, Warning, Error, Success)

* **duration**: The duration the notification should be displayed

* **callback**: The block that should be executed, when the user dismissed the message by tapping on it or swiping it to the top.



Except the title and the notification type, all of the listed values are optional



If you don't want a detailed description (the text underneath the title) you don't need to set one. The notification will automatically resize itself properly. 



# License

TSMessages is available under the MIT license. See the LICENSE file for more information.



# Recent Changes

Can be found in the [releases section](https://github.com/KrauseFx/TSMessages/releases) of this repo.