Skip to content

Provides reusable Slack blocks used to create views for modal/messages/app homes for any slack app.

Notifications You must be signed in to change notification settings

SpringRole/block-kit-builder

Repository files navigation

@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.

About

Provides reusable Slack blocks used to create views for modal/messages/app homes for any slack app.

Resources

Stars

Watchers

Forks

Packages