Support list style (#42)

* Added bullet list style in TextSpanStyle

* Removing bullet from final out put string

* Apply list style to selected text

* Supporting list style with bullet with disc type and single indent

* End list style on adding new line twice

* fix not able to add more then one new line

* Supporting list style

Author: cp-divyesh-v

RichEditorDemo/RichEditorDemo/ContentView.swift

@@ -40,7 +40,7 @@ struct ContentView: View {
                 ToolbarItem(placement: .topBarTrailing) {
                     Button(action: {
 
-                        print("Export JSON == \(state.output())")
+                        print("Exported JSON == \(state.output())")
                     }, label: {
                         Image(systemName: "checkmark")
                             .padding()

Sources/RichEditorSwiftUI/Attributes/RichTextAttributeWriter+List.swift

@@ -0,0 +1,115 @@
+//
+//  RichTextAttributeWriter+List.swift
+//
+//
+//  Created by Divyesh Vekariya on 09/05/24.
+//
+
+import Foundation
+
+#if canImport(UIKit)
+import UIKit
+#endif
+
+#if canImport(AppKit) && !targetEnvironment(macCatalyst)
+import AppKit
+#endif
+
+public extension RichTextAttributeWriter {
+
+    /**
+     Set the text alignment at a certain range.
+
+     Unlike some other attributes, this value applies to the
+     entire paragraph, not just the selected range.
+     */
+    func setRichTextListStyle(
+        _ listType: ListType,
+        to newValue: Bool,
+        at range: NSRange
+    ) {
+        setListStyle(listType, to: newValue, at: range)
+    }
+}
+
+private extension RichTextAttributeWriter {
+
+    func setListStyle(
+        _ listType: ListType,
+        to newValue: Bool,
+        at range: NSRange
+    ) {
+        guard let string = mutableRichText else { return }
+        let safeRange = safeRange(for: range)
+
+        let searchRange = NSRange(location: max(0, (range.location - 1)), length: min(string.string.utf16Length, (range.length + 1)))
+        var previousRang: NSRange? = nil
+
+        var attributesWithRange: [Int: (range: NSRange, paragraphStyle: NSMutableParagraphStyle)] = [:]
+        string.beginEditing()
+        var previousStyle: NSMutableParagraphStyle? = nil
+        string.enumerateAttribute(.paragraphStyle, in: searchRange) { (attribute, range, _) in
+
+            if let style = attribute as? NSMutableParagraphStyle, !style.textLists.isEmpty {
+                if newValue {
+                    /// For add style
+                    attributesWithRange[attributesWithRange.count] = (range: range, paragraphStyle: style)
+
+                    if safeRange.location <= range.location && safeRange.upperBound >= range.upperBound {
+                        string.removeAttribute(.paragraphStyle, range: range)
+                    }
+
+                    if let oldRange = previousRang, let previousStyle = previousStyle, previousStyle.textLists.count == listType.getIndent() {
+                        let location = min(oldRange.location, range.location)
+                        let length = max(oldRange.upperBound, range.upperBound) - location
+                        let combinedRange = NSRange(location: location, length: length)
+
+                        string.addAttribute(.paragraphStyle, value: previousStyle, range: combinedRange)
+                        previousRang = combinedRange
+                    } else {
+                        let location = min(safeRange.location, range.location)
+                        let length = max(safeRange.upperBound, range.upperBound) - location
+                        let combinedRange = NSRange(location: location, length: length)
+
+                        string.addAttribute(.paragraphStyle, value: style, range: combinedRange)
+                        previousRang = combinedRange
+                    }
+                    previousStyle = style
+                } else {
+                    /// Fore Remove Style
+                    if safeRange.closedRange.overlaps(range.closedRange) {
+                        if style.textLists.count == listType.getIndent() {
+                            string.removeAttribute(.paragraphStyle, range: safeRange)
+                            previousRang = nil
+                            previousStyle = nil
+                        }
+                    }
+                }
+            }
+        }
+
+        ///Add style if not already added
+        if attributesWithRange.isEmpty {
+            
+            let paragraphStyle = NSMutableParagraphStyle()
+
+            paragraphStyle.alignment = .left
+            let listItem = NSTextList(markerFormat: listType.getMarkerFormat(), options: 0)
+
+            if paragraphStyle.textLists.isEmpty && newValue {
+                paragraphStyle.textLists.append(listItem)
+            } else {
+                paragraphStyle.textLists.removeAll()
+            }
+
+            if !paragraphStyle.textLists.isEmpty {
+                string.addAttributes([.paragraphStyle: paragraphStyle], range: safeRange)
+            } else {
+                string.removeAttribute(.paragraphStyle, range: safeRange)
+            }
+        }
+
+        string.fixAttributes(in: range)
+        string.endEditing()
+    }
+}

Sources/RichEditorSwiftUI/Attributes/RichTextAttributeWriter+Style.swift

@@ -27,6 +27,13 @@ public extension NSMutableAttributedString {
     ) {
         let rangeValue = range ?? richTextRange
         let range = safeRange(for: rangeValue)
+
+        if style.isList, let style = style.listType {
+            setRichTextListStyle(style, to: newValue, at: range)
+        }
+
+        guard !style.isList else { return }
+
         let attributeValue = newValue ? 1 : 0
         if style == .underline { return setRichTextAttribute(.underlineStyle, to: attributeValue, at: range) }
         guard let font = richTextFont(at: range) else { return }

Sources/RichEditorSwiftUI/Data/Models/RichAttributes.swift

@@ -14,30 +14,34 @@ public struct RichAttributes: Codable {
     public let italic: Bool?
     public let underline: Bool?
     public let header: HeaderType?
-    //    public let list: ListType?
+    public let list: ListType?
+    public let indent: Int?
 
     public init(
         //        id: String = UUID().uuidString,
         bold: Bool? = nil,
         italic: Bool? = nil,
         underline: Bool? = nil,
-        header: HeaderType? = nil
-        //                list: ListType? = nil
+        header: HeaderType? = nil,
+        list: ListType? = nil,
+        indent: Int? = nil
     ) {
         //        self.id = id
         self.bold = bold
         self.italic = italic
         self.underline = underline
         self.header = header
-        //        self.list = list
+        self.list = list
+        self.indent = indent
     }
 
     enum CodingKeys: String, CodingKey {
         case bold = "bold"
         case italic = "italic"
         case underline = "underline"
         case header = "header"
-        //        case list = "list"
+        case list = "list"
+        case indent = "indent"
     }
 
     public init(from decoder: Decoder) throws {
@@ -47,7 +51,8 @@ public struct RichAttributes: Codable {
         self.italic = try values.decodeIfPresent(Bool.self, forKey: .italic)
         self.underline = try values.decodeIfPresent(Bool.self, forKey: .underline)
         self.header = try values.decodeIfPresent(HeaderType.self, forKey: .header)
-        //        self.list = try values.decodeIfPresent(ListType.self, forKey: .list)
+        self.list = try values.decodeIfPresent(ListType.self, forKey: .list)
+        self.indent = try values.decodeIfPresent(Int.self, forKey: .indent)
     }
 }
 
@@ -58,7 +63,8 @@ extension RichAttributes: Hashable {
         hasher.combine(italic)
         hasher.combine(underline)
         hasher.combine(header)
-        //        hasher.combine(list)
+        hasher.combine(list)
+        hasher.combine(indent)
     }
 }
 
@@ -71,7 +77,8 @@ extension RichAttributes: Equatable {
         && lhs.italic == rhs.italic
         && lhs.underline == rhs.underline
         && lhs.header == rhs.header
-        //        && lhs.list == rhs.list
+        && lhs.list == rhs.list
+        && lhs.indent == rhs.indent
         )
     }
 }
@@ -80,15 +87,17 @@ extension RichAttributes {
     public func copy(bold: Bool? = nil,
                      header: HeaderType? = nil,
                      italic: Bool? = nil,
-                     underline: Bool? = nil
-//                     list: ListType? = nil
+                     underline: Bool? = nil,
+                     list: ListType? = nil,
+                     indent: Int? = nil
     ) -> RichAttributes {
         return RichAttributes(
             bold: (bold != nil ? bold! : self.bold),
             italic: (italic != nil ? italic! : self.italic),
             underline: (underline != nil ? underline! : self.underline),
-            header: (header != nil ? header! : self.header)
-            //            list: (list != nil ? list! : self.list)
+            header: (header != nil ? header! : self.header),
+            list: (list != nil ? list! : self.list),
+            indent: (indent != nil ? indent! : self.indent)
         )
     }
 
@@ -102,8 +111,9 @@ extension RichAttributes {
             bold: (att.bold != nil ? (byAdding ? att.bold! : nil) : self.bold),
             italic: (att.italic != nil ? (byAdding ? att.italic! : nil) : self.italic),
             underline: (att.underline != nil ? (byAdding ? att.underline! : nil) : self.underline),
-            header: (att.header != nil ? (byAdding ? att.header! : nil) : self.header)
-            //            list: (att.list != nil ? (byAdding ? att.list! : nil) : self.list)
+            header: (att.header != nil ? (byAdding ? att.header! : nil) : self.header),
+            list: (att.list != nil ? (byAdding ? att.list! : nil) : self.list),
+            indent: (att.indent != nil ? (byAdding ? att.indent! : nil) : self.indent)
         )
     }
 }
@@ -123,9 +133,9 @@ extension RichAttributes {
         if let header = header {
             styles.append(header.getTextSpanStyle())
         }
-        //        if let list = list {
-        //            styles.append(.list(list))
-        //        }
+        if let list = list {
+            styles.append(list.getTextSpanStyle())
+        }
         return styles
     }
 
@@ -143,9 +153,9 @@ extension RichAttributes {
         if let header = header {
             styles.insert(header.getTextSpanStyle())
         }
-        //        if let list = list {
-        //            styles.insert(.list(list))
-        //        }
+        if let list = list {
+            styles.insert(list.getTextSpanStyle())
+        }
         return styles
     }
 }
@@ -173,11 +183,8 @@ extension RichAttributes {
             return header == .h5
         case .h6:
             return header == .h6
-            //        case .bullet:
-            //            return list == .bullet
-            //        case .ordered:
-            //            return list == .ordered
-
+        case .bullet:
+            return list == .bullet(indent)
         }
     }
 }
