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(theme): improve Redoc component to display it in full size when used in MDX file #132

Closed
wants to merge 1 commit into from

Conversation

serut
Copy link
Contributor

@serut serut commented Feb 25, 2022

Refactor that component to extract an hook file : http://regardsoss.github.io/docs/development/backend/services/catalog/api-swagger/

And introduce a new param named fullscreenWithSidebar inside RedocProps. When true, it sets a special class that fix layout of Redoc to get it in full size.
It should looks lilke http://regardsoss.github.io/docs/development/backend/services/catalog/api-swagger

@changeset-bot
Copy link

changeset-bot bot commented Feb 25, 2022

⚠️ No Changeset found

Latest commit: 88fbe15

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Owner

@rohit-gohri rohit-gohri left a comment

Choose a reason for hiding this comment

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

Can you minimize the amount of changes? I like the hook concept but let's not do it in this PR

@serut
Copy link
Contributor Author

serut commented Feb 28, 2022

Are you affraid I introduced a regression ?
I do hook all day along, so I feeled like it was the right moment to do it 🙃

@rohit-gohri
Copy link
Owner

Are you affraid I introduced a regression ?

No, don't see any issue. Just would like to keep the refactoring separate.

I do hook all day along, so I feeled like it was the right moment to do it 🙃

It is definitely a good idea. I'd like to do it myself in a separate PR, and use it in ApiSchema and maybe other components also.

@rohit-gohri rohit-gohri added the enhancement New feature or request label Feb 28, 2022
@rohit-gohri
Copy link
Owner

Hey!

I'll be closing this PR since this I made a bunch of breaking changes in v1. And there are a lot of conflicts. Though I don't think this PR will be needed anymore, since using the @theme/Redoc component is now way easier in v1 and you can now pass classname directly to it.

If there is still some usecase that is not handled and this is needed, feel free to open another issue and we can add it in.

Thank you for the contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants