Highlighting with NSAttributedString's #15
Conversation
| @@ -29,6 +29,27 @@ public final class MessageAutocompleteController: MessageTextViewListener { | |||
| public let range: NSRange | |||
| } | |||
| public private(set) var selection: Selection? | |||
|
|
|||
| /// Adds an additional space after the autocompleted text when true. Default value is `TRUE` | |||
There was a problem hiding this comment.
Reminder for me: I should start adding docs 😝
There was a problem hiding this comment.
😝 Every devs favorite task
| /// The default text attributes | ||
| open var defaultTextAttributes: [NSAttributedStringKey: Any] = | ||
| [NSAttributedStringKey.font: UIFont.preferredFont(forTextStyle: .body), | ||
| NSAttributedStringKey.foregroundColor: UIColor.black] |
There was a problem hiding this comment.
nit: omit the NSAttributedStringKey since it can be inferred from the type
There was a problem hiding this comment.
Remind to myself, add assert(Thread.isMainThread() to every public API w/ mutations
| open var autocompleteTextAttributes: [String: [NSAttributedStringKey: Any]] = [:] | ||
|
|
||
| /// A key used for referencing which substrings were autocompletes | ||
| private let NSAttributedAutocompleteKey = NSAttributedStringKey.init("com.system.autocompletekey") |
There was a problem hiding this comment.
nit: Could we namespace w/ the project name? So
private let NSAttributedAutocompleteKey =
NSAttributedStringKey.init("com.messageviewcontroller.autocompletekey")| textView.attributedText = textView.attributedText.replacingCharacters(in: highlightedRange, with: newAttributedString) + NSAttributedString(string: " ", attributes: typingTextAttributes) | ||
| } else { | ||
| textView.attributedText = textView.attributedText.replacingCharacters(in: highlightedRange, with: newAttributedString) | ||
| } |
There was a problem hiding this comment.
style nit: can we put params on newlines to keep the columns <120?
It looks like the line
textView.attributedText.replacingCharacters(in: highlightedRange, with: newAttributedString)Is included twice. Could you put that in a var before entering the if statement?
Or simply:
textView.attributedText = textView.attributedText.replacingCharacters(in: highlightedRange, with: newAttributedString)
if appendSpaceOnCompletion {
textView.attributedText += NSAttributedString(string: " ", attributes: typingTextAttributes)
}
There was a problem hiding this comment.
👍 Private API function?
| /// | ||
| /// - Parameter textView: The `UITextView` to apply `typingTextAttributes` to | ||
| internal func preserveTypingAttributes(for textView: UITextView) { | ||
|
|
| // Backspace/removing text | ||
| let attribute = textView.attributedText.attributes(at: range.lowerBound, longestEffectiveRange: nil, in: range).filter { return $0.key == NSAttributedAutocompleteKey } | ||
| let isAutocompleted = (attribute[NSAttributedAutocompleteKey] as? Bool ?? false) == true | ||
| if isAutocompleted { |
There was a problem hiding this comment.
merge isAutocompleted into the if-statement? variable isn't used anywhere else
There was a problem hiding this comment.
I feel like it improves readability here as it's a quite complicatedly (is that a word?) computed Bool.
| if isAutocompleted { | ||
| // Starting to delete autocompleted text, so remove the autocompleted substring | ||
| let lowerRange = NSRange(location: 0, length: range.location + 1) | ||
| textView.attributedText.enumerateAttribute(NSAttributedAutocompleteKey, in: lowerRange, options: .reverse, using: { (_, range, stop) in |
| textView.attributedText.enumerateAttribute(NSAttributedAutocompleteKey, in: lowerRange, options: .reverse, using: { (_, range, stop) in | ||
|
|
||
| // Only delete the first found range | ||
| defer { stop.pointee = true } |
| return ns | ||
| } | ||
|
|
||
| static func +(lhs: NSAttributedString, rhs: NSAttributedString) -> NSAttributedString { |
| } | ||
|
|
||
| } | ||
|
|
Suggestions from @rnystrom in PR and edits in the README to show users how to use text highlighting
|
Solid, thanks for the feedback! 💯 Edits made |
This is for #8 and adds the ability to have text highlighting for autocomplete. This is done by switching the text replacement to NSAttributedString's with custom attributes.
Management of autocompleted substrings was done by applying a custom NSAttributedStringKey.
Open to all feedback 😊
Breaking Change
MessageTextViewListener,func willChangeRange(textView: MessageTextView, to range: NSRange)which allowed for the observation of text range changes such that the entire autocomplete string is deleted rather than character by character