Skip to content

Commit 153822e

Browse files
authored
feat(block-kit): add block element examples (#69)
1 parent 0c3bcc0 commit 153822e

65 files changed

Lines changed: 3029 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎block-kit/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,38 @@ Read the [docs](https://docs.slack.dev/block-kit/) to learn concepts behind thes
2020
- **[Section](https://docs.slack.dev/reference/block-kit/blocks/section-block)**: Displays text, possibly alongside elements. [Implementation](./src/main/java/blocks/Section.java).
2121
- **[Video](https://docs.slack.dev/reference/block-kit/blocks/video-block)**: Displays an embedded video player. [Implementation](./src/main/java/blocks/Video.java).
2222

23+
### Block elements
24+
25+
- **[Broadcast](https://docs.slack.dev/reference/block-kit/block-elements/broadcast-element)**: Displays a broadcast mention such as here, channel, or everyone. [Implementation](./src/main/java/elements/Broadcast.java).
26+
- **[Button](https://docs.slack.dev/reference/block-kit/block-elements/button-element)**: Allows users a direct path to performing basic actions. [Implementation](./src/main/java/elements/Button.java).
27+
- **[Channel](https://docs.slack.dev/reference/block-kit/block-elements/channel-element)**: Renders as a mention of a channel. [Implementation](./src/main/java/elements/Channel.java).
28+
- **[Color](https://docs.slack.dev/reference/block-kit/block-elements/color-element)**: Displays a color swatch from a hex value. [Implementation](./src/main/java/elements/Color.java).
29+
- **[Date](https://docs.slack.dev/reference/block-kit/block-elements/date-element)**: Displays a formatted, localized date. [Implementation](./src/main/java/elements/Date.java).
30+
- **[Date picker](https://docs.slack.dev/reference/block-kit/block-elements/date-picker-element)**: Allows users to select a date from a calendar style UI. [Implementation](./src/main/java/elements/DatePicker.java).
31+
- **[Datetime picker](https://docs.slack.dev/reference/block-kit/block-elements/datetime-picker-element)**: Allows users to select both a date and a time of day. [Implementation](./src/main/java/elements/DatetimePicker.java).
32+
- **[Email input](https://docs.slack.dev/reference/block-kit/block-elements/email-input-element)**: Allows user to enter an email into a single-line field. [Implementation](./src/main/java/elements/EmailInput.java).
33+
- **[Emoji](https://docs.slack.dev/reference/block-kit/block-elements/emoji-element)**: Displays an emoji. [Implementation](./src/main/java/elements/Emoji.java).
34+
- **[Feedback buttons](https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element)**: Buttons to indicate positive or negative feedback. [Implementation](./src/main/java/elements/FeedbackButtons.java).
35+
- **[File input](https://docs.slack.dev/reference/block-kit/block-elements/file-input-element)**: Allows user to upload files. [Implementation](./src/main/java/elements/FileInput.java).
36+
- **[Icon button](https://docs.slack.dev/reference/block-kit/block-elements/icon-button-element)**: An icon button to perform actions. [Implementation](./src/main/java/elements/IconButton.java).
37+
- **[Image](https://docs.slack.dev/reference/block-kit/block-elements/image-element)**: Displays an image as part of a larger block of content. [Implementation](./src/main/java/elements/Image.java).
38+
- **[Link](https://docs.slack.dev/reference/block-kit/block-elements/link-element)**: Displays a hyperlink. [Implementation](./src/main/java/elements/Link.java).
39+
- **[Multi-select menu](https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element)**: Allows users to select multiple items from a list of options. [Implementation](./src/main/java/elements/MultiSelectMenu.java).
40+
- **[Number input](https://docs.slack.dev/reference/block-kit/block-elements/number-input-element)**: Allows user to enter a number into a single-line field. [Implementation](./src/main/java/elements/NumberInput.java).
41+
- **[Overflow menu](https://docs.slack.dev/reference/block-kit/block-elements/overflow-menu-element)**: Allows users to press a button to view a list of options. [Implementation](./src/main/java/elements/OverflowMenu.java).
42+
- **[Plain-text input](https://docs.slack.dev/reference/block-kit/block-elements/plain-text-input-element)**: Allows users to enter freeform text data into a single-line or multi-line field. [Implementation](./src/main/java/elements/PlainTextInput.java).
43+
- **[Radio button group](https://docs.slack.dev/reference/block-kit/block-elements/radio-button-group-element)**: Allows users to choose one item from a list of possible options. [Implementation](./src/main/java/elements/RadioButtons.java).
44+
- **[Rich text input](https://docs.slack.dev/reference/block-kit/block-elements/rich-text-input-element)**: Allows users to enter formatted text in a WYSIWYG composer, offering the same messaging writing experience as in Slack. [Implementation](./src/main/java/elements/RichTextInput.java).
45+
- **[Rich text list](https://docs.slack.dev/reference/block-kit/block-elements/rich-text-list-element)**: Displays a list of rich text items. [Implementation](./src/main/java/elements/RichTextList.java).
46+
- **[Rich text preformatted](https://docs.slack.dev/reference/block-kit/block-elements/rich-text-preformatted-element)**: Displays a preformatted rich text element. [Implementation](./src/main/java/elements/RichTextPreformatted.java).
47+
- **[Rich text quote](https://docs.slack.dev/reference/block-kit/block-elements/rich-text-quote-element)**: Displays a rich text quote block. [Implementation](./src/main/java/elements/RichTextQuote.java).
48+
- **[Rich text section](https://docs.slack.dev/reference/block-kit/block-elements/rich-text-section-element)**: A section element that holds rich text elements. [Implementation](./src/main/java/elements/RichTextSection.java).
49+
- **[Select menu](https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element)**: Allows users to choose an option from a drop down menu. [Implementation](./src/main/java/elements/SelectMenu.java).
50+
- **[Team](https://docs.slack.dev/reference/block-kit/block-elements/team-element)**: Renders as a mention of a workspace or team. [Implementation](./src/main/java/elements/Team.java).
51+
- **[Text](https://docs.slack.dev/reference/block-kit/block-elements/text-element)**: Displays text, optionally with styling. [Implementation](./src/main/java/elements/Text.java).
52+
- **[Time picker](https://docs.slack.dev/reference/block-kit/block-elements/time-picker-element)**: Allows users to enter numerical data into a single-line field. [Implementation](./src/main/java/elements/TimePicker.java).
53+
- **[URL input](https://docs.slack.dev/reference/block-kit/block-elements/url-input-element)**: Allows user to enter a URL into a single-line field. [Implementation](./src/main/java/elements/UrlInput.java).
54+
- **[User](https://docs.slack.dev/reference/block-kit/block-elements/user-element)**: Renders as a mention of a user. [Implementation](./src/main/java/elements/User.java).
55+
- **[Usergroup](https://docs.slack.dev/reference/block-kit/block-elements/usergroup-element)**: Renders as a mention of a user group. [Implementation](./src/main/java/elements/UserGroup.java).
56+
- **[Workflow button](https://docs.slack.dev/reference/block-kit/block-elements/workflow-button-element)**: Allows users to run a link trigger with customizable inputs. [Implementation](./src/main/java/elements/WorkflowButton.java).
57+
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
package elements;
2+
3+
import com.slack.api.model.block.Blocks;
4+
import com.slack.api.model.block.RichTextBlock;
5+
import com.slack.api.model.block.element.RichTextSectionElement;
6+
import java.util.List;
7+
8+
/**
9+
* Displays a broadcast mention such as here, channel, or everyone.
10+
* {@link https://docs.slack.dev/reference/block-kit/block-elements/broadcast-element/}
11+
*/
12+
public class Broadcast {
13+
/**
14+
* A rich text block with a broadcast mention in a section.
15+
*/
16+
public static RichTextBlock example01() {
17+
RichTextBlock block = Blocks.richText(rt -> rt.elements(List.of(RichTextSectionElement.builder()
18+
.elements(List.of(RichTextSectionElement.Broadcast.builder()
19+
.range("everyone")
20+
.build()))
21+
.build())));
22+
return block;
23+
}
24+
}
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
package elements;
2+
3+
import static com.slack.api.model.block.composition.BlockCompositions.markdownText;
4+
import static com.slack.api.model.block.composition.BlockCompositions.plainText;
5+
6+
import com.slack.api.model.block.Blocks;
7+
import com.slack.api.model.block.LayoutBlock;
8+
import com.slack.api.model.block.element.BlockElements;
9+
import com.slack.api.model.block.element.ButtonElement;
10+
import java.util.List;
11+
12+
/**
13+
* Allows users a direct path to performing basic actions.
14+
* {@link https://docs.slack.dev/reference/block-kit/block-elements/button-element/}
15+
*/
16+
public class Button {
17+
/**
18+
* A regular interactive button.
19+
*/
20+
public static ButtonElement example01() {
21+
ButtonElement element = BlockElements.button(
22+
b -> b.text(plainText("Click Me")).value("click_me_123").actionId("button"));
23+
return element;
24+
}
25+
26+
/**
27+
* A button with a primary style attribute.
28+
*/
29+
public static ButtonElement example02() {
30+
ButtonElement element = BlockElements.button(b ->
31+
b.text(plainText("Save")).style("primary").value("click_me_123").actionId("button"));
32+
return element;
33+
}
34+
35+
/**
36+
* A link button.
37+
*/
38+
public static ButtonElement example03() {
39+
ButtonElement element =
40+
BlockElements.button(b -> b.text(plainText("Link Button")).url("https://docs.slack.dev/block-kit"));
41+
return element;
42+
}
43+
44+
/**
45+
* The button element used inside either the section or actions block.
46+
*/
47+
public static List<LayoutBlock> example05() {
48+
List<LayoutBlock> blocks = List.of(
49+
Blocks.section(s -> s.text(markdownText("This is a section block with a button."))
50+
.accessory(BlockElements.button(b -> b.text(plainText("Click Me"))
51+
.value("click_me_123")
52+
.actionId("button")))),
53+
Blocks.actions(a -> a.blockId("actionblock789")
54+
.elements(List.of(
55+
BlockElements.button(b -> b.text(plainText("Primary Button"))
56+
.style("primary")
57+
.value("click_me_456")),
58+
BlockElements.button(b ->
59+
b.text(plainText("Link Button")).url("https://api.slack.com/block-kit"))))));
60+
return blocks;
61+
}
62+
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
package elements;
2+
3+
import com.slack.api.model.block.Blocks;
4+
import com.slack.api.model.block.RichTextBlock;
5+
import com.slack.api.model.block.element.RichTextSectionElement;
6+
import java.util.List;
7+
8+
/**
9+
* Renders as a mention of a channel.
10+
* {@link https://docs.slack.dev/reference/block-kit/block-elements/channel-element/}
11+
*/
12+
public class Channel {
13+
/**
14+
* A rich text block with a channel mention in a section.
15+
*/
16+
public static RichTextBlock example01() {
17+
RichTextBlock block = Blocks.richText(rt -> rt.elements(List.of(RichTextSectionElement.builder()
18+
.elements(List.of(RichTextSectionElement.Channel.builder()
19+
.channelId("C123ABC456")
20+
.build()))
21+
.build())));
22+
return block;
23+
}
24+
}
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
package elements;
2+
3+
import com.slack.api.model.block.Blocks;
4+
import com.slack.api.model.block.RichTextBlock;
5+
import com.slack.api.model.block.element.RichTextSectionElement;
6+
import java.util.List;
7+
8+
/**
9+
* Displays a color swatch from a hex value.
10+
* {@link https://docs.slack.dev/reference/block-kit/block-elements/color-element/}
11+
*/
12+
public class Color {
13+
/**
14+
* A rich text block with a color element in a section.
15+
*/
16+
public static RichTextBlock example01() {
17+
RichTextBlock block = Blocks.richText(rt -> rt.elements(List.of(RichTextSectionElement.builder()
18+
.elements(List.of(
19+
RichTextSectionElement.Color.builder().value("#F405B3").build()))
20+
.build())));
21+
return block;
22+
}
23+
}
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
package elements;
2+
3+
import com.slack.api.model.block.Blocks;
4+
import com.slack.api.model.block.RichTextBlock;
5+
import com.slack.api.model.block.element.RichTextSectionElement;
6+
import java.util.List;
7+
8+
/**
9+
* Displays a formatted, localized date.
10+
* {@link https://docs.slack.dev/reference/block-kit/block-elements/date-element/}
11+
*/
12+
public class Date {
13+
/**
14+
* A rich text block with a date element in a section.
15+
*/
16+
public static RichTextBlock example01() {
17+
RichTextBlock block = Blocks.richText(rt -> rt.elements(List.of(RichTextSectionElement.builder()
18+
.elements(List.of(RichTextSectionElement.Date.builder()
19+
.timestamp(1720710212)
20+
.format("{date_num} at {time}")
21+
.fallback("timey")
22+
.build()))
23+
.build())));
24+
return block;
25+
}
26+
}
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
package elements;
2+
3+
import static com.slack.api.model.block.composition.BlockCompositions.markdownText;
4+
import static com.slack.api.model.block.composition.BlockCompositions.plainText;
5+
6+
import com.slack.api.model.block.Blocks;
7+
import com.slack.api.model.block.SectionBlock;
8+
import com.slack.api.model.block.element.BlockElements;
9+
10+
/**
11+
* Allows users to select a date from a calendar style UI.
12+
* {@link https://docs.slack.dev/reference/block-kit/block-elements/date-picker-element/}
13+
*/
14+
public class DatePicker {
15+
/**
16+
* A section block with a date picker accessory.
17+
*/
18+
public static SectionBlock example01() {
19+
SectionBlock block = Blocks.section(s -> s.blockId("section1234")
20+
.text(markdownText("Pick a date for the deadline."))
21+
.accessory(BlockElements.datePicker(d -> d.actionId("datepicker123")
22+
.initialDate("1990-04-28")
23+
.placeholder(plainText("Select a date")))));
24+
return block;
25+
}
26+
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
package elements;
2+
3+
import static com.slack.api.model.block.composition.BlockCompositions.plainText;
4+
5+
import com.slack.api.model.block.Blocks;
6+
import com.slack.api.model.block.InputBlock;
7+
import com.slack.api.model.block.element.BlockElements;
8+
9+
/**
10+
* Allows users to select both a date and a time of day.
11+
* {@link https://docs.slack.dev/reference/block-kit/block-elements/datetime-picker-element/}
12+
*/
13+
public class DatetimePicker {
14+
/**
15+
* An input block with a datetime picker element.
16+
*/
17+
public static InputBlock example01() {
18+
InputBlock block =
19+
Blocks.input(i -> i.element(BlockElements.datetimePicker(d -> d.actionId("datetimepicker-action")))
20+
.hint(plainText(pt -> pt.text("This is some hint text").emoji(true)))
21+
.label(plainText(pt -> pt.text("Start date").emoji(true))));
22+
return block;
23+
}
24+
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
package elements;
2+
3+
import static com.slack.api.model.block.composition.BlockCompositions.plainText;
4+
5+
import com.slack.api.model.block.Blocks;
6+
import com.slack.api.model.block.InputBlock;
7+
import com.slack.api.model.block.element.BlockElements;
8+
9+
/**
10+
* Allows user to enter an email into a single-line field.
11+
* {@link https://docs.slack.dev/reference/block-kit/block-elements/email-input-element/}
12+
*/
13+
public class EmailInput {
14+
/**
15+
* An input block with an email input element.
16+
*/
17+
public static InputBlock example01() {
18+
InputBlock block = Blocks.input(i -> i.blockId("input123")
19+
.label(plainText("Email Address"))
20+
.element(BlockElements.emailTextInput(
21+
e -> e.actionId("email_text_input-action").placeholder(plainText("Enter an email")))));
22+
return block;
23+
}
24+
}
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
package elements;
2+
3+
import com.slack.api.model.block.Blocks;
4+
import com.slack.api.model.block.RichTextBlock;
5+
import com.slack.api.model.block.element.RichTextSectionElement;
6+
import java.util.List;
7+
8+
/**
9+
* Displays an emoji.
10+
* {@link https://docs.slack.dev/reference/block-kit/block-elements/emoji-element/}
11+
*/
12+
public class Emoji {
13+
/**
14+
* A rich text block with emoji elements in a section.
15+
*/
16+
public static RichTextBlock example01() {
17+
RichTextBlock block = Blocks.richText(rt -> rt.elements(List.of(RichTextSectionElement.builder()
18+
.elements(List.of(
19+
RichTextSectionElement.Emoji.builder()
20+
.name("basketball")
21+
.build(),
22+
RichTextSectionElement.Text.builder().text(" ").build(),
23+
RichTextSectionElement.Emoji.builder()
24+
.name("snowboarder")
25+
.build(),
26+
RichTextSectionElement.Text.builder().text(" ").build(),
27+
RichTextSectionElement.Emoji.builder()
28+
.name("checkered_flag")
29+
.build()))
30+
.build())));
31+
return block;
32+
}
33+
}

0 commit comments

Comments
 (0)