Skip to content

Latest commit

 

History

History
81 lines (49 loc) · 3.48 KB

README.md

File metadata and controls

81 lines (49 loc) · 3.48 KB
Raw

LSTextEditor

[![CI Status](http://img.shields.io/travis/Peter Lieder/LSTextEditor.svg?style=flat)](https://travis-ci.org/Peter Lieder/LSTextEditor) Version License Platform

A rich text editing feature for text input fields is getting more and more important in mobile applications nowadays. LSRichTextEditor combines an easy to implement component with various easy to set up features. The rich text component extends the UITextView by adding formatting attributes to selected ranges or typed letters. A toolbar is providing buttons for formatting features. The additional parser implementation provides transformation feature for markup languages, currently only BBCode is supported. A markup encoded string can also be exported from the formatted text.

Requirements

Supported versions: iOS 8, 9

Installation with CocoaPods

CocoaPods is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries like LSTextEditor in your projects. To install it, simply add the following lines to your Podfile.

Podfile

platform :ios, '8.0'
pod "LSTextEditor"

To run the example project, clone the repo, and run pod install from the Example directory first.

Usage

Implementation as Storyboard view object

Just create an UITextView component in your target storyboard, reference the LSRichTextView class and create an IBOutlet for further access. For this strategy of initialization all rich text features are enabled and can be changed afterwards.

Implementation from code

Create a LSRichTextView instance and initialize it like an UITextView object. See the example below.

LSRichTextView *textView = [[LSRichTextView alloc] initWithFrame:CGRectMake(0, 0, 300, 200) andConfiguration:[[LSRichTextConfiguration alloc] initWithConfiguration:LSRichTextFeaturesAll]];

[self.view addSubview:textView];

Setup of supported features

The LSRichTextConfiguration objects provides a global setup instance used all over the rich text component.

[[LSRichTextConfiguration alloc] initWithConfiguration:LSRichTextFeaturesAll]]

The features of objective-c LSRichTextFeatures with bit operators.

Enable Data Detection

If the rich text view component is initialized programmatically the data detection feature needs to be enabled programmatically too. This can be achieved by setting the according objective-c UIDataDetectorTypes type.

[self.richTextView.richTextConfiguration setTextCheckingType:UIDataDetectorTypeLink];

Limitations and Future Plans

Currently supported formatting features: Bold, Italic, Underline and Strike through.

Currently supported markup language: BBCode

Planned Changes:

  • extending the formatting features for text size and paragraphs
  • output formatter extension for handling other markup languages
  • improving parser implementation for handling other markup languages
  • improving parser integration to enable realtime markup detection

Author

Peter Lieder, peter@lshift.de

FORKED FROM ME

License

LSTextEditor is available under the Apache License Version 2.0. See the LICENSE file for more information.