Skip to content
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

feat: On Canvas UI Colors and Widget API to consume these colors #33013

Merged
merged 3 commits into from
May 1, 2024

Conversation

riodeuno
Copy link
Contributor

@riodeuno riodeuno commented Apr 29, 2024

Description

  • Create a new set of configurations that can be added to any widget that will configure the following:
    • Selection state colors
    • Focused state colors
    • If the parent widget can be toggled from the widget's widget name component.
  • Create a default configuration to use if widget hasn't specified the colors
  • Add CSS color variables for the current selection and focused states
  • Add configuration to zone, section and modal widgets.

Fixes #33075

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/8897891359
Commit: 85cdd6b
Cypress dashboard url: Click here!

Communication

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

  • Yes
  • No

@github-actions github-actions bot added the Enhancement New feature or request label Apr 29, 2024
@riodeuno riodeuno self-assigned this Apr 29, 2024
@riodeuno
Copy link
Contributor Author

riodeuno commented Apr 29, 2024

@riodeuno
Note: We've updated the main container resizer z-index. Let's confirm if this works in the final PR.

@riodeuno riodeuno added Anvil Pod Issue related to Anvil project Anvil team issues related to the new layout system anvil ok-to-test Required label for CI labels Apr 30, 2024
@github-actions github-actions bot added the Task A simple Todo label Apr 30, 2024
@riodeuno riodeuno marked this pull request as ready for review April 30, 2024 15:55
@riodeuno riodeuno requested a review from a team as a code owner April 30, 2024 15:55
@riodeuno riodeuno added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Apr 30, 2024
Copy link
Contributor

coderabbitai bot commented Apr 30, 2024

Warning

Rate Limit Exceeded

@riodeuno has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 9 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 3f222e5 and 85cdd6b.

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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@@ -114,6 +129,7 @@ class WidgetFactory {
needsHeightForContent: config.needsHeightForContent,
isSearchWildcard: config.isSearchWildcard,
needsErrorInfo: !!config.needsErrorInfo,
onCanvasUI,
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder why do we want it to be a part of widget config. since the config is used only by an editor component.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure what your concern is. Widgets owning configurations specific to the editor seem like a perfectly fine approach.
If you can share an alternative, it will help me understand your viewpoint.

Copy link
Contributor

Choose a reason for hiding this comment

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

since the scope of using the config is only on the editor component and also for Anvil. The current widget name and how it figures out the parent all this will not be relavants with other layout systems which leads me to belive that we will keep widget name as is in those systems. which is why I think we should just use the getWidgetHierarchy to get the hierarchy of a widget and just set the color system of the widget name component.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. WidgetHierarchy is the most straightforward change.
However, there are multiple reasons for using an API approach.

  • It may be used by UI modules for module widgets.
  • It loosely coupled and keeps the ownership of configurations with the widgets.

The only con that I see is that it will store this configurations in the DSL, but for that we'll be picking up #21825 in the upcoming sprint.

Copy link
Contributor

Choose a reason for hiding this comment

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

approving this.
however I still think the change in color codes is not based on individual widgets but is clearly based on hierarchy which exclusively only makes sense in Anvil.


/**
* As this will make all layout system widgets have these properties.
* We're going to prioritise #21825.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@riodeuno riodeuno requested a review from marks0351 May 1, 2024 06:31
@riodeuno riodeuno merged commit f62d998 into release May 1, 2024
43 checks passed
@riodeuno riodeuno deleted the feat/on-canvas-ui-colors branch May 1, 2024 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Anvil Pod Issue related to Anvil project Anvil team issues related to the new layout system anvil Enhancement New feature or request ok-to-test Required label for CI Task A simple Todo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Widget Dev API to provide on-canvas UI colors
2 participants