Skip to content

Commit f2fdd53

Browse files
authored
feat(block-kit): add card block example (#67)
1 parent e16b87e commit f2fdd53

3 files changed

Lines changed: 86 additions & 0 deletions

File tree

‎block-kit/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Read the [docs](https://docs.slack.dev/block-kit/) to learn concepts behind thes
99
### Blocks
1010

1111
- **[Actions](https://docs.slack.dev/reference/block-kit/blocks/actions-block)**: Holds multiple interactive elements. [Implementation](./src/main/java/blocks/Actions.java).
12+
- **[Card](https://docs.slack.dev/reference/block-kit/blocks/card-block)**: Displays content in a card. [Implementation](./src/main/java/blocks/Card.java).
1213
- **[Context](https://docs.slack.dev/reference/block-kit/blocks/context-block)**: Provides contextual info, which can include both images and text. [Implementation](./src/main/java/blocks/Context.java).
1314
- **[Divider](https://docs.slack.dev/reference/block-kit/blocks/divider-block)**: Visually separates pieces of info inside of a message. [Implementation](./src/main/java/blocks/Divider.java).
1415
- **[File](https://docs.slack.dev/reference/block-kit/blocks/file-block)**: Displays info about remote files. [Implementation](./src/main/java/blocks/File.java).
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
package blocks;
2+
3+
import com.slack.api.model.block.Blocks;
4+
import com.slack.api.model.block.CardBlock;
5+
import com.slack.api.model.block.composition.BlockCompositions;
6+
import com.slack.api.model.block.element.BlockElements;
7+
import java.util.List;
8+
9+
/**
10+
* Displays content in a card.
11+
* {@link https://docs.slack.dev/reference/block-kit/blocks/card-block/}
12+
*/
13+
public class Card {
14+
/**
15+
* A card with icon, title, subtitle, hero image, body, and an action button.
16+
*/
17+
public static CardBlock example01() {
18+
CardBlock block = Blocks.card(c -> c.icon(BlockElements.imageElement(
19+
i -> i.imageUrl("https://picsum.photos/36/36").altText("Icon")))
20+
.title(BlockCompositions.markdownText("Lumon Industries"))
21+
.subtitle(BlockCompositions.markdownText("Committed to work-life balance"))
22+
.heroImage(BlockElements.imageElement(
23+
i -> i.imageUrl("https://picsum.photos/400/300").altText("Sample hero image")))
24+
.body(BlockCompositions.markdownText("Please enjoy each card equally."))
25+
.actions(List.of(BlockElements.button(b -> b.text(BlockCompositions.plainText(
26+
pt -> pt.text("Action Button").emoji(false)))
27+
.actionId("button_action")))));
28+
return block;
29+
}
30+
}
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
package blocks;
2+
3+
import static org.junit.jupiter.api.Assertions.assertEquals;
4+
5+
import com.google.gson.JsonParser;
6+
import com.slack.api.model.block.CardBlock;
7+
import com.slack.api.util.json.GsonFactory;
8+
import org.junit.jupiter.api.Test;
9+
10+
public class CardTest {
11+
@Test
12+
public void testExample01() {
13+
CardBlock block = Card.example01();
14+
String actual = GsonFactory.createSnakeCase().toJson(block);
15+
String expected = """
16+
{
17+
"type": "card",
18+
"icon": {
19+
"type": "image",
20+
"image_url": "https://picsum.photos/36/36",
21+
"alt_text": "Icon"
22+
},
23+
"title": {
24+
"type": "mrkdwn",
25+
"text": "Lumon Industries"
26+
},
27+
"subtitle": {
28+
"type": "mrkdwn",
29+
"text": "Committed to work-life balance"
30+
},
31+
"hero_image": {
32+
"type": "image",
33+
"image_url": "https://picsum.photos/400/300",
34+
"alt_text": "Sample hero image"
35+
},
36+
"body": {
37+
"type": "mrkdwn",
38+
"text": "Please enjoy each card equally."
39+
},
40+
"actions": [
41+
{
42+
"type": "button",
43+
"text": {
44+
"type": "plain_text",
45+
"text": "Action Button",
46+
"emoji": false
47+
},
48+
"action_id": "button_action"
49+
}
50+
]
51+
}
52+
""";
53+
assertEquals(JsonParser.parseString(expected), JsonParser.parseString(actual));
54+
}
55+
}

0 commit comments

Comments
 (0)