/ 
Slack-BlockKit-0.001
River stage zero No dependents
⭐ Starred 0 GitHub stars
/ Slack::BlockKit

NAME

Slack::BlockKit - a toolkit for building BlockKit blocks for Slack

VERSION

version 0.001

OVERVIEW

This library is only useful if you're using Slack.

Almost any time you want to send content to Slack that you want to end up in front of a human, you will want to use BlockKit. You can get away without using BlockKit if you're only sending plain text or "mrkdwn" text, but even then, the lack of an escaping mechanism in mrkdwn can be a problem.

The BlockKit system lets you build quite a few different pieces of presentation, but it's fiddly and the error reporting is terrible if you get something wrong. This library is meant to make it easy to write BlockKit content, and to provide client-side validation of constructed blocks with better (well, less awful) errors when you make a mistake.

You probably want to start here: Slack::BlockKit::Sugar. This library exports a bunch of functions that can be combined to produce valid BlockKit structures. Each of those functions will produce an object, or maybe several. You shouldn't really need to build any of those objects by hand, but you can. To find more about the classes shipped with Slack::BlockKit, look at the docs for the Sugar library and follow the links from there.

PERL VERSION

This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

SECRET ORIGINS

This library was written to improve RJBS's Synergy chat bot. You can read more about this process (and the bot) on his blog.

AUTHOR

Ricardo SIGNES <rjbs@semiotic.systems>

COPYRIGHT AND LICENSE

This software is copyright (c) 2024 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.