@@ -192,7 +199,9 @@ internal func getRichAttributesFor(styles: [RichTextStyle]) -> RichAttributes {
     var italic: Bool? = nil
     var underline: Bool? = nil
     var header: HeaderType? = nil
-    //        var list: ListType? = nil
+    var list: ListType? = nil
+    var indent: Int? = nil
+
     for style in styles {
         switch style {
         case .bold:
@@ -213,16 +222,18 @@ internal func getRichAttributesFor(styles: [RichTextStyle]) -> RichAttributes {
             header = .h5
         case .h6:
             header = .h6
-            //            case .list(let listType):
-            //                list = listType
+        case .bullet(let indentIndex):
+            list = .bullet(indentIndex)
+            indent = indentIndex
         case .default:
             header = .default
         }
     }
     return RichAttributes(bold: bold,
                           italic: italic,
                           underline: underline,
-                          header: header
-                          //                          list: list
+                          header: header,
+                          list: list,
+                          indent: indent
     )
 }

Sources/RichEditorSwiftUI/Data/Models/RichText.swift

@@ -30,7 +30,3 @@ public struct RichTextSpan: Codable {
     }
 }
 
-public enum ListType: String, Codable {
-    case bullet = "bullet"
-    case ordered = "ordered"
-}

Sources/RichEditorSwiftUI/Data/Models/RichTextSpanInternal.swift

