Skip to content

fix(types): update context_actions jsdoc link to a single icon_button #2375

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.

Sign up for GitHub

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

Jump to bottom
Merged
zimeg merged 5 commits into from
Sep 23, 2025
Merged

fix(types): update context_actions jsdoc link to a single icon_button #2375

zimeg merged 5 commits into from
Sep 23, 2025

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Sep 20, 2025

Summary

This PR updates JSDoc reference to a single IconButton for the context_actions block "elements" attribute:

node-slack-sdk/packages/types/src/block-kit/block-elements.ts

Lines 210 to 217 in bd62ff4

/**
* @description An icon button to perform actions.
*/
export interface IconButton extends Actionable, Confirmable {
/**
* @description The type of element. In this case `type` is always `file_input`.
*/
type: 'icon_button';

Requirements

@zimeg zimeg requested review from mwbrooks and srtaalej September 20, 2025 19:33
@zimeg zimeg self-assigned this Sep 20, 2025
@zimeg zimeg added bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented docs M-T: Documentation work only semver:patch pkg:types applies to `@slack/types` labels Sep 20, 2025
@codecov
Copy link

codecov bot commented Sep 20, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (ai-apps@bd62ff4). Learn more about missing BASE report.
✅ All tests successful. No failed tests found.

Additional details and impacted files 
@@            Coverage Diff             @@
##             ai-apps    #2375   +/-   ##
==========================================
  Coverage           ?   92.78%           
==========================================
  Files              ?       39           
  Lines              ?    10711           
  Branches           ?      692           
==========================================
  Hits               ?     9938           
  Misses             ?      761           
  Partials           ?       12
Flag Coverage Δ
cli-hooks 95.23% <ø> (?)
cli-test 94.80% <ø> (?)
oauth 77.39% <ø> (?)
socket-mode 61.87% <ø> (?)
web-api 98.00% <ø> (?)
webhook 96.66% <ø> (?)

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.

@zimeg zimeg changed the title fix(types): update jsdoc link to a single icon button fix(types): update context_actions jsdoc link to a single icon_button Sep 20, 2025
mwbrooks
mwbrooks approved these changes Sep 22, 2025
View reviewed changes
Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

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

✅ Looking good to me!

✏️ Personally, I think you can remove the bug label and keep this focused on the docs label.

packages/types/src/block-kit/blocks.ts
type: 'context_actions';
/**
* @description An array of {@link FeedbackButtons} or {@link IconButtons} objects.
* @description An array of {@link FeedbackButtons} or {@link IconButton} block elements. Maximum number of items is 5.
Copy link
Member

@mwbrooks mwbrooks Sep 22, 2025

Choose a reason for hiding this comment

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

note: That tricky pluralization!

Copy link
Member Author

@zimeg zimeg Sep 23, 2025

Choose a reason for hiding this comment

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

@mwbrooks I agree but I suppose in a collection of elements it finds sense? 👾 ✨

@zimeg zimeg removed the bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented label Sep 23, 2025
@zimeg
Copy link
Member Author

zimeg commented Sep 23, 2025

@mwbrooks Ooh great call that this wasn't an update to application logic 🧠

I believe for now this'll align with python types but we should revisit this once documentation is finalized on the topic IMHO 📚

Let's merge this for now.

@zimeg zimeg merged commit fc9c326 into ai-apps Sep 23, 2025
57 checks passed
@zimeg zimeg deleted the zimeg-fix-types-icon-button-ref branch September 23, 2025 04:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mwbrooks mwbrooks mwbrooks approved these changes

@srtaalej srtaalej Awaiting requested review from srtaalej

Assignees

@zimeg zimeg

Labels

docs M-T: Documentation work only pkg:types applies to `@slack/types` semver:patch

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@zimeg @mwbrooks