Giter Club home page Giter Club logo

slackalo's Introduction

Maven Central



A Kotlin library to build and send Slack messages via Slack webhook

Dependency

Slackalo is available in maven central

dependencies {
    implementation 'com.gianluz:slackalo:1.0'
}

Introduction

Build your custom slack message just using the builder utils provided. Checkout the official Slack Block Kit Builder here Slackalo doesn't provide all the blocks right now, but you can contribute to make it more complete! Here you can find a list of what currently Slackalo support:

  • Section as PlainText or MarkdownText only
  • Image as ImageBlock
  • Section with Fields as FieldsBlock
  • Section with Image as ImagePlainTextBlock or ImageMarkdownBlock
  • Divider as Divider

Usage

To create a slack webhook url please follow the official slack app guide here

Here an example:

val message = slackMessage {
    blocks {
        plainText("Hello this is a plaintext")
        markdown("Hello this is a markdown")
        divider()
        imageMarkdown(
            ":warning: This is a message with an image and slack emoji",
             "https://api.slack.com/img/blocks/bkb_template_images/palmtree.png",
             "alt text"
        )
        divider()
        fields { 
            markdown("Field 1")
            markdown("Field 2")
            markdown("Field 3")
        }
    }
}
    
with(DefaultWebHookClient()) {
    sendWebHook("MySlackWebHookUrl", message)
}

Contribute

Please fork this repo, and add all the new functionalities you would like to have and open a Pull request!

slackalo's People

Contributors

gianluz avatar

Stargazers

Lukmannudin avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.