Update docs (#282)

README.md

@@ -154,13 +154,11 @@ val isUnorderedList = richTextState.isUnorderedList
 Some of the rich text editor's features can be customized, such as the color of the links and the code blocks.
 
 ```kotlin
-richTextState.setConfig(
-    linkColor = Color.Blue,
-    linkTextDecoration = TextDecoration.Underline,
-    codeColor = Color.Yellow,
-    codeBackgroundColor = Color.Transparent,
-    codeStrokeColor = Color.LightGray,
-)
+richTextState.config.linkColor = Color.Blue
+richTextState.config.linkTextDecoration = TextDecoration.Underline
+richTextState.config.codeSpanColor = Color.Yellow
+richTextState.config.codeSpanBackgroundColor = Color.Transparent
+richTextState.config.codeSpanStrokeColor = Color.LightGray
 ```
 
 #### HTML import and export

docs/code_blocks.md

@@ -1,13 +1,13 @@
-# Code Blocks
+# Code Spans
 
-To add code blocks, `RichTextState` provides `toggleCodeSpan` method:
+To add code spans, `RichTextState` provides `toggleCodeSpan` method:
 
 ```kotlin
 // Toggle code span.
 richTextState.toggleCodeSpan()
 ```
 
-To get if the current selection is a code block, use `RichTextState.isCodeSpan`:
+To get if the current selection is a code span, use `RichTextState.isCodeSpan`:
 
 ```kotlin
 // Get if the current selection is a code span.

docs/index.md

@@ -152,13 +152,11 @@ val isUnorderedList = richTextState.isUnorderedList
 Some of the rich text editor's features can be customized, such as the color of the links and the code blocks.
 
 ```kotlin
-richTextState.setConfig(
-    linkColor = Color.Blue,
-    linkTextDecoration = TextDecoration.Underline,
-    codeColor = Color.Yellow,
-    codeBackgroundColor = Color.Transparent,
-    codeStrokeColor = Color.LightGray,
-)
+richTextState.config.linkColor = Color.Blue
+richTextState.config.linkTextDecoration = TextDecoration.Underline
+richTextState.config.codeSpanColor = Color.Yellow
+richTextState.config.codeSpanBackgroundColor = Color.Transparent
+richTextState.config.codeSpanStrokeColor = Color.LightGray
 ```
 
 #### HTML import and export

docs/rich_text_state.md

@@ -19,13 +19,11 @@ RichTextEditor(
 Some of the rich text editor's features can be customized, such as the color of the links and the code blocks.
 
 ```kotlin
-richTextState.setConfig(
-    linkColor = Color.Blue,
-    linkTextDecoration = TextDecoration.Underline,
-    codeColor = Color.Yellow,
-    codeBackgroundColor = Color.Transparent,
-    codeStrokeColor = Color.LightGray,
-)
+richTextState.config.linkColor = Color.Blue
+richTextState.config.linkTextDecoration = TextDecoration.Underline
+richTextState.config.codeSpanColor = Color.Yellow
+richTextState.config.codeSpanBackgroundColor = Color.Transparent
+richTextState.config.codeSpanStrokeColor = Color.LightGray
 ```
 
 ### Changing the editor's selection

docs/span_style.md

@@ -9,16 +9,26 @@ richTextState.toggleSpanStyle(SpanStyle(fontWeight = FontWeight.Bold))
 // Add a span style.
 richTextState.addSpanStyle(SpanStyle(fontWeight = FontWeight.Bold))
 
+// Add a span style for a specific range.
+richTextState.addSpanStyle(SpanStyle(fontWeight = FontWeight.Bold), TextRange(0, 5))
+
 // Remove a span style.
 richTextState.removeSpanStyle(SpanStyle(fontWeight = FontWeight.Bold))
+
+// Remove a span style for a specific range.
+richTextState.removeSpanStyle(SpanStyle(fontWeight = FontWeight.Bold), TextRange(0, 5))
 ```
 
 To get the current span style of the selection, use `RichTextState.currentSpanStyle`:
 
 ```kotlin
 // Get the current span style.
 val currentSpanStyle = richTextState.currentSpanStyle
-val isBold = currentSpanStyle.fontWeight = FontWeight.Bold
-val isItalic = currentSpanStyle.fontStyle = FontStyle.Italic
-val isUnderline = currentSpanStyle.textDecoration = TextDecoration.Underline
+val isBold = currentSpanStyle.fontWeight == FontWeight.Bold
+val isItalic = currentSpanStyle.fontStyle == FontStyle.Italic
+val isUnderline = currentSpanStyle.textDecoration == TextDecoration.Underline
+
+// Get the span style for a specific range.
+val spanStyle = richTextState.getSpanStyle(TextRange(0, 5))
+val isBold = spanStyle.fontWeight == FontWeight.Bold
 ```

richeditor-compose/src/commonMain/kotlin/com/mohamedrejeb/richeditor/model/RichTextState.kt

@@ -199,8 +199,8 @@ class RichTextState internal constructor(
     }
 
     @Deprecated(
-        message = "Use isCodeSpan instead",
-        replaceWith = ReplaceWith("isCodeSpan"),
+        message = "Use config instead",
+        replaceWith = ReplaceWith("config"),
         level = DeprecationLevel.WARNING,
     )
     fun setConfig(
@@ -239,7 +239,7 @@ class RichTextState internal constructor(
      * @param textRange the text range.
      * @return the [SpanStyle] of the text at the specified text range.
      */
-    fun getSpanStyleByTextRange(textRange: TextRange): SpanStyle =
+    fun getSpanStyle(textRange: TextRange): SpanStyle =
         if (textRange.collapsed) {
             val richSpan = getRichSpanByTextIndex(textIndex = textRange.min - 1)
 
@@ -261,7 +261,7 @@ class RichTextState internal constructor(
      * @param textRange the text range.
      * @return the [RichSpanStyle] of the text at the specified text range.
      */
-    fun getRichSpanStyleByTextRange(textRange: TextRange): RichSpanStyle =
+    fun getRichSpanStyle(textRange: TextRange): RichSpanStyle =
         if (textRange.collapsed) {
             val richSpan = getRichSpanByTextIndex(textIndex = textRange.min - 1)
 
@@ -283,7 +283,7 @@ class RichTextState internal constructor(
      * @param textRange the text range.
      * @return the [ParagraphStyle] of the text at the specified text range.
      */
-    fun getParagraphStyleByTextRange(textRange: TextRange): ParagraphStyle =
+    fun getParagraphStyle(textRange: TextRange): ParagraphStyle =
         if (textRange.collapsed) {
             val richParagraph = getRichParagraphByTextIndex(textIndex = textRange.min - 1)
 
@@ -305,7 +305,7 @@ class RichTextState internal constructor(
      * @param textRange the text range.
      * @return the [ParagraphType] of the text at the specified text range.
      */
-    internal fun getParagraphTypeByTextRange(textRange: TextRange): ParagraphType =
+    internal fun getParagraphType(textRange: TextRange): ParagraphType =
         if (textRange.collapsed) {
             val richParagraph = getRichParagraphByTextIndex(textIndex = textRange.min - 1)
 
@@ -2766,18 +2766,18 @@ class RichTextState internal constructor(
      *
      * @return A copy of this [RichTextState].
      */
-    @OptIn(ExperimentalRichTextApi::class)
     fun copy(): RichTextState {
         val richParagraphList = richParagraphList.map { it.copy() }
         val richTextState = RichTextState(richParagraphList)
         richTextState.updateTextFieldValue(textFieldValue)
-        richTextState.setConfig(
-            linkColor = config.linkColor,
-            linkTextDecoration = config.linkTextDecoration,
-            codeColor = config.codeSpanColor,
-            codeBackgroundColor = config.codeSpanBackgroundColor,
-            codeStrokeColor = config.codeSpanStrokeColor,
-        )
+        richTextState.config.linkColor = config.linkColor
+        richTextState.config.linkTextDecoration = config.linkTextDecoration
+        richTextState.config.codeSpanColor = config.codeSpanColor
+        richTextState.config.codeSpanBackgroundColor = config.codeSpanBackgroundColor
+        richTextState.config.codeSpanStrokeColor = config.codeSpanStrokeColor
+        richTextState.config.listIndent = config.listIndent
+        richTextState.config.preserveStyleOnEmptyLine = config.preserveStyleOnEmptyLine
+
         return richTextState
     }
 

sample/common/src/commonMain/kotlin/com/mohamedrejeb/richeditor/sample/common/slack/SlackDemoContent.kt

@@ -53,13 +53,11 @@ fun SlackDemoContent() {
     val openLinkDialog = remember { mutableStateOf(false) }
 
     LaunchedEffect(Unit) {
-        richTextState.setConfig(
-            linkColor = Color(0xFF1d9bd1),
-            linkTextDecoration = TextDecoration.None,
-            codeColor = Color(0xFFd7882d),
-            codeBackgroundColor = Color.Transparent,
-            codeStrokeColor = Color(0xFF494b4d),
-        )
+        richTextState.config.linkColor = Color(0xFF1d9bd1)
+        richTextState.config.linkTextDecoration = TextDecoration.None
+        richTextState.config.codeSpanColor = Color(0xFFd7882d)
+        richTextState.config.codeSpanBackgroundColor = Color.Transparent
+        richTextState.config.codeSpanStrokeColor = Color(0xFF494b4d)
     }
 
     Box(