appsmithorg / appsmith

Platform to build admin panels, internal tools, and dashboards. Integrates with 25+ databases and any API.
https://www.appsmith.com
Apache License 2.0
34.66k stars 3.75k forks source link

chore: add header to sidebar + add full width state #37597

Closed jsartisan closed 1 day ago

jsartisan commented 1 day ago

Summary by CodeRabbit

Release Notes

Automation

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

:mag: Cypress test results

[!TIP] 🟒 🟒 🟒 All cypress tests have passed! πŸŽ‰ πŸŽ‰ πŸŽ‰ Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11935118755 Commit: a8170dfe131850c1a3f7a46870914d9dbc30624d Cypress dashboard. Tags: @tag.Sanity Spec:


Wed, 20 Nov 2024 14:52:18 UTC

Communication

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

Summary by CodeRabbit

coderabbitai[bot] commented 1 day ago

Walkthrough

The changes introduce enhancements to the _Sheet and _Sidebar components within the design system. New props for handling transition events, such as onEnter, onExit, and their counterparts, have been added to improve control over animations. The sidebar's internal state management has been updated to a more flexible system, allowing for various states like "expanded" and "collapsed". Additionally, new styling and structural modifications have been made to improve the user interface and responsiveness.

Changes

File Change Summary
.../Sheet/src/Sheet.tsx Added onEnter and onExit props to _Sheet component; updated CSSTransition to utilize these props for transition event handling; modified destructuring of props.
.../Sheet/src/types.ts Updated SheetProps interface to include onEnter, onExit, and onExited callback properties.
.../Sidebar/src/Sidebar.tsx Introduced new animation event props (onEnter, onEntered, onExit, onExited); updated internal state management; encapsulated rendering logic in a new SidebarContent component.
.../Sidebar/src/SidebarContent.tsx Defined SidebarContentProps interface; updated function signature to accept new props; enhanced rendering structure with Flex components.
.../Sidebar/src/SidebarProvider.tsx Transitioned to a generalized state management system using SidebarState; updated props and internal state handling; reorganized imports for clarity.
.../Sidebar/src/styles.module.css Modified transition effects for smoother animations; added new styles for .sidebarHeader and adjusted existing styles based on component states.
.../Sidebar/src/types.ts Updated SidebarContextType, SidebarProviderProps, and SidebarProps interfaces to reflect new state management and added optional properties for transition handling.
.../Sidebar/stories/Sidebar.stories.tsx Removed SidebarContent from certain stories; added new story WithRenderProps to demonstrate render prop pattern; updated args to include default title for the Sidebar.

Possibly related PRs

Suggested labels

Enhancement, Design System Product, Widgets Product, Task, IDE Pod, ADS Components, ok-to-test

Suggested reviewers

πŸŽ‰ In the land of code, where components reside,
New props were added, with transitions to guide.
The sidebar now dances, the sheet glides with grace,
Enhancements abound, in this digital space!
So let’s celebrate changes, both big and small,
For each line of code, we’re having a ball! 🎈

[!WARNING]

Rate limit exceeded

@jsartisan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 5 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](https://docs.coderabbit.ai/faq) for further information.
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between 0fe97bbe6d4e0f8723766e9551d0e38e233bd177 and a8170dfe131850c1a3f7a46870914d9dbc30624d.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
πŸͺ§ Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.