Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions block-kit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ Read the [docs](https://docs.slack.dev/block-kit/) to learn concepts behind thes
- **[Plan](https://docs.slack.dev/reference/block-kit/blocks/plan-block)**: Displays a collection of related tasks. [Implementation](./src/blocks/plan.py).
- **[Rich text](https://docs.slack.dev/reference/block-kit/blocks/rich-text-block)**: Displays formatted, structured representation of text. [Implementation](./src/blocks/rich_text.py).
- **[Section](https://docs.slack.dev/reference/block-kit/blocks/section-block)**: Displays text, possibly alongside elements. [Implementation](./src/blocks/section.py).
- **[Table](https://docs.slack.dev/reference/block-kit/blocks/table-block)**: Displays structured data arranged in rows and columns. [Implementation](./src/blocks/table.py).
- **[Task card](https://docs.slack.dev/reference/block-kit/blocks/task-card-block)**: Displays a single task, representing a single action. [Implementation](./src/blocks/task_card.py).
- **[Video](https://docs.slack.dev/reference/block-kit/blocks/video-block)**: Displays an embedded video player. [Implementation](./src/blocks/video.py).
16 changes: 16 additions & 0 deletions block-kit/src/blocks/alert.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
from slack_sdk.models.blocks import AlertBlock
from slack_sdk.models.blocks.basic_components import MarkdownTextObject


def example01() -> AlertBlock:
"""
Displays a notification message within a modal.
https://docs.slack.dev/reference/block-kit/blocks/alert-block/

An informational alert.
"""
block = AlertBlock(
text=MarkdownTextObject(text="The work is mysterious and important."),
level="info",
)
return block
46 changes: 46 additions & 0 deletions block-kit/src/blocks/table.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
from slack_sdk.models.blocks import TableBlock


def example01() -> TableBlock:
"""
Displays structured data arranged in rows and columns.
https://docs.slack.dev/reference/block-kit/blocks/table-block/

A table with header, text, link, and number cells alongside column settings.
"""
block = TableBlock(
block_id="optional_unique_id",
column_settings=[
{"is_wrapped": True, "align": "left"},
{"align": "right", "is_wrapped": False},
],
rows=[
[
{"type": "raw_text", "text": "Header A"},
{"type": "raw_text", "text": "Header B"},
],
[
{"type": "raw_text", "text": "Data 1A"},
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "link",
"text": "Data 1B",
"url": "https://slack.com",
}
],
}
],
},
],
[
{"type": "raw_text", "text": "Data 2A"},
{"type": "raw_number", "text": "12345"},
],
],
)
return block
17 changes: 17 additions & 0 deletions block-kit/tests/blocks/test_alert.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import json

from src.blocks import alert


def test_example01():
block = alert.example01()
actual = block.to_dict()
expected = {
"type": "alert",
"text": {
"type": "mrkdwn",
"text": "The work is mysterious and important.",
},
"level": "info",
}
assert json.dumps(actual, sort_keys=True) == json.dumps(expected, sort_keys=True)
45 changes: 45 additions & 0 deletions block-kit/tests/blocks/test_table.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import json

from src.blocks import table


def test_example01():
block = table.example01()
actual = block.to_dict()
expected = {
"type": "table",
"block_id": "optional_unique_id",
"column_settings": [
{"is_wrapped": True, "align": "left"},
{"align": "right", "is_wrapped": False},
],
"rows": [
[
{"type": "raw_text", "text": "Header A"},
{"type": "raw_text", "text": "Header B"},
],
[
{"type": "raw_text", "text": "Data 1A"},
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "link",
"text": "Data 1B",
"url": "https://slack.com",
}
],
}
],
},
],
[
{"type": "raw_text", "text": "Data 2A"},
{"type": "raw_number", "text": "12345"},
],
],
}
assert json.dumps(actual, sort_keys=True) == json.dumps(expected, sort_keys=True)