nicegui/website/documentation/content/sections/audiovisual_elements.py

from nicegui import ui

from ...model import SectionDocumentation
from ..more.audio_documentation import AudioDocumentation
from ..more.avatar_documentation import AvatarDocumentation
from ..more.icon_documentation import IconDocumentation
from ..more.image_documentation import ImageDocumentation
from ..more.interactive_image_documentation import InteractiveImageDocumentation
from ..more.video_documentation import VideoDocumentation


class AudiovisualElementsDocumentation(SectionDocumentation, title='*Audiovisual* Elements', name_='audiovisual_elements'):

    def content(self) -> None:
        self.intro(ImageDocumentation())

        @self.demo('Captions and Overlays', '''
            By nesting elements inside a `ui.image` you can create augmentations.

            Use [Quasar classes](https://quasar.dev/vue-components/img) for positioning and styling captions.
            To overlay an SVG, make the `viewBox` exactly the size of the image and provide `100%` width/height to match the actual rendered size.
        ''')
        def captions_and_overlays_demo():
            with ui.image('https://picsum.photos/id/29/640/360'):
                ui.label('Nice!').classes('absolute-bottom text-subtitle2 text-center')

            with ui.image('https://cdn.stocksnap.io/img-thumbs/960w/airplane-sky_DYPWDEEILG.jpg'):
                ui.html('''
                    <svg viewBox="0 0 960 638" width="100%" height="100%" xmlns="http://www.w3.org/2000/svg">
                    <circle cx="445" cy="300" r="100" fill="none" stroke="red" stroke-width="20" />
                    </svg>
                ''').classes('bg-transparent')

        self.intro(InteractiveImageDocumentation())
        self.intro(AudioDocumentation())
        self.intro(VideoDocumentation())
        self.intro(IconDocumentation())
        self.intro(AvatarDocumentation())

        @self.demo('SVG', '''
            You can add Scalable Vector Graphics using the `ui.html` element.
        ''')
        def svg_demo():
            content = '''
                <svg viewBox="0 0 200 200" width="100" height="100" xmlns="http://www.w3.org/2000/svg">
                <circle cx="100" cy="100" r="78" fill="#ffde34" stroke="black" stroke-width="3" />
                <circle cx="80" cy="85" r="8" />
                <circle cx="120" cy="85" r="8" />
                <path d="m60,120 C75,150 125,150 140,120" style="fill:none; stroke:black; stroke-width:8; stroke-linecap:round" />
                </svg>'''
            ui.html(content)