Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add documentation how to listen to view_closed events #1010 #1214

Merged

Conversation

TheManWhoStaresAtCode
Copy link
Contributor

@TheManWhoStaresAtCode TheManWhoStaresAtCode commented Nov 18, 2021

Summary

Fix #1010 Add documentation how to handle view_closed events as requested by #1010.

Requirements (place an x in each [ ])

@codecov
Copy link

codecov bot commented Nov 18, 2021

Codecov Report

Merging #1214 (f86fdda) into main (3e8a0f9) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1214   +/-   ##
=======================================
  Coverage   73.20%   73.20%           
=======================================
  Files          17       17           
  Lines        1437     1437           
  Branches      431      431           
=======================================
  Hits         1052     1052           
  Misses        300      300           
  Partials       85       85           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3e8a0f9...f86fdda. Read the comment docs.

@srajiang srajiang added the docs M-T: Documentation work only label Nov 18, 2021
@srajiang srajiang added this to the 3.9.0 milestone Nov 18, 2021
Copy link
Member

@srajiang srajiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @TheManWhoStaresAtCode - thank you for submitting this improvement to the docs!
I have done a first pass, and left some comments to help standardize the language.

docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
* implement review comments

Co-authored-by: Sarah Jiang <srajiang@gmail.com>
Copy link
Member

@srajiang srajiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking great. A few minor things (responding to your comment as well) and I think we should be all set.


---

##### Update views on submission

You can access the value of the input blocks by accessing the `state` object. `state` contains a values object that uses the `block_id` and unique `action_id` to store the input values.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's relevant to view_submission still, but it looks like some similar language is now incorporated on line 12 there anyway after your edits. Nice! So I think we could move this underneath the code sample with this current section too.

docs/_basic/listening_modals.md Outdated Show resolved Hide resolved
@TheManWhoStaresAtCode
Copy link
Contributor Author

Just to be sure: My current understanding is that all you requests are solved now and there is nothing to do from my side. If not please tell me what else needs to be adjusted.

@filmaj filmaj merged commit b8a58da into slackapi:main Nov 23, 2021
@filmaj
Copy link
Contributor

filmaj commented Nov 23, 2021

Thanks for your work @TheManWhoStaresAtCode !

@TheManWhoStaresAtCode TheManWhoStaresAtCode deleted the view_closed_documentation_1010 branch November 23, 2021 16:56
@TheManWhoStaresAtCode
Copy link
Contributor Author

hmm unfortunatly the code example for the view_closed event is not displayed properly - https://slack.dev/bolt-js/concepts#view-submissions 🤔

@filmaj
Copy link
Contributor

filmaj commented Nov 23, 2021

Hmm you are right. I tried playing around with the markdown structure / "section content" div, but it looks like we can only have one right "sidebar" example code per markdown page (otherwise they overlap, like you see on the live page). Maybe we can try to break out the view closed event and example into its own markdown page?

@filmaj
Copy link
Contributor

filmaj commented Nov 23, 2021

I pushed up a fix in 4158bc5 - should be live shortly.

@TheManWhoStaresAtCode
Copy link
Contributor Author

thanks @filmaj - style is still a little bit broken but at least the code blocks are now available

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for view_closed support in bolt
4 participants