react-native-enriched 0.2.1 → 0.4.0

package/android/src/main/java/com/swmansion/enriched/common/spans/EnrichedMentionSpan.kt

@@ -0,0 +1,35 @@
+package com.swmansion.enriched.common.spans
+
+import android.text.TextPaint
+import android.text.style.ClickableSpan
+import android.view.View
+import com.swmansion.enriched.common.EnrichedStyle
+import com.swmansion.enriched.common.spans.interfaces.EnrichedInlineSpan
+
+open class EnrichedMentionSpan(
+  private val text: String,
+  private val indicator: String,
+  private val attributes: Map<String, String>,
+  private val enrichedStyle: EnrichedStyle,
+) : ClickableSpan(),
+  EnrichedInlineSpan {
+  override fun onClick(view: View) {
+    // Do nothing. Mentions inside the input are not clickable.
+    // We are using `ClickableSpan` to allow the text to be styled as a clickable element.
+  }
+
+  override fun updateDrawState(textPaint: TextPaint) {
+    super.updateDrawState(textPaint)
+
+    val mentionsStyle = enrichedStyle.mentionsStyle[indicator] ?: return
+    textPaint.color = mentionsStyle.color
+    textPaint.bgColor = mentionsStyle.backgroundColor
+    textPaint.isUnderlineText = mentionsStyle.underline
+  }
+
+  fun getAttributes(): Map<String, String> = attributes
+
+  fun getText(): String = text
+
+  fun getIndicator(): String = indicator
+}

package/android/src/main/java/com/swmansion/enriched/{spans → common/spans}/EnrichedOrderedListSpan.kt

@@ -1,18 +1,22 @@
-package com.swmansion.enriched.spans
+package com.swmansion.enriched.common.spans
 
 import android.graphics.Canvas
 import android.graphics.Paint
 import android.graphics.Typeface
+import android.os.Build
 import android.text.Layout
 import android.text.TextPaint
 import android.text.style.LeadingMarginSpan
 import android.text.style.MetricAffectingSpan
