Adding Input Block Support for Modals

[ruberVulpes]

Description

Describe your issue here.

What type of issue is this? (place an x in one of the [ ])

• bug
• enhancement (feature request)
• question
• documentation related
• testing related
• discussion

Requirements (place an x in each of the [ ])

• I've read and understood the Contributing guidelines and have done my best effort to follow them.
• I've read and agree to the Code of Conduct.
• I've searched for any related issues and avoided creating a duplicate issue.

---

Enhancement

Slack just announced modals today. With these came input blocks. I was hoping to get support for the creation of these blocks in /slack/web/classes/blocks.py or possibly a new /slack/web/classes/modals.py similar to /slack/web/classes/dialogs.py.

[shollingsworth]

I'd love to be able to use this with interactive as well! Thanks for the great library all :)

[seratch]

👋 slackclient 2.6.0rc1 is out. The pre-release version contains fixes for your issue described here.
https://pypi.org/project/slackclient/2.6.0rc1/

One week later from now, we'll be releasing version 2.6.0 to PyPI.

If you have a chance, could you try the release candidate version out and let us know your feedback? Thank you very much for being patient with this issue.

[ruberVulpes]

Sounds good, I'll try to give it a go this weekend. I looked over the source and it looked good to me. Thanks so much.

[ruberVulpes]

I was able to get it working, I'll drop the code snippet I used to test it below.

def open_modal(command: SlashCommandInteractiveEvent):
    title = PlainTextObject(text="Color Survey")
    color_input_blocks = [InputBlock(label=PlainTextObject(text="What is your favorite color?"),
                                     element=PlainTextInputElement(placeholder="Green")),
                          InputBlock(label=PlainTextObject(text="Why is that your favorite color?"),
                                     element=PlainTextInputElement(placeholder="It reminds me of my childhood home"),
                                     optional=True)]
    modal = views.View(type="modal", title=title, blocks=color_input_blocks, submit="Submit")
    slack_client.views_open(trigger_id=command.trigger_id, view=modal.to_dict())

If this looks like good usage I wouldn't mind adding it to the documentation for the usage of the message and dialog builders.

I did have some problems getting started at first. The only suggestion I have is to make the type argument in the init of View to be required, I was getting this error The server responded with: {'ok': False, 'error': 'invalid_arguments', 'response_metadata': {'messages': ['[ERROR] failed to match all allowed schemas [json-pointer:/view]', '[ERROR] missing required field: type [json-pointer:/view]']}} at first and was unsure what was causing it. I took a peek at the tests in test_views.py and I wasn't sure if it was needed because the testes seemed to be validating the to_dict() mainly. I eventually figured it out from the "modal", "home" comment .

I'm also unsure about when I would use View vs ViewState or ViewStateValue, but this may just be my unfamiliarity with Views.

Overall I'm very happy with the additions and I'm excited to use it to implement App Homes or Modals.

[seratch]

@ruberVulpes Thanks! I've revisited the View class:

• Added a few more validations to View class
• Updated WebClient#views_open method to accept a View object
• Added another working example with the builder class: https://github.com/slackapi/python-slackclient/blob/6080f1ed0d1e96a51edca3d34ab95ec58fee56dc/integration_tests/samples/basic_usage/views_2.py

If you have more feedback, access my pull request #689 and feel free to leave comments there. I will be merging the PR within a few days.

If this looks like good usage I wouldn't mind adding it to the documentation for the usage of the message and dialog builders.

I'm not going to maintain the README file. We'll be removing those files and will update the documents much more.