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

The Extended API Description goes beyond the boundaries if the text is too long #2605

Open
nosbuka opened this issue Oct 14, 2023 · 0 comments

Comments

@nosbuka
Copy link

nosbuka commented Oct 14, 2023

Apiman Version

3.2.1.Final

Apiman Manager Distro

WildFly

Apiman Gateway Distro

Vert.x

Java Version

openjdk version "14.0.2" 2020-07-14
OpenJDK Runtime Environment (build 14.0.2+13)
OpenJDK 64-Bit Server VM (build 14.0.2+13, mixed mode, sharing)

Operating System

CentOS Linux release 7.8.2003

Are you running Apiman in a container, or on an orchestration platform?

Docker Compose

Describe the bug

When I create an API, I need to write the Extended API Description. The text I'm trying to place as description, looks good in Manager app. But when I look at the text in Developer Portal, it goes beyond the border of an #markdown-container element.

So, I found this element in dev-tools and it's id="markdown-container". It has following css:

#markdown-container {
  max-height: 50vh;
  padding-left: 1%;
  padding-right: 1%;
  border: 1px solid rgb(0 0 0 / 20%);
  background: rgb(0 0 0 / 2%);
}

When I disable the max-height: 50vh; property, the text looks normally and it fixes the issue. But I can't do it via custom-style.css, because the component ApiMarkdownDescriptionComponent uses encapsulation: ViewEncapsulation.ShadowDom (in order to highlight the code syntax with Prism).

So, I can't change the css of #markdown-container via custom-style.css.
I think the main idea was: "highlight the syntax with Prism (the reason of shadow DOM using) and add the scroll opportunity (the reason of data-simplebar in component's html)". But, unfortunately, it's not properly working.
extended-descr-issue

Expected behaviour

I expect all the text content with syntax highlighting appears in container and not goes beyond the boundaries (with or without scrolling).

Actual behaviour

The Extended API Description goes beyond the boundaries if the text is too long.

How to Reproduce

Just create an API and add the Extended API Description that will be longer than the visible part of the container suggests.

Relevant log output

No response

Anything else?

Thank you for your work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant