Skip to content

Latest commit

 

History

History
126 lines (88 loc) · 3.64 KB

README.md

File metadata and controls

126 lines (88 loc) · 3.64 KB
Raw

OEMentions

Platforms Language CocoaPod License

An easy way to add mentions to uitextview like Facebook and Instagram. It also include a tableview to show the users list to choose from. The component is written in Swift.

demo2_gif demo3_gif

Main features

  • Expandale UITextView (also expandle UITextView container)
  • Show and manage position of users list when "@" is typed ("@" can be changed to any character)
  • Customizable mention text

Installation

Cocoapods

pod 'OEMentions'

Manual

You can import OEMentions.swift file manually to your project folder

Usage Example

You can see a full implementation in ViewController.swift

  1. Refrence UITextView outlet and "Optional: Container (UIView that has UITextView in it)"
@IBOutlet weak var containerView: UIView!
@IBOutlet weak var textView: UITextView!
  1. Create a OEMention variable
var oeMentions:OEMentions!
  1. Create an OEObejct array that contain users info (id, name)
let oeObjects = [OEObject(id: 1,name: "Elsie Easterling"), OEObject(id: 2,name: "Caterina Misiewicz"), OEObject(id: 3,name: "Ruben Dematteo")]
  1. Initialize the OEMentions
oeMentions = OEMentions(containerView: containerView, textView: textView, mainView: self.view, oeObjects: oeObjects)
  1. Assign UITextView delegate to OEMentions
textView.delegate = oeMentions
  1. (Optional) OEMentionsDelegate: delegate method for the chosen user
class ViewController: UIViewController, OEMentionsDelegate
oeMentions.delegate = self
func mentionSelected(id:Int, name: String) {
      
      // Do something with selected id and name
      
}

Customization

changeMentionCharacter(character: String)
changeMentionTableviewBackground(color: UIColor)
// Color of the mention tableview name text
OEMentions.nameColor
// Font of the mention tableview name text
OEMentions.nameFont
// Rest of the UITextView text color
OEMentions.notMentionColor

License

MIT License

Copyright (c) 2019 Omar Alessa

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.