-import com.swmansion.enriched.spans.interfaces.EnrichedParagraphSpan
-import com.swmansion.enriched.styles.HtmlStyle
-
-class EnrichedOrderedListSpan(private var index: Int, private val htmlStyle: HtmlStyle) : MetricAffectingSpan(), LeadingMarginSpan, EnrichedParagraphSpan {
-  override val dependsOnHtmlStyle: Boolean = true
+import com.swmansion.enriched.common.EnrichedStyle
+import com.swmansion.enriched.common.spans.interfaces.EnrichedParagraphSpan
 
+open class EnrichedOrderedListSpan(
+  var index: Int,
+  private val enrichedStyle: EnrichedStyle,
+) : MetricAffectingSpan(),
+  LeadingMarginSpan,
+  EnrichedParagraphSpan {
   override fun updateMeasureState(p0: TextPaint) {
     // Do nothing, but inform layout that this span affects text metrics
   }
@@ -21,9 +25,7 @@ class EnrichedOrderedListSpan(private var index: Int, private val htmlStyle: Htm
     // Do nothing, but inform layout that this span affects text metrics
   }
 
-  override fun getLeadingMargin(first: Boolean): Int {
-    return htmlStyle.olMarginLeft + htmlStyle.olGapWidth
-  }
+  override fun getLeadingMargin(first: Boolean): Int = enrichedStyle.olMarginLeft + enrichedStyle.olGapWidth
 
   override fun drawLeadingMargin(
     canvas: Canvas,
@@ -37,20 +39,20 @@ class EnrichedOrderedListSpan(private var index: Int, private val htmlStyle: Htm
     start: Int,
     end: Int,
     first: Boolean,
-    layout: Layout?
+    layout: Layout?,
   ) {
     if (first) {
       val text = "$index."
       val width = paint.measureText(text)
 
       val yPosition = baseline.toFloat()
-      val xPosition = (htmlStyle.olMarginLeft + x - width / 2) * dir
+      val xPosition = (enrichedStyle.olMarginLeft + x - width / 2) * dir
 
       val originalColor = paint.color
       val originalTypeface = paint.typeface
 
-      paint.color = htmlStyle.olMarkerColor ?: originalColor
-      paint.typeface = getTypeface(htmlStyle.olMarkerFontWeight, originalTypeface)
+      paint.color = enrichedStyle.olMarkerColor ?: originalColor
+      paint.typeface = getTypeface(enrichedStyle.olMarkerFontWeight, originalTypeface)
       canvas.drawText(text, xPosition, yPosition, paint)
 
       paint.color = originalColor
@@ -58,10 +60,13 @@ class EnrichedOrderedListSpan(private var index: Int, private val htmlStyle: Htm
     }
   }
 
-  private fun getTypeface(fontWeight: Int?, originalTypeface: Typeface): Typeface {
-    return if (fontWeight == null) {
+  private fun getTypeface(
+    fontWeight: Int?,
+    originalTypeface: Typeface,
+  ): Typeface =
+    if (fontWeight == null) {
       originalTypeface
-    } else if (android.os.Build.VERSION.SDK_INT >= 28) {
+    } else if (Build.VERSION.SDK_INT >= 28) {
       Typeface.create(originalTypeface, fontWeight, false)
     } else {
       // Fallback for API < 28: only bold/normal supported
@@ -71,17 +76,4 @@ class EnrichedOrderedListSpan(private var index: Int, private val htmlStyle: Htm
         Typeface.create(originalTypeface, Typeface.NORMAL)
       }
     }
-  }
-
-  fun getIndex(): Int {
-    return index
-  }
-
-  fun setIndex(i: Int) {
-    index = i
-  }
-
-  override fun rebuildWithStyle(htmlStyle: HtmlStyle): EnrichedOrderedListSpan {
-    return EnrichedOrderedListSpan(index, htmlStyle)
-  }
 }

package/android/src/main/java/com/swmansion/enriched/common/spans/EnrichedStrikeThroughSpan.kt

@@ -0,0 +1,11 @@
+package com.swmansion.enriched.common.spans
+
+import android.text.style.StrikethroughSpan
+import com.swmansion.enriched.common.EnrichedStyle
+import com.swmansion.enriched.common.spans.interfaces.EnrichedInlineSpan
+
+@Suppress("UNUSED_PARAMETER")
+open class EnrichedStrikeThroughSpan(
+  private val enrichedStyle: EnrichedStyle,
+) : StrikethroughSpan(),
+  EnrichedInlineSpan

package/android/src/main/java/com/swmansion/enriched/common/spans/EnrichedUnderlineSpan.kt

@@ -0,0 +1,11 @@
+package com.swmansion.enriched.common.spans
+
+import android.text.style.UnderlineSpan
+import com.swmansion.enriched.common.EnrichedStyle
+import com.swmansion.enriched.common.spans.interfaces.EnrichedInlineSpan
+
+@Suppress("UNUSED_PARAMETER")
+open class EnrichedUnderlineSpan(
+  private val enrichedStyle: EnrichedStyle,
+) : UnderlineSpan(),
+  EnrichedInlineSpan

package/android/src/main/java/com/swmansion/enriched/{spans → common/spans}/EnrichedUnorderedListSpan.kt

@@ -1,4 +1,4 @@
-package com.swmansion.enriched.spans
+package com.swmansion.enriched.common.spans
 
 import android.graphics.Canvas
 import android.graphics.Paint
@@ -7,13 +7,15 @@ import android.text.Spanned
 import android.text.TextPaint
 import android.text.style.LeadingMarginSpan
 import android.text.style.MetricAffectingSpan
-import com.swmansion.enriched.spans.interfaces.EnrichedParagraphSpan
-import com.swmansion.enriched.styles.HtmlStyle
+import com.swmansion.enriched.common.EnrichedStyle
+import com.swmansion.enriched.common.spans.interfaces.EnrichedParagraphSpan
 
 // https://android.googlesource.com/platform/frameworks/base/+/refs/heads/main/core/java/android/text/style/BulletSpan.java
-class EnrichedUnorderedListSpan(private val htmlStyle: HtmlStyle) : MetricAffectingSpan(), LeadingMarginSpan, EnrichedParagraphSpan {
-  override val dependsOnHtmlStyle: Boolean = true
-
+open class EnrichedUnorderedListSpan(
+  private val enrichedStyle: EnrichedStyle,
+) : MetricAffectingSpan(),
+  LeadingMarginSpan,
+  EnrichedParagraphSpan {
   override fun updateMeasureState(p0: TextPaint) {
     // Do nothing, but inform layout that this span affects text metrics
   }
@@ -22,9 +24,7 @@ class EnrichedUnorderedListSpan(private val htmlStyle: HtmlStyle) : MetricAffect
     // Do nothing, but inform layout that this span affects text metrics
   }
 
-  override fun getLeadingMargin(p0: Boolean): Int {
-    return htmlStyle.ulBulletSize + htmlStyle.ulGapWidth + htmlStyle.ulMarginLeft
-  }
+  override fun getLeadingMargin(p0: Boolean): Int = enrichedStyle.ulBulletSize + enrichedStyle.ulGapWidth + enrichedStyle.ulMarginLeft
 
   override fun drawLeadingMargin(
     canvas: Canvas,
@@ -38,19 +38,19 @@ class EnrichedUnorderedListSpan(private val htmlStyle: HtmlStyle) : MetricAffect
     start: Int,
     end: Int,
     first: Boolean,
-    layout: Layout?
+    layout: Layout?,
   ) {
     val spannedText = text as Spanned
 
     if (spannedText.getSpanStart(this) == start) {
       val style = paint.style
       val oldColor = paint.color
-      paint.color = htmlStyle.ulBulletColor
+      paint.color = enrichedStyle.ulBulletColor
       paint.style = Paint.Style.FILL
 
-      val bulletRadius = htmlStyle.ulBulletSize / 2f
+      val bulletRadius = enrichedStyle.ulBulletSize / 2f
       val yPosition = (top + bottom) / 2f
-      val xPosition = x + dir * bulletRadius + htmlStyle.ulMarginLeft
+      val xPosition = x + dir * bulletRadius + enrichedStyle.ulMarginLeft
 
       canvas.drawCircle(xPosition, yPosition, bulletRadius, paint)
 
@@ -58,8 +58,4 @@ class EnrichedUnorderedListSpan(private val htmlStyle: HtmlStyle) : MetricAffect
       paint.style = style
     }
   }
-
-  override fun rebuildWithStyle(htmlStyle: HtmlStyle): EnrichedUnorderedListSpan {
-    return EnrichedUnorderedListSpan(htmlStyle)
-  }
 }

package/android/src/main/java/com/swmansion/enriched/common/spans/interfaces/EnrichedBlockSpan.kt

@@ -0,0 +1,5 @@
+package com.swmansion.enriched.common.spans.interfaces
+
+interface EnrichedBlockSpan :
+  EnrichedSpan,
+  EnrichedZeroWidthSpaceSpan

package/android/src/main/java/com/swmansion/enriched/common/spans/interfaces/EnrichedHeadingSpan.kt

@@ -0,0 +1,3 @@
+package com.swmansion.enriched.common.spans.interfaces
+
+interface EnrichedHeadingSpan : EnrichedParagraphSpan

package/android/src/main/java/com/swmansion/enriched/common/spans/interfaces/EnrichedInlineSpan.kt

@@ -0,0 +1,3 @@
+package com.swmansion.enriched.common.spans.interfaces
+
+interface EnrichedInlineSpan : EnrichedSpan

package/android/src/main/java/com/swmansion/enriched/common/spans/interfaces/EnrichedParagraphSpan.kt

@@ -0,0 +1,5 @@
+package com.swmansion.enriched.common.spans.interfaces
+
+interface EnrichedParagraphSpan :
+  EnrichedSpan,
+  EnrichedZeroWidthSpaceSpan

package/android/src/main/java/com/swmansion/enriched/common/spans/interfaces/EnrichedSpan.kt

@@ -0,0 +1,3 @@
+package com.swmansion.enriched.common.spans.interfaces
+
+interface EnrichedSpan

package/android/src/main/java/com/swmansion/enriched/{spans → common/spans}/interfaces/EnrichedZeroWidthSpaceSpan.kt

@@ -1,5 +1,4 @@
-package com.swmansion.enriched.spans.interfaces
+package com.swmansion.enriched.common.spans.interfaces
 
 // Spans that are prefixed with zero-width space (\u200B) to ensure that they are visible even when empty.
-interface EnrichedZeroWidthSpaceSpan {
-}
+interface EnrichedZeroWidthSpaceSpan

package/android/src/main/java/com/swmansion/enriched/textinput/EnrichedTextInputConnectionWrapper.kt

@@ -0,0 +1,140 @@
+package com.swmansion.enriched.textinput
+
+import android.view.KeyEvent
+import android.view.inputmethod.InputConnection
+import android.view.inputmethod.InputConnectionWrapper
+import com.facebook.react.bridge.ReactContext
+import com.facebook.react.uimanager.UIManagerHelper
+import com.swmansion.enriched.textinput.events.OnInputKeyPressEvent
+
+// This class is based on the implementation from Facebook React Native to provide 'onKeyPress' API on android.
+// Original source:
+// https://github.com/facebook/react-native/blob/v0.83.1/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/textinput/ReactEditTextInputConnectionWrapper.kt
+class EnrichedTextInputConnectionWrapper(
+  target: InputConnection,
+  private val reactContext: ReactContext,
+  private val editText: EnrichedTextInputView,
+  private val experimentalSynchronousEvents: Boolean,
+) : InputConnectionWrapper(target, false) {
+  private var isBatchEdit = false
+  private var key: String? = null
+
+  override fun beginBatchEdit(): Boolean {
+    isBatchEdit = true
+    return super.beginBatchEdit()
+  }
+
+  override fun endBatchEdit(): Boolean {
+    isBatchEdit = false
+    key?.let { k ->
+      dispatchKeyEvent(k)
+      key = null
+    }
+    return super.endBatchEdit()
+  }
+
+  override fun setComposingText(
+    text: CharSequence,
+    newCursorPosition: Int,
+  ): Boolean {
+    val previousSelectionStart = editText.selectionStart
+    val previousSelectionEnd = editText.selectionEnd
+
+    val consumed = super.setComposingText(text, newCursorPosition)
+
+    val currentSelectionStart = editText.selectionStart
+    val noPreviousSelection = previousSelectionStart == previousSelectionEnd
+    val cursorDidNotMove = currentSelectionStart == previousSelectionStart
+    val cursorMovedBackwardsOrAtBeginningOfInput =
+      currentSelectionStart < previousSelectionStart || currentSelectionStart <= 0
+
+    val inputKey =
+      if (
+        cursorMovedBackwardsOrAtBeginningOfInput || (!noPreviousSelection && cursorDidNotMove)
+      ) {
+        BACKSPACE_KEY_VALUE
+      } else {
+        editText.text?.get(currentSelectionStart - 1).toString()
+      }
+
+    dispatchKeyEventOrEnqueue(inputKey)
+    return consumed
+  }
+
+  override fun commitText(
+    text: CharSequence,
+    newCursorPosition: Int,
+  ): Boolean {
+    var inputKey = text.toString()
+    // Assume not a keyPress if length > 1 (or 2 if unicode)
+    if (inputKey.length <= 2) {
+      if (inputKey.isEmpty()) {
+        inputKey = BACKSPACE_KEY_VALUE
+      }
+      dispatchKeyEventOrEnqueue(inputKey)
+    }
+    return super.commitText(text, newCursorPosition)
+  }
+
+  override fun deleteSurroundingText(
+    beforeLength: Int,
+    afterLength: Int,
+  ): Boolean {
+    dispatchKeyEvent(BACKSPACE_KEY_VALUE)
+    return super.deleteSurroundingText(beforeLength, afterLength)
+  }
+
+  // Called by SwiftKey when cursor at beginning of input when there is a delete
+  // or when enter is pressed anywhere in the text. Whereas stock Android Keyboard calls
+  // [InputConnection.deleteSurroundingText] & [InputConnection.commitText]
+  // in each case, respectively.
+  override fun sendKeyEvent(event: KeyEvent): Boolean {
+    if (event.action == KeyEvent.ACTION_DOWN) {
+      val isNumberKey = event.unicodeChar in 48..57
+      when (event.keyCode) {
+        KeyEvent.KEYCODE_DEL -> {
+          dispatchKeyEvent(BACKSPACE_KEY_VALUE)
+        }
+
+        KeyEvent.KEYCODE_ENTER -> {
+          dispatchKeyEvent(ENTER_KEY_VALUE)
+        }
+
+        else -> {
+          if (isNumberKey) {
+            dispatchKeyEvent(event.number.toString())
+          }
+        }
+      }
+    }
+    return super.sendKeyEvent(event)
+  }
+
+  private fun dispatchKeyEventOrEnqueue(inputKey: String) {
+    if (isBatchEdit) {
+      key = inputKey
+    } else {
+      dispatchKeyEvent(inputKey)
+    }
+  }
+
+  private fun dispatchKeyEvent(inputKey: String) {
+    val resolvedKey = if (inputKey == NEWLINE_RAW_VALUE) ENTER_KEY_VALUE else inputKey
+    val surfaceId = UIManagerHelper.getSurfaceId(editText)
+    val eventDispatcher = UIManagerHelper.getEventDispatcherForReactTag(reactContext, editText.id)
+    eventDispatcher?.dispatchEvent(
+      OnInputKeyPressEvent(
+        surfaceId = surfaceId,
+        viewId = editText.id,
+        key = resolvedKey,
+        experimentalSynchronousEvents = experimentalSynchronousEvents,
+      ),
+    )
+  }
+
+  companion object {
+    const val NEWLINE_RAW_VALUE: String = "\n"
+    const val BACKSPACE_KEY_VALUE: String = "Backspace"
+    const val ENTER_KEY_VALUE: String = "Enter"
+  }
+}

package/android/src/main/java/com/swmansion/enriched/textinput/EnrichedTextInputSpannableFactory.kt

@@ -0,0 +1,83 @@
+package com.swmansion.enriched.textinput
+
+import com.swmansion.enriched.common.parser.EnrichedSpanFactory
+import com.swmansion.enriched.common.spans.EnrichedCheckboxListSpan
+import com.swmansion.enriched.common.spans.EnrichedImageSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputBlockQuoteSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputBoldSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputCheckboxListSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputCodeBlockSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputH1Span
+import com.swmansion.enriched.textinput.spans.EnrichedInputH2Span
+import com.swmansion.enriched.textinput.spans.EnrichedInputH3Span
+import com.swmansion.enriched.textinput.spans.EnrichedInputH4Span
+import com.swmansion.enriched.textinput.spans.EnrichedInputH5Span
+import com.swmansion.enriched.textinput.spans.EnrichedInputH6Span
+import com.swmansion.enriched.textinput.spans.EnrichedInputImageSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputInlineCodeSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputItalicSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputLinkSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputMentionSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputOrderedListSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputStrikeThroughSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputUnderlineSpan
+import com.swmansion.enriched.textinput.spans.EnrichedInputUnorderedListSpan
+import com.swmansion.enriched.textinput.styles.HtmlStyle
+
+class EnrichedTextInputSpannableFactory : EnrichedSpanFactory<HtmlStyle> {
+  override fun createBoldSpan(style: HtmlStyle) = EnrichedInputBoldSpan(style)
+
+  override fun createItalicSpan(style: HtmlStyle) = EnrichedInputItalicSpan(style)
+
+  override fun createUnderlineSpan(style: HtmlStyle) = EnrichedInputUnderlineSpan(style)
+
+  override fun createStrikeThroughSpan(style: HtmlStyle) = EnrichedInputStrikeThroughSpan(style)
+
+  override fun createInlineCodeSpan(style: HtmlStyle) = EnrichedInputInlineCodeSpan(style)
+
+  override fun createLinkSpan(
+    url: String,
+    style: HtmlStyle,
+  ) = EnrichedInputLinkSpan(url, style)
+
+  override fun createMentionSpan(
+    text: String,
+    indicator: String,
+    attributes: Map<String, String>,
+    style: HtmlStyle,
+  ) = EnrichedInputMentionSpan(text, indicator, attributes, style)
+
+  override fun createImageSpan(
+    source: String,
+    width: Int,
+    height: Int,
+  ): EnrichedImageSpan = EnrichedInputImageSpan.createEnrichedImageSpan(source, width, height)
+
+  override fun createH1Span(style: HtmlStyle) = EnrichedInputH1Span(style)
+
+  override fun createH2Span(style: HtmlStyle) = EnrichedInputH2Span(style)
+
+  override fun createH3Span(style: HtmlStyle) = EnrichedInputH3Span(style)
+
+  override fun createH4Span(style: HtmlStyle) = EnrichedInputH4Span(style)
+
+  override fun createH5Span(style: HtmlStyle) = EnrichedInputH5Span(style)
+
+  override fun createH6Span(style: HtmlStyle) = EnrichedInputH6Span(style)
+
+  override fun createOrderedListSpan(
+    index: Int,
+    style: HtmlStyle,
+  ) = EnrichedInputOrderedListSpan(index, style)
+
+  override fun createUnorderedListSpan(style: HtmlStyle) = EnrichedInputUnorderedListSpan(style)
+
+  override fun createCheckboxListSpan(
+    isChecked: Boolean,
+    style: HtmlStyle,
+  ) = EnrichedInputCheckboxListSpan(isChecked, style)
+
+  override fun createBlockQuoteSpan(style: HtmlStyle) = EnrichedInputBlockQuoteSpan(style)
+
+  override fun createCodeBlockSpan(style: HtmlStyle) = EnrichedInputCodeBlockSpan(style)
+}