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

Added an optional height and overflow scrollbar for the Markdown Component #8528

Merged
merged 20 commits into from
Jun 19, 2024

Conversation

ShruAgarwal
Copy link
Contributor

@ShruAgarwal ShruAgarwal commented Jun 11, 2024

Description

Adds an option to enable the height parameter (type: str) for a scrollable markdown. This can be used for controlling the display size of this component.

Please run demo/markdown_example to see it in action.

I kindly request you @abidlabs to please review this change and let me know your feedback! 🙂

Closes: #7455

🎯 PRs Should Target Issues

Before your create a PR, please check to see if there is an existing issue for this change. If not, please create an issue before you create this PR, unless the fix is very small.

Not adhering to this guideline will result in the PR being closed.

Tests

  1. PRs will only be merged if tests pass on CI. To run the tests locally, please set up your Gradio environment locally and run the tests: bash scripts/run_all_tests.sh

  2. You may need to run the linters: bash scripts/format_backend.sh and bash scripts/format_frontend.sh

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Jun 11, 2024

🪼 branch checks and previews

Name Status URL
Spaces ready! Spaces preview
Website ready! Website preview
Storybook ready! Storybook preview
🦄 Changes detected! Details

Install Gradio from this PR

pip install https://gradio-builds.s3.amazonaws.com/76b87225d50105ee211814ade0222d719faef616/gradio-4.36.1-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@76b87225d50105ee211814ade0222d719faef616#subdirectory=client/python"

Install Gradio JS Client from this PR

npm install https://gradio-builds.s3.amazonaws.com/76b87225d50105ee211814ade0222d719faef616/gradio-client-1.1.1.tgz

@@ -30,6 +31,7 @@
data-testid="markdown"
dir={rtl ? "rtl" : "ltr"}
use:copy
style="max-height: {height}; overflow-y: auto;"
Copy link
Collaborator

Choose a reason for hiding this comment

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

I feel like this style should only be applied if the height is not null

Copy link
Contributor Author

@ShruAgarwal ShruAgarwal Jun 14, 2024

Choose a reason for hiding this comment

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

I have made suggested changes and would request you to review and share your thoughts! :)

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Jun 19, 2024

🦄 change detected

This Pull Request includes changes to the following packages.

Package Version
@gradio/markdown minor
gradio minor
  • Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Added an optional height and overflow scrollbar for the Markdown Component

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

  • Maintainers can change the version label to modify the version bump.
  • If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

@abidlabs abidlabs changed the title Added an optional scrollbar for the Markdown Component Added an optional height and overflow scrollbar for the Markdown Component Jun 19, 2024
Copy link
Member

@abidlabs abidlabs left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for this nice PR @ShruAgarwal! I made some tweaks for consistency with other components e.g. to make the height parameter also be able to accept an int.

@abidlabs abidlabs merged commit 2b0c157 into gradio-app:main Jun 19, 2024
8 checks passed
@pngwn pngwn mentioned this pull request Jun 19, 2024
@ShruAgarwal
Copy link
Contributor Author

Looks great, thanks for this nice PR @ShruAgarwal! I made some tweaks for consistency with other components e.g. to make the height parameter also be able to accept an int.

Thanks a lot, @abidlabs ! 🤗😀

@pngwn pngwn mentioned this pull request Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto scrollable for Markdown
4 participants