Skip to content

fix: Updating the UX for hidden pages #40322

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.

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

Merged
merged 2 commits into from
Apr 21, 2025
Merged

Conversation

ankitakinger
Copy link
Contributor

@ankitakinger ankitakinger commented Apr 21, 2025

Description

Updating the UX for hidden pages which is breaking on v1.68. The user is no longer able to select the hidden pages, to edit the same in edit mode. This is being fixed in this PR.

Fixes #40321

Automation

/ok-to-test tags="@tag.IDE"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/14569833575
Commit: 76d359c
Cypress dashboard.
Tags: @tag.IDE
Spec:


Mon, 21 Apr 2025 08:31:16 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Added support for visually dimming list items marked as subtle, making entity names and icons appear subdued.
  • Style

    • Updated styling to apply a subtle visual treatment to list items flagged as subtle, enhancing UI clarity.
  • Refactor

    • Replaced the disabled state indicator with a subtle style indicator for representing hidden pages in the list.

@ankitakinger ankitakinger requested a review from a team as a code owner April 21, 2025 06:54
@ankitakinger ankitakinger requested review from hetunandu and removed request for a team April 21, 2025 06:54
Copy link
Contributor

coderabbitai bot commented Apr 21, 2025

Walkthrough

This change introduces a new optional boolean prop isSubtle to the ListItem component and its type definition. The ListItem component now adds a data-subtle attribute to its root element based on this prop. Corresponding CSS rules apply a subtle foreground color to the entity name and icon when the list item is marked as subtle. In the page entity list, the prop passed to EntityItem is changed from isDisabled={page.isHidden} to isSubtle={page.isHidden}, reflecting a visual subtlety rather than a disabled state. No other logic or exports were modified.

Changes

File(s) Change Summary
.../design-system/ads/src/List/List.types.tsx Added optional isSubtle?: boolean property to ListItemProps interface.
.../design-system/ads/src/List/List.tsx ListItem passes data-subtle attribute to StyledListItem based on isSubtle prop.
.../design-system/ads/src/List/List.styles.tsx Added CSS rules to style .t--entity-name and .ads-v2-icon with subtle foreground color when data-subtle="true".
.../src/pages/AppIDE/components/PageList/PageEntity.tsx Changed prop from isDisabled={page.isHidden} to isSubtle={page.isHidden} for EntityItem.

Assessment against linked issues

Objective Addressed Explanation
Allow hidden pages to be selected and edited in edit mode (#40321)

Poem

🎨 A subtle shade, not disabled,
Hidden pages now styled and styled,
Entity names and icons light,
Softly dimmed, but still in sight.
With isSubtle set just right,
The UI glows with gentle light. ✨


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 62e43ca and 76d359c.

📒 Files selected for processing (4)
  • app/client/packages/design-system/ads/src/List/List.styles.tsx (1 hunks)
  • app/client/packages/design-system/ads/src/List/List.tsx (1 hunks)
  • app/client/packages/design-system/ads/src/List/List.types.tsx (1 hunks)
  • app/client/src/pages/AppIDE/components/PageList/PageEntity.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • app/client/src/pages/AppIDE/components/PageList/PageEntity.tsx
  • app/client/packages/design-system/ads/src/List/List.types.tsx
  • app/client/packages/design-system/ads/src/List/List.tsx
  • app/client/packages/design-system/ads/src/List/List.styles.tsx
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-build / client-build
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-prettier / prettier-check
  • GitHub Check: chromatic-deployment
  • GitHub Check: chromatic-deployment
  • GitHub Check: storybook-tests

🪧 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 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.

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.

@ankitakinger ankitakinger added the ok-to-test Required label for CI label Apr 21, 2025
@github-actions github-actions bot added Bug Something isn't working High This issue blocks a user from building or impacts a lot of users IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Needs Triaging Needs attention from maintainers to triage Production Query Widgets & IDE Pod All issues related to Query, JS, Eval, Widgets & IDE labels Apr 21, 2025
Copy link
Member

@hetunandu hetunandu left a comment

Choose a reason for hiding this comment

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

I don't think "hidden" property translates into ADS correctly here. We should just remove the disabled prop from the Entity item when the page is hidden.

As for the different styles for hidden, we should create a different generic prop to allow for this

@ankitakinger
Copy link
Contributor Author

@hetunandu I already removed disabled prop from the Entity item when the page is hidden. And I'm handling the different styles for hidden using isHidden prop. If you think we should name it differently, then let me know what you have in mind.

@ankitakinger ankitakinger requested a review from hetunandu April 21, 2025 08:02
@ankitakinger ankitakinger enabled auto-merge (squash) April 21, 2025 08:03
@ankitakinger ankitakinger merged commit 5ace9ba into release Apr 21, 2025
52 checks passed
@ankitakinger ankitakinger deleted the fix/hidden-pages-ux branch April 21, 2025 08:31
ankitakinger added a commit that referenced this pull request Apr 22, 2025
## Description

Fixing the page actions spec that was failing after
[#40322](#40322) merge

Fixes #

## Automation

/ok-to-test tags="@tag.IDE"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/14587020719>
> Commit: d46229a
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=14587020719&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.IDE`
> Spec:
> <hr>Tue, 22 Apr 2025 05:28:28 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Tests**
- Updated test assertions to check the "data-subtle" attribute instead
of "data-disabled" when verifying the UI state of hidden pages.
  - Added a tag to the test suite for improved categorization.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working High This issue blocks a user from building or impacts a lot of users IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Needs Triaging Needs attention from maintainers to triage ok-to-test Required label for CI Production Query Widgets & IDE Pod All issues related to Query, JS, Eval, Widgets & IDE
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Hidden pages are not allowed to be selected and edited in edit mode
2 participants