Skip to content

fix(types): allow mrkdwn descriptions on checkbox and radio button options - #2825

Draft
zimeg wants to merge 1 commit into
mainfrom
types-option-mrkdwn-description
Draft

zimeg wants to merge 1 commit into
mainfrom
types-option-mrkdwn-description

Conversation

@zimeg

@zimeg zimeg commented Nov 5, 2026 •

Copy link
Copy Markdown
Member

Summary

This pull request lets a checkboxes or radio buttons option use a mrkdwn description, as the option object and checkboxes element docs show. Until now, the docs payload (a plain_text option text with a mrkdwn description) failed to compile.

Closes #1765.

  • MrkdwnOption (used by Checkboxes and RadioButtons) now takes a plain_text or mrkdwn text and description.
  • PlainTextOption (used by overflow, select, and multi-select menus) keeps a plain_text-only description, as the docs require.
  • Adds tsd cases: checkboxes and radio buttons accept a mrkdwn description, and overflow and static select reject one.
  • Supersedes feat(types): allow mrkdwn descriptions on checkbox and radio button options #2742, which widened description but kept MrkdwnOption.text as mrkdwn-only, so the docs payload still failed to compile there.

Testing

  1. Run npm test --workspace=packages/types and confirm tsd passes.
  2. Revert packages/types/src/block-kit/composition-objects.ts and confirm the new checkboxes and radio buttons cases fail.

Requirements

🤖 Generated with Claude Code

@zimeg zimeg added this to the types@next milestone Nov 5, 2026
@zimeg zimeg added bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented semver:patch pkg:types applies to `@slack/types` labels Nov 5, 2026
@zimeg zimeg self-assigned this Nov 5, 2026
@changeset-bot

changeset-bot Bot commented Nov 5, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 234c663

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@slack/types Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@codecov

codecov Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.82%. Comparing base (822f6a4) to head (234c663).
⚠️ Report is 3 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2825      +/-   ##
==========================================
- Coverage   93.89%   93.82%   -0.08%     
==========================================
  Files          66       66              
  Lines       10571    10571              
  Branches      611      611              
==========================================
- Hits         9926     9918       -8     
- Misses        609      617       +8     
  Partials       36       36              
Flag Coverage Δ
cli-hooks 93.75% <ø> (ø)
cli-test 93.75% <ø> (ø)
logger 93.75% <ø> (ø)
oauth 93.75% <ø> (ø)
socket-mode 93.75% <ø> (ø)
web-api 93.75% <ø> (ø)
webhook 93.75% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented pkg:types applies to `@slack/types` semver:patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document inconsistency: checkboxes block element's description can have both plain_text and mrkdwn

1 participant