Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fastred/EmojiTextView
Tap to swap out words with emojis. Inspired by Messages.app on iOS 10.
https://github.com/fastred/EmojiTextView
Last synced: about 2 months ago
JSON representation
Tap to swap out words with emojis. Inspired by Messages.app on iOS 10.
- Host: GitHub
- URL: https://github.com/fastred/EmojiTextView
- Owner: fastred
- License: mit
- Archived: true
- Created: 2016-07-16T22:38:16.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-23T15:50:26.000Z (almost 8 years ago)
- Last Synced: 2024-07-18T08:53:04.526Z (2 months ago)
- Language: Swift
- Homepage:
- Size: 597 KB
- Stars: 339
- Watchers: 10
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EmojiTextView
Tap to swap out words with emojis. Works with any `UITextView`. Heavily inspired by Messages.app on iOS 10.
Created by [Arkadiusz Holko][holko] ([@arekholko][twitter]).
## Usage
Add a property of `EmojiController` type to a class that holds your `UITextView` instance, e.g. a view controller:
```swift
var emojiController: EmojiController?
```
Then, initialize `EmojiController` by passing it your text view (e.g. in `viewDidLoad()`):
```swift
emojiController = EmojiController(textView: textView)
```
That's it! 🎉
## Customization
`EmojiController` provides three points of customization through properties:
- `mapping` – contains a mapping from words to an array of emojis
- `textHighlightingFactory` – creates a new instance of an object conforming to `TextHighlighting` protocol; each instance of that object is responsible for highlighting a single word
- `defaultAttributes` - attributes (as in `NSAttributedString`) of a text that's not replaceable with emoji
## Installation
EmojiTextView is available through [CocoaPods](http://cocoapods.org). To install it simply add the following line to your Podfile:
```
pod "EmojiTextView", "0.0.1"
```
Then you can import it with:
```swift
import EmojiTextView
```
## Requirements
iOS 9 and above.
## Future Improvements
- Should the emoji replacement be enabled only when the emoji keyboard is selected? It probably requires the use of the private API as `UITextInputMode` doesn't help here.
- If there's more than one emoji match for a given word there should be an ability to choose which one we want to use.
- **(EASY)** There should be an option to switch back from an emoji to the full word. Hint: add an attribute with the original word to the part of the string replaced by an emoji.
## Credits
- Emoji keyword library is based on [emojilib][emojilib].
[emojilib]: https://github.com/muan/emojilib
[holko]: http://holko.pl
[twitter]: https://twitter.com/arekholko