@@ -48,12 +48,7 @@ extension RichTextSpanInternal: Hashable {
 
 extension RichTextSpanInternal {
     public var spanRange: NSRange {
-        let range = NSRange(location: from, length: (to - from) + 1)
-
-        guard range.length > 0 else {
-            return .init(location: range.location,
-                         length: 0)
-        }
+        let range = NSRange(location: from, length: max(((to - from) + 1), 0))
         return range
     }
 

Sources/RichEditorSwiftUI/UI/Editor/RichEditorState+UITextView.swift

@@ -0,0 +1,56 @@
+//
+//  RichEditorState+UITextView.swift
+//
+//
+//  Created by Divyesh Vekariya on 07/06/24.
+//
+
+import Foundation
+import UIKit
+
+extension RichEditorState {
+    func textView(_ textView: UITextView, shouldChangeTextIn range: NSRange, replacementText text: String) -> Bool {
+        /// Handle newly added text according to our convenience
+
+        // If the user just hit enter/newline
+        if text == .newLine {
+            let previousRange = NSRange(location: range.location > 1 ? (range.location - 2) : range.location, length: 0)
+            if textView.text[previousRange.closedRange].string() == .newLine {
+                if activeStyles.contains(where: { $0.isList }) {
+                    endListStyle()
+                    return false
+                }
+            }
+        } 
+//        else if text == .tab {
+//            if activeStyles.contains(where: { $0.isList }) {
+//                addSubList()
+//                return false
+//            }
+//        }
+
+        return true
+    }
+
+    func endListStyle() {
+        if let itemToRemove = activeStyles.first(where: { $0.isList }), let listType = itemToRemove.listType {
+            if listType.getIndent() <= 0 {
+                toggleStyle(style: itemToRemove)
+            }
+//            else {
+//                activeStyles.remove(itemToRemove)
+//                toggleStyle(style: listType.moveIndentBackward().getTextSpanStyle())
+//            }
+        }
+    }
+
+//    func addSubList() {
+//        if let listStyle = activeStyles.first(where: { $0.isList }) {
+//            if let listType = listStyle.listType {
+//                let newListStyle = listType.moveIndentForward().getTextSpanStyle()
+//                activeStyles.remove(listStyle)
+//                toggleStyle(style: newListStyle)
+//            }
+//        }
+//    }
+}