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: add onSiderCollapsed to RefineThemedLayoutV2Props #6527

Conversation

OmkarBansod02
Copy link
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

Bugs / Features

What is the current behavior?

The current behavior is that the collapsed state of the sider is not persisted out of the box. Developers need to write additional code to manage and persist the collapsed state, which adds extra effort for implementing this common UX feature.

What is the new behavior?

The sider now supports out-of-the-box persistence of the collapsed state through the new onSiderCollapsed boolean option. This enhancement eliminates the need for additional code to manage and persist the collapsed state, improving the developer experience and enhancing UX.

fixes #6508

Notes for reviewers

I’ve added the onSiderCollapsed feature to make it easier to persist the sider's collapsed state. I haven’t written tests for it yet but can definitely add them if needed. just let me know .

@OmkarBansod02 OmkarBansod02 requested a review from a team as a code owner November 27, 2024 08:44
Copy link

changeset-bot bot commented Nov 27, 2024

🦋 Changeset detected

Latest commit: 1f0be4c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages
Name Type
@refinedev/chakra-ui Minor
@refinedev/ui-types Minor
@refinedev/mantine Minor
@refinedev/antd Minor
@refinedev/mui Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@BatuhanW BatuhanW added this to the December '24 Release milestone Nov 27, 2024
@BatuhanW BatuhanW changed the base branch from master to releases/december-2024 November 28, 2024 13:48
@BatuhanW BatuhanW requested a review from a team as a code owner November 28, 2024 13:48
@BatuhanW BatuhanW force-pushed the releases/december-2024 branch from 94020bf to b3d23bc Compare November 29, 2024 06:58
Copy link

cypress bot commented Nov 29, 2024

refine    Run #11672

Run Properties:  status check passed Passed #11672  •  git commit 66773636c1 ℹ️: Merge f7cbc5903703abc0231bb76cd2743313d3a69e2a into 0d6d062e73189aa196a5ffbd9a89...
Project refine
Branch Review releases/december-2024
Run status status check passed Passed #11672
Run duration 13m 31s
Commit git commit 66773636c1 ℹ️: Merge f7cbc5903703abc0231bb76cd2743313d3a69e2a into 0d6d062e73189aa196a5ffbd9a89...
Committer Alican Erdurmaz
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 7
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 156
View all changes introduced in this branch ↗︎

@alicanerdurmaz
Copy link
Member

alicanerdurmaz commented Dec 3, 2024

Hello @OmkarBansod02 thanks for improving Refine, everything looks great!

If you have time, can you add documentation for these changes? After that, I believe this PR will be ready for release.

@OmkarBansod02
Copy link
Contributor Author

Hello @OmkarBansod02 thanks for improving Refine, everything looks great!

If you have time, can you add documentation for these changes? After that, I believe this PR will be ready for release.

Yeah sure ! @alicanerdurmaz Can you please give me some hints Or any reference point to start from.

@alicanerdurmaz
Copy link
Member

alicanerdurmaz commented Dec 4, 2024

Hello @OmkarBansod02 thanks for improving Refine, everything looks great!
If you have time, can you add documentation for these changes? After that, I believe this PR will be ready for release.

Yeah sure ! @alicanerdurmaz Can you please give me some hints Or any reference point to start from.

We are adding descriptions of the props in the following sections:

Material UI:

Ant Design:

Mantine:

Chakra UI:

@OmkarBansod02
Copy link
Contributor Author

Hey @alicanerdurmaz , I've added documentation for the onSiderCollapsed under the Ant Design provider section.
It includes:

  • A description of the prop in the Sider Props table.
  • An example demonstrating how to use the onSiderCollapsed .

Could you please review this and let me know if it aligns with the expected style and content? so i can move forward with other UI docs .

@BatuhanW BatuhanW changed the title feat: add onSiderCollapsed handler to RefineThemedLayoutV2Props feat: add onSiderCollapsed to RefineThemedLayoutV2Props Dec 9, 2024
@BatuhanW BatuhanW merged commit 1d26133 into refinedev:releases/december-2024 Dec 9, 2024
12 of 14 checks passed
@BatuhanW BatuhanW mentioned this pull request Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEAT] ThemedSiderV2 Persist Collapsed State
3 participants