Proposal: Add ability to hide widgets via config

[mylesj]

👋 Hello, I'm not sure if this warranted an Issue first but it seemed small enough to just raise a PR. I'm happy to add something to the documentation as well if you agree with the proposal.

There are some widgets that I'd rather not be displayed in the sidebar - at the moment these are default widgets for which I cannot see any existing means of omitting them via configuration. I'm proposing a display:hidden field on the widget settings such that I can configure the following:

{
    "defwidget@ai": {
        "display:hidden": true
    }
}

I'm considering this option to be distinct from any means of outright "disabling" the widget - that is to say that I've not chosen to filter the widgets from the configuration because I'm not fully aware of the project goals. Where for example I imagine that it might be useful to be able to interact with a widget or it's config via the CLI or shortcut regardless of visibility?

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

error Error: http://10.0.0.28:4873/@eslint%2fjs: ETIMEDOUT
at Timeout._onTimeout (/opt/yarn-v1.22.22/lib/cli.js:142075:19)
at listOnTimeout (node:internal/timers:594:17)
at process.processTimers (node:internal/timers:529:7)

Walkthrough

The pull request introduces a new feature for conditionally hiding widgets through the addition of a "display:hidden" property across multiple components of the application. This change spans three files: a TypeScript frontend type definition (gotypes.d.ts), a Go configuration struct (settingsconfig.go), and a React component (workspace.tsx).

The modification allows for a boolean flag that can be set to determine whether a widget should be visible or hidden. In the frontend, this is implemented by conditionally setting the display style of a div element based on the widget["display:hidden"] property. The type definition and configuration struct have been updated to support this new property, enabling a flexible mechanism for controlling widget visibility across the application's configuration and rendering layers.

---

📜 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 9db9ef2 and 7f08214.

📒 Files selected for processing (3)

• frontend/app/workspace/workspace.tsx (1 hunks)
• frontend/types/gotypes.d.ts (1 hunks)
• pkg/wconfig/settingsconfig.go (1 hunks)

🔇 Additional comments (3)

frontend/app/workspace/workspace.tsx (1)

81-88: Clean implementation of the widget visibility toggle!

The conditional rendering using CSS display property is well implemented. Using "inherit" as the default maintains the natural document flow, while "none" properly hides the widget.

pkg/wconfig/settingsconfig.go (1)

585-592: Well-structured configuration type definition!

The DisplayHidden field is properly placed with other display-related fields and correctly uses the omitempty tag. The JSON tag matches the frontend usage, maintaining consistency across the stack.

frontend/types/gotypes.d.ts (1)

1215-1215: Consistent type definition across the stack!

The TypeScript type definition correctly mirrors the Go struct field, maintaining type safety and consistency between backend and frontend.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.