Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 1.09 KB

README.md

File metadata and controls

46 lines (37 loc) · 1.09 KB
Raw

@springrole/block-kit-builder

Getting started

This is a simple package that can be used to create the blocks and views required to interact with users on any Slack surface. This is based on Slack's own Block Kit Builder.

Installation

 npm install --save @springrole/block-kit-builder

Usage

const BlockKitBuilder = require("@springrole/block-kit-builder");

const blocks = BlockKitBuilder.Blocks.markdown({
  text: "Hello world!",
  blockId: "hello_block",
  ...BlockKitBuilder.Accessory.button({
    text: "Click me!",
    style: "primary",
    actionId: "click",
    value: "something",
  }),
});

// OR

const { Blocks, Accessory } = require("@springrole/block-kit-builder");
const blocks = Blocks.markdown({
  text: "Hello world!",
  blockId: "hello_block",
  ...Accessory.button({
    text: "Click me!",
    style: "primary",
    actionId: "click",
    value: "something",
  }),
});

License

@springrole/block-kit-builder is licensed under the MIT License.