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

Upgrade @asyncapi/react-component dependency major version from 1 to 2 #707

Open
2 tasks done
VsKatshuma opened this issue Jan 13, 2025 · 4 comments
Open
2 tasks done
Labels
enhancement New feature or request

Comments

@VsKatshuma
Copy link

Why do we need this improvement?

@asyncapi/html-template seems to have fallen behind in development and has not been taking advantage of fixes in @asyncapi/react-component since April 2024. The react-component dependency is using the old version ^1.2.13, which was released in January 2024, and in April 2024, the major version 2.0.0 of react-component was released, which upgraded the component to React v18.

How will this change help?

An example: react-component v2.2.2 fixed an issue where hiding a section would not hide it from sidebar. Since html-template is still using the major version 1, if you generate an API document using CLI with { "show": { "schemas": false } } in the config file, the schemas section will not be visible in the document, but will still appear in the sidebar. Issues like these would be fixed by bumping the major version to 2.

Screenshots

No response

How could it be implemented/designed?

Upgrading the @asyncapi/react-component dependency and ensuring that this change does not break html-template. The upgrade to React v18 in react-component is listed as a breaking change, which is why it's a major update.

🚧 Breaking changes

Yes

👀 Have you checked for similar open issues?

  • I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

No, someone else can work on it.

@VsKatshuma VsKatshuma added the enhancement New feature or request label Jan 13, 2025
Copy link

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link
Member

derberg commented Jan 13, 2025

sounds good, react component v2 was added just because of upgrade to react v18 so not a problem here and we can release as minor here.

go ahead and open a PR, of course please make sure it works on local and share testing results. It is pretty easy as CLI allows you to use templates from local drive as well. So once you upgrade locally, make sure dependencies are installed, you can run npm run test:generator:v3 from the root and your local html-template will be picked up by the CLI

@MadhavDhatrak
Copy link

@derberg I would love to work on this. Could you please assign it to me

Copy link
Member

derberg commented Jan 20, 2025

@MadhavDhatrak we don't assign issues here as 90% of people that ask for it anyway don't complete their work. Just feel free to indicate you work on it and do the work

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

No branches or pull requests

3 participants