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

RawHtml Component for Arbitrary HTML Content #286

Open
slavashvets opened this issue Apr 26, 2024 · 8 comments
Open

RawHtml Component for Arbitrary HTML Content #286

slavashvets opened this issue Apr 26, 2024 · 8 comments
Labels
enhancement New feature or request

Comments

@slavashvets
Copy link

Could you consider adding a RawHtml component?

I see a gap in the ability to insert arbitrary HTML like <svg>. This would help for direct HTML integrations necessary for some designs and functionalities.

c.RawHtml(html="""
<svg width="41" height="41" viewBox="0 0 41 41" fill="none" xmlns="http://www.w3.org/2000/svg" class="icon-sm" role="img"><path d="M37.5324 16.8707C37.9808 15.5241 38.1363 14.0974 37.9886 12.6859C37.8409 11.2744 37.3934 9.91076 36.676 8.68622C35.6126 6.83404 33.9882 5.3676 32.0373 4.4985C30.0864 3.62941 27.9098 3.40259 25.8215 3.85078C24.8796 2.7893 23.7219 1.94125 22.4257 1.36341C21.1295 0.785575 19.7249 0.491269 18.3058 0.500197C16.1708 0.495044 14.0893 1.16803 12.3614 2.42214C10.6335 3.67624 9.34853 5.44666 8.6917 7.47815C7.30085 7.76286 5.98686 8.3414 4.8377 9.17505C3.68854 10.0087 2.73073 11.0782 2.02839 12.312C0.956464 14.1591 0.498905 16.2988 0.721698 18.4228C0.944492 20.5467 1.83612 22.5449 3.268 24.1293C2.81966 25.4759 2.66413 26.9026 2.81182 28.3141C2.95951 29.7256 3.40701 31.0892 4.12437 32.3138C5.18791 34.1659 6.8123 35.6322 8.76321 36.5013C10.7141 37.3704 12.8907 37.5973 14.9789 37.1492C15.9208 38.2107 17.0786 39.0587 18.3747 39.6366C19.6709 40.2144 21.0755 40.5087 22.4946 40.4998C24.6307 40.5054 26.7133 39.8321 28.4418 38.5772C30.1704 37.3223 31.4556 35.5506 32.1119 33.5179C33.5027 33.2332 34.8167 32.6547 35.9659 31.821C37.115 30.9874 38.0728 29.9178 38.7752 28.684C39.8458 26.8371 40.3023 24.6979 40.0789 22.5748C39.8556 20.4517 38.9639 18.4544 37.5324 16.8707ZM22.4978 37.8849C20.7443 37.8874 19.0459 37.2733 17.6994 36.1501C17.7601 36.117 17.8666 36.0586 17.936 36.0161L25.9004 31.4156C26.1003 31.3019 26.2663 31.137 26.3813 30.9378C26.4964 30.7386 26.5563 30.5124 26.5549 30.2825V19.0542L29.9213 20.998C29.9389 21.0068 29.9541 21.0198 29.9656 21.0359C29.977 21.052 29.9842 21.0707 29.9867 21.0902V30.3889C29.9842 32.375 29.1946 34.2791 27.7909 35.6841C26.3872 37.0892 24.4838 37.8806 22.4978 37.8849ZM6.39227 31.0064C5.51397 29.4888 5.19742 27.7107 5.49804 25.9832C5.55718 26.0187 5.66048 26.0818 5.73461 26.1244L13.699 30.7248C13.8975 30.8408 14.1233 30.902 14.3532 30.902C14.583 30.902 14.8088 30.8408 15.0073 30.7248L24.731 25.1103V28.9979C24.7321 29.0177 24.7283 29.0376 24.7199 29.0556C24.7115 29.0736 24.6988 29.0893 24.6829 29.1012L16.6317 33.7497C14.9096 34.7416 12.8643 35.0097 10.9447 34.4954C9.02506 33.9811 7.38785 32.7263 6.39227 31.0064ZM4.29707 13.6194C5.17156 12.0998 6.55279 10.9364 8.19885 10.3327C8.19885 10.4013 8.19491 10.5228 8.19491 10.6071V19.808C8.19351 20.0378 8.25334 20.2638 8.36823 20.4629C8.48312 20.6619 8.64893 20.8267 8.84863 20.9404L18.5723 26.5542L15.206 28.4979C15.1894 28.5089 15.1703 28.5155 15.1505 28.5173C15.1307 28.5191 15.1107 28.516 15.0924 28.5082L7.04046 23.8557C5.32135 22.8601 4.06716 21.2235 3.55289 19.3046C3.03862 17.3858 3.30624 15.3413 4.29707 13.6194ZM31.955 20.0556L22.2312 14.4411L25.5976 12.4981C25.6142 12.4872 25.6333 12.4805 25.6531 12.4787C25.6729 12.4769 25.6928 12.4801 25.7111 12.4879L33.7631 17.1364C34.9967 17.849 36.0017 18.8982 36.6606 20.1613C37.3194 21.4244 37.6047 22.849 37.4832 24.2684C37.3617 25.6878 36.8382 27.0432 35.9743 28.1759C35.1103 29.3086 33.9415 30.1717 32.6047 30.6641C32.6047 30.5947 32.6047 30.4733 32.6047 30.3889V21.188C32.6066 20.9586 32.5474 20.7328 32.4332 20.5338C32.319 20.3348 32.154 20.1698 31.955 20.0556ZM35.3055 15.0128C35.2464 14.9765 35.1431 14.9142 35.069 14.8717L27.1045 10.2712C26.906 10.1554 26.6803 10.0943 26.4504 10.0943C26.2206 10.0943 25.9948 10.1554 25.7963 10.2712L16.0726 15.8858V11.9982C16.0715 11.9783 16.0753 11.9585 16.0837 11.9405C16.0921 11.9225 16.1048 11.9068 16.1207 11.8949L24.1719 7.25025C25.4053 6.53903 26.8158 6.19376 28.2383 6.25482C29.6608 6.31589 31.0364 6.78077 32.2044 7.59508C33.3723 8.40939 34.2842 9.53945 34.8334 10.8531C35.3826 12.1667 35.5464 13.6095 35.3055 15.0128ZM14.2424 21.9419L10.8752 19.9981C10.8576 19.9893 10.8423 19.9763 10.8309 19.9602C10.8195 19.9441 10.8122 19.9254 10.8098 19.9058V10.6071C10.8107 9.18295 11.2173 7.78848 11.9819 6.58696C12.7466 5.38544 13.8377 4.42659 15.1275 3.82264C16.4173 3.21869 17.8524 2.99464 19.2649 3.1767C20.6775 3.35876 22.0089 3.93941 23.1034 4.85067C23.0427 4.88379 22.937 4.94215 22.8668 4.98473L14.9024 9.58517C14.7025 9.69878 14.5366 9.86356 14.4215 10.0626C14.3065 10.2616 14.2466 10.4877 14.2479 10.7175L14.2424 21.9419ZM16.071 17.9991L20.4018 15.4978L24.7325 17.9975V22.9985L20.4018 25.4983L16.071 22.9985V17.9991Z" fill="currentColor"></path></svg>
""")
@sydney-runkle
Copy link
Member

