Skip to content

Latest commit

 

History

History
241 lines (167 loc) · 8.06 KB

README.md

File metadata and controls

241 lines (167 loc) · 8.06 KB
Raw

SQRichTextEditor

Build Status Version License Platform Swift Version

Introduction

I was looking for a WYSIWYG text editor for iOS and found some solutions but all of them didn't use WKWebView. Apple will stop accepting submissions of apps that use UIWebView APIs. I found a HTML5 rich text editor, which provides powerful cross-browser normalization in a flexible lightweight package. So I built this project and an iOS bridge for sending messages between Swift and JavaScript in WKWebView.

Example

To run the example project, clone the repo, and open SQRichTextEditor.xcworkspace from the Example directory.

SQRichTextEditor SQRichTextEditor

Requirements

  • Deployment target iOS 10.0+
  • Swift 5+
  • Xcode 11+

Installation

SQRichTextEditor is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'SQRichTextEditor'

Features

  • Bold
  • Italic
  • Underline
  • Strikethrough
  • Insert Image
  • Insert HTML
  • Make Link
  • Text Color
  • Text Size
  • Text Background Color

Getting Started

The SQTextEditorView is a plain UIView subclass, so you are free to use it wherever you want.

import SQRichTextEditor

private lazy var editorView: SQTextEditorView = {
	/// You can pass the custom css string, if you want to change the default editor style
	/// var customCss: String?
        /// if let cssURL = Bundle.main.url(forResource: isDarkMode ? "editor_dark" : "editor_light", withExtension: "css"),
        ///    let css = try? String(contentsOf: cssURL, encoding: .utf8) {
        ///    customCss = css
        /// }
        /// let _editorView = SQTextEditorView(customCss: customCss)

        let _editorView = SQTextEditorView()
        _editorView.translatesAutoresizingMaskIntoConstraints = false
        return _editorView
}()

view.addSubview(editorView)
editorView.topAnchor.constraint(equalTo: collectionView.bottomAnchor, constant: 10).isActive = true
editorView.leftAnchor.constraint(equalTo: view.leftAnchor, constant: 10).isActive = true
editorView.rightAnchor.constraint(equalTo: view.rightAnchor, constant: -10).isActive = true
editorView.bottomAnchor.constraint(equalTo: view.safeAreaLayoutGuide.bottomAnchor, constant: -10).isActive = true

Delegate

You can check events by implement SQTextEditorDelegate:

editorView.delegate = self

Delegate has these functions:

//Called when the editor components is ready.
optional func editorDidLoad(_ editor: SQTextEditorView)
    
//Called when the user selected some text or moved the cursor to a different position.
optional func editor(_ editor: SQTextEditorView,
                               selectedTextAttributeDidChange attribute: SQTextAttribute)
    
//Called when the user inserted, deleted or changed the style of some text.
optional func editor(_ editor: SQTextEditorView,
                               contentHeightDidChange height: Int)

//Called when the user tapped the editor
optional func editorDidFocus(_ editor: SQTextEditorView)

//Called when the user tapped the done button of keyboard tool bar
optional func editorDidTapDoneButton(_ editor: SQTextEditorView)

//Called when the editor cursor moved
optional func editor(_ editor: SQTextEditorView, cursorPositionDidChange position: SQEditorCursorPosition)

Editor Functions

getHTML

Returns the HTML value of the editor in its current state.

func getHTML(completion: @escaping (_ html: String?) -> ())

insertHTML

Inserts an HTML fragment at the current cursor location, or replaces the selection if selected. The value supplied should not contain tags or anything outside of that. A block to invoke when script evaluation completes or fails.

func insertHTML(_ html: String, completion: ((_ error: Error?) -> ())? = nil)

getSelectedText

The text currently selected in the editor.

func getSelectedText(completion: @escaping (_ text: String?) -> ())

bold

Makes any non-bold currently selected text bold (by wrapping it in a 'b' tag), otherwise removes any bold formatting from the selected text. A block to invoke when script evaluation completes or fails.

func bold(completion: ((_ error: Error?) -> ())? = nil)

italic

By wrapping it in an 'i' tag.

func italic(completion: ((_ error: Error?) -> ())? = nil)

underline

By wrapping it in an 'u' tag.

func underline(completion: ((_ error: Error?) -> ())? = nil)

strikethrough

By wrapping it in a 'del' tag.

func strikethrough(completion: ((_ error: Error?) -> ())? = nil)

setTextColor

Sets the color of the selected text.

func setText(color: UIColor, completion: ((_ error: Error?) -> ())? = nil)

setTextBackgroundColor

Sets the color of the background of the selected text.

func setText(backgroundColor: UIColor, completion: ((_ error: Error?) -> ())? = nil)

setTextSize

Sets the font size for the selected text.

func setText(size: Int, completion: ((_ error: Error?) -> ())? = nil)

insertImage

Inserts an image at the current cursor location. A block to invoke when script evaluation completes or fails.

func insertImage(url: String, completion: ((_ error: Error?) -> ())? = nil)

makeLink

Makes the currently selected text a link. If no text is selected, the URL or email will be inserted as text at the current cursor point and made into a link. A block to invoke when script evaluation completes or fails.

func makeLink(url: String, completion: ((_ error: Error?) -> ())? = nil)

removeLink

Removes any link that is currently at least partially selected. A block to invoke when script evaluation completes or fails.

func removeLink(completion: ((_ error: Error?) -> ())? = nil)

clear

Clear Editor's content. The method removes all Blocks and inserts new initial empty Block <div><br></div>. A block to invoke when script evaluation completes or fails.

func clear(completion: ((_ error: Error?) -> ())? = nil)

focus

The editor gained focus or lost focus.

func focus(_ isFocused: Bool, completion: ((_ error: Error?) -> ())? = nil)

Contributions

SQRichTextEditor welcomes both fixes, improvements, and feature additions. If you'd like to contribute, open a pull request with a detailed description of your changes.

If you'd like to fix or add some functions for editor.js or editor.css, you can open a pull request in this repo.

Author

Yuwei Lin, [email protected] @ OneupNetwork

License

SQRichTextEditor is available under the MIT license. See the LICENSE file for more info.

Attribution

SQRichTextEditor uses portions of code from the following powerful source:

Component Description License
Squire Squire is an HTML5 rich text editor, which provides powerful cross-browser normalisation in a flexible lightweight package. MIT
EFColorPicker A lightweight color picker in Swift. MIT