Skip to content

Add RichTextBlock support to Block Kit Kotlin DSL builder #1376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Sep 20, 2024
Merged

Add RichTextBlock support to Block Kit Kotlin DSL builder #1376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dfbe0e4
Add missing border property to RichTextQuoteElement
KENNYSOFT Sep 19, 2024
47006b9
Add RichTextBlock support to Block Kit Kotlin DSL builder
KENNYSOFT Sep 19, 2024
a892eb8
Polish documentation and imports
KENNYSOFT Sep 19, 2024
1be897c
Revert "Polish documentation and imports"
KENNYSOFT Sep 19, 2024
3afa2dc
Run the integration tests to add border property of RichTextQuoteElement
KENNYSOFT Sep 19, 2024
ab49bd2
Add missing parameters to RichTextObjectDsl
KENNYSOFT Sep 19, 2024
12c2ea7
Increase coverage of RichTextBlockTest
KENNYSOFT Sep 19, 2024
8aa01ca
Merge branch 'main' into kotlin-richtext
seratch Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions json-logs/samples/api/views.open.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1003,7 +1004,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1554,7 +1556,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1691,7 +1694,8 @@
}
]
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -2104,7 +2108,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down
15 changes: 10 additions & 5 deletions json-logs/samples/api/views.publish.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1003,7 +1004,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1554,7 +1556,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1691,7 +1694,8 @@
}
]
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -2104,7 +2108,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down
15 changes: 10 additions & 5 deletions json-logs/samples/api/views.push.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1003,7 +1004,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1554,7 +1556,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1691,7 +1694,8 @@
}
]
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -2104,7 +2108,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down
15 changes: 10 additions & 5 deletions json-logs/samples/api/views.update.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1003,7 +1004,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1554,7 +1556,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -1691,7 +1694,8 @@
}
]
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down Expand Up @@ -2104,7 +2108,8 @@
},
"unicode": ""
}
]
],
"border": 123
},
{
"type": "rich_text_section",
Expand Down
43 changes: 43 additions & 0 deletions ...ension/src/main/kotlin/com/slack/api/model/kotlin_extension/block/RichTextBlockBuilder.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
package com.slack.api.model.kotlin_extension.block

import com.slack.api.model.block.RichTextBlock
import com.slack.api.model.kotlin_extension.block.element.container.MultiRichTextElementContainer
import com.slack.api.model.kotlin_extension.block.element.dsl.RichTextElementDsl

@BlockLayoutBuilder
class RichTextBlockBuilder private constructor(
private val elementsContainer: MultiRichTextElementContainer
) : Builder<RichTextBlock>, RichTextElementDsl by elementsContainer {
private var blockId: String? = null

constructor() : this(MultiRichTextElementContainer())

/**
* A string acting as a unique identifier for a block. You can use this `block_id` when you receive an interaction
* payload to identify the source of the action. If not specified, one will be generated. Maximum length for this
* field is 255 characters. `block_id` should be unique for each message and each iteration of a message. If a
* message is updated, use a new `block_id`.
*
* @see <a href="https://api.slack.com/reference/block-kit/blocks#rich_text">Rich text block documentation</a>
*/
fun blockId(id: String) {
blockId = id
}

/**
* An array of rich text objects - `rich_text_section`, `rich_text_list`, `rich_text_preformatted`,
* and `rich_text_quote`.
*
* @see <a href="https://api.slack.com/reference/block-kit/blocks#rich_text">Rich text block documentation</a>
*/
fun elements(builder: RichTextElementDsl.() -> Unit) {
elementsContainer.apply(builder)
}

override fun build(): RichTextBlock {
return RichTextBlock.builder()
.blockId(blockId)
.elements(elementsContainer.underlying)
.build()
}
}
81 changes: 81 additions & 0 deletions ...ck/api/model/kotlin_extension/block/composition/container/MultiRichTextObjectContainer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
package com.slack.api.model.kotlin_extension.block.composition.container

import com.slack.api.model.block.element.RichTextElement
import com.slack.api.model.block.element.RichTextSectionElement
import com.slack.api.model.block.element.RichTextSectionElement.LimitedTextStyle
import com.slack.api.model.block.element.RichTextSectionElement.TextStyle
import com.slack.api.model.kotlin_extension.block.composition.dsl.RichTextObjectDsl
import com.slack.api.model.kotlin_extension.block.element.BroadcastRange

class MultiRichTextObjectContainer : RichTextObjectDsl {
val underlying = mutableListOf<RichTextElement>()

override fun broadcast(range: BroadcastRange, style: LimitedTextStyle?) {
underlying += RichTextSectionElement.Broadcast.builder()
.range(range.value)
.style(style)
.build()
}

override fun color(value: String, style: LimitedTextStyle?) {
underlying += RichTextSectionElement.Color.builder()
.value(value)
.style(style)
.build()
}

override fun channel(channelId: String, style: LimitedTextStyle?) {
underlying += RichTextSectionElement.Channel.builder()
.channelId(channelId)
.style(style)
.build()
}

override fun date(timestamp: Int, format: String, style: TextStyle?, url: String?, fallback: String?) {
underlying += RichTextSectionElement.Date.builder()
.timestamp(timestamp)
.format(format)
.style(style)
.url(url)
.fallback(fallback)
.build()
}

override fun emoji(name: String, skinTone: Int?, style: LimitedTextStyle?) {
underlying += RichTextSectionElement.Emoji.builder()
.name(name)
.skinTone(skinTone)
.style(style)
.build()
}

override fun link(url: String, text: String?, unsafe: Boolean?, style: TextStyle?) {
underlying += RichTextSectionElement.Link.builder()
.url(url)
.text(text)
.unsafe(unsafe)
.style(style)
.build()
}

override fun text(text: String, style: TextStyle?) {
underlying += RichTextSectionElement.Text.builder()
.text(text)
.style(style)
.build()
}

override fun user(userId: String, style: LimitedTextStyle?) {
underlying += RichTextSectionElement.User.builder()
.userId(userId)
.style(style)
.build()
}

override fun usergroup(usergroupId: String, style: LimitedTextStyle?) {
underlying += RichTextSectionElement.UserGroup.builder()
.usergroupId(usergroupId)
.style(style)
.build()
}
}
Loading