Skip to content

Add icon argument to smartblock buttons#134

Merged
mdroidian merged 5 commits intomainfrom
cursor/add-icon-argument-to-smartblock-buttons-4cec
Jul 28, 2025
Merged

Add icon argument to smartblock buttons#134
mdroidian merged 5 commits intomainfrom
cursor/add-icon-argument-to-smartblock-buttons-4cec

Conversation

@mdroidian
Copy link
Copy Markdown
Collaborator

@mdroidian mdroidian commented Jul 25, 2025

Add Icon argument to SmartBlock Buttons for per-button icon customization or disabling.

This allows users to specify icon=false or icon=none to hide the icon, or icon=<blueprint-name> to use a specific Blueprint.js icon. This per-button setting overrides the global "Hide Button Icon" configuration.

https://blueprintjs.com/docs/versions/3/#icons

image

Summary by CodeRabbit

  • New Features

    • SmartBlock buttons now support customizable icons. Users can specify a Blueprint.js icon, hide the icon, or use the default Lego icon via the Icon parameter.
    • A global setting is available to hide all SmartBlock button icons.
  • Documentation

    • Updated documentation to describe the new Icon parameter for SmartBlock buttons, including usage examples and global override behavior.
  • Chores

    • Increased the package version to 1.11.0.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jul 25, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The updates introduce a new customizable icon feature for SmartBlock buttons, allowing users to specify or hide the icon via the Icon variable or global settings. Documentation is updated to describe this option. Additionally, the package version is incremented, and internal logic is refactored to parse button arguments earlier and handle icon rendering accordingly.

Changes

Cohort / File(s) Change Summary
Documentation
docs/060-alternative-methods.md
Added documentation for the new Icon variable, usage examples, and clarification of precedence rules.
Package Metadata
package.json
Updated package version from 1.10.0 to 1.11.0.
Core Logic
src/index.ts
Refactored argument parsing, added logic for customizable/hidable button icons, and integrated BlueprintJS icon support.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Button
    participant SmartBlockHandler
    participant IconRenderer

    User->>Button: Click
    Button->>SmartBlockHandler: Parse arguments (incl. Icon)
    SmartBlockHandler->>IconRenderer: Determine icon (based on Icon/global settings)
    IconRenderer-->>Button: Render icon (custom, default, or none)
    SmartBlockHandler-->>Button: Execute SmartBlock logic
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Poem

🐰
A button with flair, now dons a new face,
With icons that sparkle or none in their place.
Docs tell the story, the version ascends,
Blueprint or Lego, the choice never ends.
A hop and a skip—review’s nearly done,
SmartBlocks look smarter, and buttons more fun!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 83b1f77 and 79d790d.

📒 Files selected for processing (1)
  • docs/060-alternative-methods.md (2 hunks)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch cursor/add-icon-argument-to-smartblock-buttons-4cec

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

…handling in code

- Corrected capitalization of the `icon` parameter to `Icon` in documentation.
- Enhanced examples to reflect the updated parameter name.
- Refactored icon handling logic in the code to validate Blueprint icon names and improve icon display logic.
- Adjusted default icon display behavior based on the new parameter structure.
@mdroidian
Copy link
Copy Markdown
Collaborator Author

@CodeRabbit full review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jul 27, 2025

✅ Actions performed

Full review triggered.

@mdroidian mdroidian marked this pull request as ready for review July 27, 2025 06:53
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/060-alternative-methods.md (1)

113-131: Convert emphasized text to a proper heading and fix icon-description mismatches
MD036 is flagging **Examples** (line 117) because bold text is being used as a heading. Use a heading level that matches prior sections (#### Examples).
While touching the block, correct the example descriptions – clipboard is not a “user” icon and refresh is not a “settings” icon.

-**Examples**
+#### Examples
 ...
-- `{{Today:SmartBlock:myWorkflow:Icon=clipboard}}` - Display a Blueprint.js user icon
-- `{{Today:SmartBlock:myWorkflow:Icon=refresh}}` - Display a Blueprint.js settings icon
+- `{{Today:SmartBlock:myWorkflow:Icon=clipboard}}` - Display the Blueprint.js “clipboard” icon
+- `{{Today:SmartBlock:myWorkflow:Icon=refresh}}`   - Display the Blueprint.js “refresh” icon
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e665ca7 and 83b1f77.

📒 Files selected for processing (1)
  • docs/060-alternative-methods.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/060-alternative-methods.md

117-117: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

@mdroidian mdroidian merged commit e4c62f7 into main Jul 28, 2025
1 of 3 checks passed
@mdroidian mdroidian deleted the cursor/add-icon-argument-to-smartblock-buttons-4cec branch July 28, 2025 05:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants