QoL for Ghost Role UI
Description
Ports over collapsible ghost role user interface, alongside making the ghost roles button red only when count increases from last view. Video under media.
Media
https://github.com/user-attachments/assets/c23ca06d-a4ef-413d-be3a-6980b456e5f3
Changelog
:cl:
- tweak: Ported over ghost role UI QoL
Walkthrough
A significant refactor and enhancement of the ghost roles user interface has been carried out. The update introduces new XAML layout and code-behind files, restructures existing UI components, and implements collapsible sections for grouped roles. The logic for handling role button states and UI updates has been improved, including tracking the expanded/collapsed state of role groups and refining button styling based on role availability. Localization has been updated to support dynamic role counts. Several classes and files were renamed or split to better organize the UI structure.
Changes
| File(s) | Change Summary |
|---|---|
| Content.Client/UserInterface/Systems/Ghost/Controls/Roles/GhostRoleButtonsBox.xaml Content.Client/UserInterface/Systems/Ghost/Controls/Roles/GhostRoleButtonsBox.xaml.cs |
Added new UI layout and code-behind for a box container to hold dynamically generated ghost role buttons. Introduced class GhostRoleButtonsBox with updated constructor parameters and logic. |
| Content.Client/UserInterface/Systems/Ghost/Controls/Roles/GhostRoleInfoBox.xaml Content.Client/UserInterface/Systems/Ghost/Controls/Roles/GhostRoleInfoBox.xaml.cs |
Added new UI layout and control class GhostRoleInfoBox to display a role's title and description, separated by a divider. |
| Content.Client/UserInterface/Systems/Ghost/Controls/Roles/GhostRolesEntry.xaml | Removed the old UI layout file for ghost roles entry, which previously combined title, description, and buttons into a single container. |
| Content.Client/UserInterface/Systems/Ghost/Controls/Roles/GhostRoleEntryButtons.xaml | Updated layout for role entry buttons: switched from fixed widths to flexible, proportionally expanding buttons using stretch flags. |
| Content.Client/UserInterface/Systems/Ghost/Controls/Roles/GhostRolesEui.cs | Modified HandleState to save and restore collapsible box states during UI updates, maintaining user context. Added a comment regarding role grouping by requirements. |
| Content.Client/UserInterface/Systems/Ghost/Controls/Roles/GhostRolesWindow.xaml.cs | Refactored to support collapsible containers for role groups, added methods to save/restore collapsible states, and restructured entry addition logic to use new UI components. |
| Content.Client/UserInterface/Systems/Ghost/Widgets/GhostGui.xaml.cs | Added tracking for previous role count, adjusted logic for applying/removing the danger style class to the roles button, and updated event handling for button presses. |
| Resources/Locale/en-US/ghost/ghost-gui.ftl | Added a new localization string for displaying available roles with a dynamic count. |
Poem
Ghost roles march in tidy rows,
With collapsible boxes, the UI now glows!
Buttons stretch wide, no longer confined,
Each title and description neatly aligned.
Tau Ceti’s order, Sol’s chaos denied—
Our code stands proud, with nothing to hide!
🪐✨
[!TIP]
⚡💬 Agentic Chat (Pro Plan, General Availability)
- We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
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.
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
@Timfa2112 Unable to replicate the issue, the _prevNumberRoles is already updated in the Update function, which does include it being lowered. The video in media also has a case where the count decreases and the button still goes red if it increases by one but less than the maximum total. Am I failing the understand the issue here? The only issue I see with this system is if a single new ghostrole is added while an old one is removed at the same instant, then the system might fail to update as the count will remain same.