import inspect
import re
from typing import Callable, Optional, Union
import docutils.core
from nicegui import ui
from nicegui.elements.markdown import apply_tailwind
REGEX_H4 = re.compile(r'
(.*?)')
SPECIAL_CHARACTERS = re.compile('[^(a-z)(A-Z)(0-9)-]')
PYTHON_BGCOLOR = '#e3e9f2'
PYTHON_COLOR = '#eff5ff'
BASH_BGCOLOR = '#dcdcdc'
BASH_COLOR = '#e8e8e8'
BROWSER_BGCOLOR = '#f2f2f2'
BROWSER_COLOR = '#ffffff'
class example:
def __init__(self, content: Union[Callable, type, str], browser_title: Optional[str] = None) -> None:
self.content = content
self.browser_title = browser_title
def __call__(self, f: Callable) -> Callable:
with ui.column().classes('w-full mb-8'):
if isinstance(self.content, str):
documentation = ui.markdown(self.content)
else:
doc = self.content.__doc__ or self.content.__init__.__doc__
html: str = docutils.core.publish_parts(doc, writer_name='html5_polyglot')['html_body']
html = html.replace('', '
', 1)
html = html.replace('', '
', 1)
html = html.replace('param ', '')
html = apply_tailwind(html)
documentation = ui.html(html)
_add_html_anchor(documentation.classes('text-lg documentation bold-links'))
with ui.column().classes('w-full items-stretch gap-8 no-wrap xl:flex-row'):
code = inspect.getsource(f).split('# END OF EXAMPLE')[0].strip().splitlines()
while not code[0].startswith(' ' * 8):
del code[0]
code = [l[8:] for l in code]
code.insert(0, '```python')
code.insert(1, 'from nicegui import ui')
if code[2].split()[0] not in ['from', 'import']:
code.insert(2, '')
for l, line in enumerate(code):
if line.startswith('# ui.'):
code[l] = line[2:]
if line.startswith('# ui.run('):
break
else:
code.append('')
code.append('ui.run()')
code.append('```')
code = '\n'.join(code)
with python_window(classes='w-full max-w-[48rem]'):
ui.markdown(code)
with browser_window(self.browser_title, classes='w-full max-w-[48rem] xl:max-w-[20rem] min-h-[10rem] browser-window'):
f()
return f
def _add_html_anchor(element: ui.html) -> None:
html = element.content
match = REGEX_H4.search(html)
if not match:
return
headline = match.groups()[0].strip()
headline_id = SPECIAL_CHARACTERS.sub('_', headline).lower()
if not headline_id:
return
icon = 'link'
link = f'{icon}'
target = f''
html = html.replace('', f' {link}
', 1)
element.content = html
def _window_header(bgcolor: str) -> ui.row():
return ui.row().classes(f'w-full h-8 p-2 bg-[{bgcolor}]')
def _dots() -> None:
with ui.row().classes('gap-1 relative left-[1px] top-[1px]'):
ui.icon('circle').classes('text-[13px] text-red-400')
ui.icon('circle').classes('text-[13px] text-yellow-400')
ui.icon('circle').classes('text-[13px] text-green-400')
def _title(title: str) -> None:
ui.label(title).classes('text-sm text-gray-600 absolute left-1/2 top-[6px]').style('transform: translateX(-50%)')
def _tab(name: str, color: str, bgcolor: str) -> None:
with ui.row().classes('gap-0'):
with ui.label().classes(f'w-2 h-[24px] bg-[{color}]'):
ui.label().classes(f'w-full h-full bg-[{bgcolor}] rounded-br-[6px]')
ui.label(name).classes(f'text-sm text-gray-600 px-6 py-1 h-[24px] rounded-t-[6px] bg-[{color}]')
with ui.label().classes(f'w-2 h-[24px] bg-[{color}]'):
ui.label().classes(f'w-full h-full bg-[{bgcolor}] rounded-bl-[6px]')
def window(color: str, bgcolor: str, *, title: str = '', tab: str = '', classes: str = '') -> ui.column:
with ui.card().classes(f'no-wrap bg-[{color}] rounded-xl p-0 gap-0 {classes}') \
.style('box-shadow: 0 1px 2px rgba(0, 0, 0, 0.1)'):
with _window_header(bgcolor):
_dots()
if title:
_title(title)
if tab:
_tab(tab, color, bgcolor)
return ui.column().classes('w-full h-full overflow-auto')
def python_window(*, classes: str = '') -> ui.card:
return window(PYTHON_COLOR, PYTHON_BGCOLOR, title='main.py', classes=classes).classes('p-2 python-window')
def bash_window(*, classes: str = '') -> ui.card:
return window(BASH_COLOR, BASH_BGCOLOR, title='bash', classes=classes).classes('p-2 bash-window')
def browser_window(title: Optional[str] = None, *, classes: str = '') -> ui.card:
return window(BROWSER_COLOR, BROWSER_BGCOLOR, tab=title or 'NiceGUI', classes=classes).classes('p-4 browser-window')