rust_block_kit

KO | EN

gitlite — search

#react #ai #llm #rust #linux #nodejs #macos #java #cli #security #pytorch #ios #openai #open-source

(★ 12)

Simple wrapper for Slack API implemented by Rust.

rust_block_kit 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# block_kit

[![Actions Status](https://github.com/horita-yuya/rust-slack/workflows/GitHub%20Actions/badge.svg)](https://github.com/horita-yuya/rust-slack/actions)
[![crate-name at crates.io](https://img.shields.io/crates/v/block_kit.svg)](https://crates.io/crates/block_kit)

Simple wrapper for Slack API, Block Kit and Payloads for Slach Commands and Interactive Components.
Implemented using [serde](https://github.com/serde-rs/serde)

[sample](./examples/interactive_server/main.rs)

#### other samples
- [simple_request](./examples/simple_request/main.rs)
- [simple_serialize](./examples/simple_serialize/main.rs)

## Basic

### 1. load env 
```rust
// export SLACK_BOT_TOKEN=xoxb-your-bot-token
// export SLACK_CHANNEL=random
let config = match from_env::<SlackConfig>() {
     Ok(val) => val,
     Err(err) => {
         error!("{}", err);
         process::exit(1);
     }
 };
```

### 2. setup block payload
```rust
let section = SectionBlock::new(Markdown("@here *Hello World*, `section1`".into()));
let common_payload = CommonMessagePayload::new().blocks(vec![section.into()]);
let payload = ChatPostMessagePayload::new(&config.channel, common_payload);
```

### 3. POST.
Sample with [reqwest](https://github.com/seanmonstar/reqwest)
```rust
let res: PostMessageResponse = reqwest::Client::new()
    .post(CHAT_POST_MESSAGE_URL)
    .header("Authorization", format!("Bearer {}", config.bot_token))
    .json(&payload)
    .send()
    .await
    .unwrap()
    .json()
    .await
    .unwrap();
```

## **Block Kit**
 
- *Block Kit is a UI framework for Slack apps that offers a balance of control and flexibility
when building experiences in messages and other surfaces.*

- *Customize the order and appearance of information and guide users through your app's capabilities 
by composing, updating, sequencing, and stacking blocks — reusable components that work almost everywhere in Slack.*

Quoted from [official docs](https://api.slack.com/block-kit)

### **Structure Overview**

**App Surface** is anywhere an app can express itself throught communication or interaction.
It may have some **Blocks**.

**Block** is a visual component. Blocks can be stacked and arranged to create layouts. 
The essential Block Kit building experience is the same in any surfaces.

Block may have some **Block Elements** and some **Composition Objects**.
The number of elements it can have depends on the type of block. For example,

[Block Elements]
- **Section**: up to 1.
- **Divider**: cannot have.
- **Actions**: up to 5.

[Composition Objects]
- **Section**: some **Texts** in `text` and `fields`.
- **Divider**: cannot have.

**Block Element** is a smaller visual component.
Elements can be used inside of `section`, `context`, `actions` block.
They constitutes a part of **Block**. Element may have some **Composition Objects**.

**Composition Object** is also a visual component, but is smaller than **Block Element**.
It can be used inside of blocks and block elements. And, it may have some **Composition Objects**.

For example,

- **Confirmation dialog**: some **Text** object.
- **Option**: 1 **Text** object.
- **Option group**: 1 **Text** object and some **option** objects up to 100.

*Some sentences are referred by [official docs](https://api.slack.com/web)* 
 
#### [Supported Surfaces](./resources/Surfaces.md)
- [x] Messages
- [ ] Home tab
- [ ] Modals

*view payloads, `Home Tab` and `Modals`, haven't been supported yet, but will be soon.*

#### [Supported Blocks](./resources/Blocks.md)
- [x] Section
- [x] Context
- [x] Actions
- [x] Divider
- [x] Image
- [ ] File
- [ ] Input

#### [Supported Block Elements](./resources/BlockElements.md)

- [x] Button
- [x] Date Picker
- [x] Image
- [x] Multi-select Menu
- [x] Overflow Menu
- [x] Plain-text Input
- [ ] Radio button group
- [x] Select Menus

#### [Supported Composition Objects](./resources/CompositionObjects.md)
- [x] Text
- [x] Confirmation dialog
- [x] Option
- [x] Option group

## [static linking](https://doc.rust-lang.org/1.9.0/book/advanced-linking.html)
As described in [rust-musl-builder](https://github.com/emk/rust-musl-builder).

```shell script
alias rust-musl-builder='docker run --rm -it -v "$(pwd)":/home/rust/src ekidd/rust-musl-builder'
rust-musl-builder cargo build --example interactive_server --release
```

rust_block_kit

rust_block_kit 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

rust_block_kit

rust_block_kit 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README