docs: align Block Kit surface metadata with Slack's blocks.json#95
Merged
Conversation
Reconciles the surface JSDoc against Slack's canonical https://docs.slack.dev/blocks.json (ENG-5107): - alert: Messages → Modals - card: Messages → Modals, Messages, Home tabs - carousel: Messages → Messages, Home tabs - table: Messages → Messages, Home tabs - add missing surface JSDoc for context_actions, markdown, plan, task_card - document why data_table is intentionally not modeled Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
👋 Thanks for the PR, @StephenTangCook! You can try these changes live, before any release — no install needed. 🛝 Playground: https://slack-block-to-jsx-playground.vercel.app/ Paste the build URL into the Library package field (or hit the pkg.pr #95 preset) and click Load build — your blocks render against this exact PR. 🎉 |
commit: |
…esting) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
StephenTangCook
commented
Jul 1, 2026
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Reconciles the Block Kit surface JSDoc in
src/types/layout.tsagainst Slack's canonical blocks.json. Resolves ENG-5107.Pure documentation change — no runtime behavior changes.
tscpasses.Corrected surfaces
alertcardcarouseltableAdded missing surface JSDoc
context_actions,markdown,plan,task_card— all Messages per canonical, previously had no surface docs.data_tableIntentionally not modeled/rendered. Documented the decision inline near the
Blockunion: it relies on interactive pagination/sorting/filtering this static renderer cannot reproduce, so it is out of scope until a caller actually needs it (canonical surfaces recorded in the comment for whoever picks it up).Verified against blocks.json
All other blocks (
container,data_visualization,file, and the Modals/Messages/Home-tabs set) already matched canonical — left untouched.🤖 Generated with Claude Code