asyncapi-react icon indicating copy to clipboard operation
asyncapi-react copied to clipboard

Set the left menu collapsable

Open M3lkior opened this issue 3 years ago • 17 comments

Reason/Context

Please try answering few of those questions

  • Why we need this improvement?

Depending on the screen resolution, the menu on the right side overlay the spec content

  • How will this change help? Allow the user to collapse this menu if needed
  • What is the motivation? A degraded user experience

image (13)

Description

Please try answering few of those questions

  • What changes have to be introduced? A new button to collapse the menu with a new collapsed style (a vertical layout to allow the expand ?)
  • Will this be a breaking change? no
  • How could it be implemented/designed?

A vertical layout with a collapse / expand icon

image

M3lkior avatar May 26 '21 14:05 M3lkior

@M3lkior Hello! Thanks for the issue.

Depending on the screen resolution, the menu on the right side overlay the spec content

Do you mean left navigation, not right, yes? Also it's a strange. Could you described which version of template do you use? I see that you probably also use Chrome as browser. I'm using Chrome and Firefox and with 0.21.4 version of template I cannot reproduce the bug. Some resolutions from my spec in Chrome (in Firefox it looks similar):

Desktop: image

Tablet: image

Mobile: image

About feature. Do you want to have something similar like SwaggerHub has, button to collapse left navigation like:

image

image

Am I right?

magicmatatjahu avatar May 27 '21 11:05 magicmatatjahu

Hi @magicmatatjahu ; yes it is about the left menu, not the right,

  • Concerning the version of the used html-template, it is the 0.21.2
  • And for the proposal, it is exactly what i mean !

M3lkior avatar May 27 '21 12:05 M3lkior

@M3lkior Thanks for quick response! Could you paste your spec to test? I am very concerned about why you have such a bug. Additionally, could you test the spec on version 0.20.0 of template? This is the pre-switch version to react component.

magicmatatjahu avatar May 27 '21 12:05 magicmatatjahu

@magicmatatjahu i can not share the spec because of my enterprise specification (and because we are using avro definition in the spec) but i do a test with the v0.20.0 and the issue is not present. I can also reproduce with the v0.21.4

M3lkior avatar May 27 '21 12:05 M3lkior

Honestly, I don't know what the problem could be. Apparently, as I see in your screenshoot, some styles stopped working for you and instead of (eg) flex the browser rendered it as fixed or absolute. It's hard for me to say what's wrong. At the moment, no one has reported a similar error. Maybe this is also a specification problem - which I doubt. It's really hard for me to conclude what is wrong.

magicmatatjahu avatar May 28 '21 10:05 magicmatatjahu

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] avatar Jul 28 '21 00:07 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

github-actions[bot] avatar Sep 27 '21 00:09 github-actions[bot]

@M3lkior Do you still have the problem with the hovering sidebar?

magicmatatjahu avatar Sep 27 '21 09:09 magicmatatjahu

I test again, and the sidebar is now correctly shown but i think that the collapsible sidebar feature is a good ux feature :)

M3lkior avatar Sep 27 '21 12:09 M3lkior

At the moment I am busy with something else, but I will mark this issue with Hacktoberfest label - someone should apply for this task :)

magicmatatjahu avatar Sep 27 '21 14:09 magicmatatjahu

Moving to the asyncapi-react repository.

magicmatatjahu avatar Sep 27 '21 14:09 magicmatatjahu

Is this issue still active? if yes can you please once more elaborate the issue. I would like to contribute in it.

Krishks369 avatar Nov 17 '21 15:11 Krishks369

Hello @Krishks369 ; i think yes it is about the ui enhancement :)

M3lkior avatar Nov 17 '21 15:11 M3lkior

I don't find any menu in right side of the UI image

Please correct me if I am Wrong, i am a complete beginner

Krishks369 avatar Nov 17 '21 15:11 Krishks369

how do you obatin this screeshot ? if you use the html-template generation you will see the menu; if you look at this thread https://github.com/asyncapi/asyncapi-react/issues/441#issuecomment-849545750, there is a menu on the right side showing the operations name, the tags, the components, etc;

M3lkior avatar Nov 17 '21 16:11 M3lkior

@Krishks369 Hi! If you are still willing to contribute, you need to make changes on the branch next, in the file https://github.com/asyncapi/asyncapi-react/blob/next/library/src/containers/Sidebar/Sidebar.tsx :

  • add some state where you will save expanded/collapsed state of menu
  • make it consistent with other styling

So you need to fork repo, switch to next branch and on it make changes. If you will need help, please ping me in this thread :) Every info, how to setup dev environment etc is in Readme.md

magicmatatjahu avatar Nov 18 '21 16:11 magicmatatjahu

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Mar 19 '22 00:03 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Oct 26 '22 00:10 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Mar 03 '23 01:03 github-actions[bot]

Hey @magicmatatjahu can I work on this issue?

sambhavgupta0705 avatar Mar 13 '23 04:03 sambhavgupta0705

@sambhavgupta0705 Sure, you can reuse code from https://github.com/asyncapi/asyncapi-react/pull/624

magicmatatjahu avatar Apr 02 '23 10:04 magicmatatjahu

hey @magicmatatjahu I am having problem while setting up this repo locally These are the errors: image

sambhavgupta0705 avatar Apr 04 '23 15:04 sambhavgupta0705

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Aug 03 '23 00:08 github-actions[bot]