nicegui/nicegui/elements/log.py

from typing import Optional

from ..element import Element
from ..vue import register_component

register_component('log', __file__, 'log.js')


class Log(Element):

    def __init__(self, max_lines: Optional[int] = None) -> None:
        """Log view

        Create a log view that allows to add new lines without re-transmitting the whole history to the client.

        :param max_lines: maximum number of lines before dropping oldest ones (default: `None`)
        """
        super().__init__('log')
        self._props['max_lines'] = max_lines
        self.classes('border whitespace-pre font-mono')
        self.style('opacity: 1 !important; cursor: text !important')

    def push(self, line: str) -> None:
        self.run_method('push', line)