@slavashvets,

Thanks for your question. Is there any reason why this feature would be needed over the existing Iframe component?

https://docs.pydantic.dev/fastui/api/python_components/#fastui.components.Iframe

@sydney-runkle sydney-runkle added the enhancement New feature or request label May 1, 2024
@jimkring
Copy link
Contributor

jimkring commented May 1, 2024

@sydney-runkle can you explain how the FastUI Iframe component could be used for embedding a raw HTML string generated by Python code? My understanding is that it is designed for embedding HTML content at another URL.

I'm wanting to create reusable components for FastUI in python, but I can't see any way to get at the actual HTML. I want to do simple stuff like creating a table where elements are images, but I can't seem to figure that out.

@sydney-runkle
Copy link
Member

@jimkring,

Sure thing - you should be able to use the srcdoc field of the Iframe to pass in your custom HTML string.

Let me know if that doesn't fit your needs!

@jimkring
Copy link
Contributor

jimkring commented May 1, 2024

@sydney-runkle I sort of got that to work but...

  • src input is required (and cannot be empty string, None, or "."). I had to use a valid absolute URL string ("https://example.com"). Perhaps the Iframe model validator could be loosened up to allow src to be null if srcdoc is set.
  • I didn't set the height or width inputs, and I noticed the resulting frame renders with a horizontal scrollbar. I'd really like a behavior where the Iframe would grow to fit the content, which is an image in my use case. I could probably figure out the image, size, ahead of time and set the Iframe size accordingly, but there will be instances when I don't know the size ahead of time.

@jimkring
Copy link
Contributor

jimkring commented May 2, 2024

Here is an example I created for wrapping raw html in an fastui Iframe component:

GitHere: https://gist.github.com/jimkring/d2c30fda78e031b285070c07797b0148

from typing import Union
from fastui.components import Iframe

def iframe_from_html_raw(
        raw_html: str,
        width: Union[str, int, None] = None,
        height: Union[str, int, None] = None,
        ) -> Iframe:
    """Returns a fastui Iframe component that displays raw HTML content."""
    return Iframe(
        srcdoc=raw_html,
        # todo: ideally `fastui` should make src not required if srcdoc is provided
        src="http://required.input.ignored.when.srcdoc.is.valid",
        width=width,
        height=height,
    )

Side note: when wrapping an image I had to add some padding to get the horizontal scrollbars to go away.

import io
import base64

from PIL import Image  # requires `pillow` package
from fastui.components import Iframe

def iframe_from_image_base64(image_base64: str) -> Iframe:
    """Returns a fastui Iframe component that displays a base64 encoded image."""
    width, height = get_size_of_base_64_image(image_base64)

    # padding is required to make the iframe scrollbars disappear
    pad_horizontal = 4
    pad_vertical = 10

    return iframe_from_html_raw(
        html_raw=f'<img src="data:image/png;base64,{image_base64}" width="{width}" height="{height}">',
        width=width + 2 * pad_horizontal,
        height=height + 2 * pad_vertical,
        )

def get_size_of_base_64_image(image_base64: str):
    """Returns the width and height of a base64 encoded image."""
    imgdata = base64.b64decode(image_base64)
    im = Image.open(io.BytesIO(imgdata))
    width, height = im.size
    return width, height

@sydney-runkle
Copy link
Member

@jimkring,

Ah nice, thanks for looking into this further. Yep, I think as an intermediate step we could make src optional. I also think a RawHTML component with associated settings could be beneficial.

Thanks for posting your example, I'm sure it'll be of help to others in the meantime!

@shroominic
Copy link

Using IFrame seems confusing to me I would prefer just having a RawHTML Component

@jimkring
Copy link
Contributor

@shroominic yes, the iframe is just the only available work-around right now. In some ways, it's good for the evolution of fastui to not have a raw html component, because it forces everyone to try to find/design a more declarative way (with fastui features/components) to address the use cases.

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

4 participants