0.0
No commit activity in last 3 years
No release in over 3 years
Slack BlockKit Helper
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0
>= 0
~> 10.0
~> 3.0
~> 0.18
 Project Readme

Slack::BlockKit

This is a helper for producing Blocks you'd expect in BlockKit.

Installation

Add this line to your application's Gemfile:

gem 'slack-block-kit'

And then execute:

$ bundle

Or install it yourself as:

$ gem install slack-block-kit

Usage

Require the gem using:

require 'slack-block-kit'

Include the execution context DSL:

include Slack::BlockKit::ExecutionContext

Then you can construct your blocks as you want:

require 'slack-ruby-client'

client = Slack::Web::Client.new

blocks = [
  SectionBlock[text: Text[mrkdwn: "Hello, #{Bold['World!']}"]]
]

client.chat_postMessage(
  channel: '#general'
  blocks: blocks.map(&:to_h)
)

The current examples that Slack's BlockKit Builder provides have been reproduced under examples.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/saraid/slack-block-kit.