README.md
# Slack Block Message Kit
[](https://codeclimate.com/github/IyiKuyoro/slack-block-msg-kit/maintainability) [](https://codeclimate.com/github/IyiKuyoro/slack-block-msg-kit/test_coverage) [](https://badge.fury.io/js/slack-block-msg-kit) [](https://circleci.com/gh/IyiKuyoro/slack-block-msg-kit)
This is a simple library that helps build slack block messages and all it's elements. It has robust validations to ensure mistakes are not made with the message formating.
## Table of Content
- [Slack Block Message Kit](#slack-block-message-kit)
- [Table of Content](#table-of-content)
- [How to Use](#how-to-use)
- [Slack Dialogs](#slack-dialogs)
- [Contributors](#contributors)
- [How to Contribute](#how-to-contribute)
## How to Use
Typically you will have setup a slack bot you wish to use in sending messages on slack. This document does not contain any instructions on how to setup a slack bot or how to communicate with the slack API for that mater. The instructions detailed below are to help build the slack message layout blocks that are sent to slack for display.
Install the package as a dependency to get started. `npm i --save slack-block-msg-kit`
To create an interactive message that has the payload to be sent to slack, make use of the [InteractiveMessage](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/InteractiveMessage.md) class. Please note that the interactive message implementation here only supports the slack block kits. Support will be added for the legacy attachments.
Below is a list of all the available blocks, elements and composition objects to be used in crafting your slack messages.
- [Block](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/Blocks/Blocks.md)
> - **[Section](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/Blocks/SectionBlock.md)**
> - **[Image](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/Blocks/ImageBlock.md)**
> - **[Actions](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/Blocks/ActionsBlock.md)**
> - **[Context](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/Blocks/ContextBlock.md)**
> - **[Divider](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/Blocks/Divider.md)**
- [Block Elements](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/BlockElements/BlockElements.md)
> - **[Image](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/BlockElements/ImageElement.md)**
> - **[Button](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/BlockElements/ButtonElement.md)**
> - **[StaticSelect](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/BlockElements/StaticSelectElement.md)**
> - **[ExternalSelect](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/BlockElements/ExternalSelectElement.md)**
> - **[UserSelect](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/BlockElements/UserSelectElement.md)**
> - **[ConversationSelect](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/BlockElements/ConversationSelectElement.md)**
> - **[ChannelSelect](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/BlockElements/ChannelSelectElement.md)**
> - **[OverflowMenu](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/BlockElements/OverflowMenuElement.md)**
> - **[DatePicker](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/BlockElements/DatePickerElement.md)**
- [Composition Objects](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/CompositionObjects/CompositionObjects.md)
> - **[Text](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/CompositionObjects/Text.md)**
> - **[Confirmation Dialog](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/CompositionObjects/ConfirmationDialog.md)**
> - **[Option](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/CompositionObjects/Option.md)**
> - **[OptionGroup](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/CompositionObjects/OptionGroup.md)**
### Slack Dialogs
Dialogs are a very convenient way of collecting information on slack. We have included a dialog class together with all supporting element to aid the creation of dialogs and elements in your codebase. Here is a list to the documentation of the dialog and all the elements.
- **[Dialog](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/FeatureElements/Dialog.md)**
- **[DialogTextElement](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/FeatureElements/DialogTextElement.md)**
- **[DialogTextareaElement](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/FeatureElements/DialogTextareaElement.md)**
- **[DialogSelectElement](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/FeatureElements/DialogSelectElement.md)**
- **[DialogSelectOption](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/FeatureElements/DialogSelectOption.md)**
- **[DialogSelectOptionGroup](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/master/docs/FeatureElements/DialogSelectOptionGroup.md)**
## Contributors
- [Opeoluwa Iyi-Kuyoro](https://github.com/IyiKuyoro): 👨🏿(Creator)
- [Akinremi Olumide](https://github.com/akinmyde): 👨🏿(Contributor)
## How to Contribute
[Here](https://github.com/IyiKuyoro/slack-block-msg-kit/blob/develop/HOW_TO_CONTRIBUTE.md) is a little help with that.