mirror of
https://github.com/pyscript/pyscript.git
synced 2025-12-20 10:47:35 -05:00
* add JSProperty to pydom so it can be used to create descriptors mapping to specific JS attributes * add pyweb.ui * fix pyweb imports * fix link and a elements and add a script element * fix imports and add initialization to load resources to shoelace module * new pyweb.ui test folder * remove comments * add Icon to shoelace components * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * use html property rather than accessing _js directly * add markdown suppport * move examples section out of stdlib pyweb to examples.py in the demo itself * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * simplify demo code * improve docstrings * precommit fixes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * simplify code for main page * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add load_resources to markdown * add showlace extra style dynamically * precommit * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add gallery files * add global attributes and dynamic property assignment * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add shoelace radio component (#1961) * add shoelace radio component * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * fix type that lead using the the JSDescriptor directly instead of the factory method * add missing marked dependency * refactor gallary to simplify codebase * precommig lint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add text attribute to pydom Elements * add global JS attributes to elements and improve demos * lint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix image instantiation on card since the API has changed * add attributes to all classes in elements * lint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * change example creation functions to take the label and the object directly * fix input name clashing with input keyword * refactor examples to better simplify and automate * fix div clashing names * fix demo left menu width * simplify base elements demo by moving all the examples to the examples module * rename Grid to grid to align to other elements * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * reorg classes order in elements.py and add missing elements to examples * fix issue related to now importing div from pyweb.ui * improve demo * link and fix spelling typo * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add a bunch more elements (#1966) * Add copy button * Add skeleton and spinner * Add Switch * Add text area * Add more elements * More styling to each component * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Fabio Pliger <fpliger@users.noreply.github.com> * Add radio group (#1963) * add radio group * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Fabio Pliger <fpliger@users.noreply.github.com> * Small tweaks to main demo page (#1962) * Small tweaks to main demo page * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Fabio Pliger <fpliger@users.noreply.github.com> * fix post merge issues * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fixed issues with renaming Grid to grid, after we merged * lint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add multple HTML elements in alphabetical order from abbr to em * fix attributes of some of the elements added in the previous commit and add embed * fix embed attributes and add fieldset * add figcation, figure and form. Also fix ordering of definitoin of img and input_ * add style and lint * wrap up adding all major html elements * fix test failing due to different error message from fake server compared to a real test server * change default docstring associated with all classes dynamically patched * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add pyweb tests * lint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add global attributes and change abbr test * fix abbr to inherit from TextElementBase * add address test and improve error messaging when ElementBase gets a bad input as style * change test helper function to be more flexible on attributes and manage content vs non content based elements. Also adds area tests * add test for more elements up to caption * fix canvas and caption as elements that have content and fix name typo on figcaption * fix another typo on figcaption * minor fixes and complete tests for all elements * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * adapt shoelace to latest upates in ui.elements * fix issue with example code not showing created button * move global attributes to base class * replace all the calls to _add_js_properties with defining attributes directly in the classes * finish moving all properties manually on each class * remove _add_js_properties * replace JSProperty with js_property * replace JSProperty with js_property * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fixed merge conflicts * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * remove js_property and just use JSProperty with name and allow_nones as arguments * fix bug around Element not being able to map global attributes in subclasses * remove js_property and fix references * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * precommit * precommit again * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * lint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * enable pyweb on micropython * switch examples to micropython * fix pydom issue with micropython, created by the monkeypatch around JsProxy * print micropython version on micropython pydom example * lint and remove of textwrap in stdlib for micropython compatibility * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * added msising attributes on the option Element. Tests are all passing now * fix tests * lint * temp ugly fix for micropython, using the when decorator with a function without arguments * small fixes and improvements to examples * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix examples and broken link from the removal of markdown and shoelace from stdlib * lint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * dynamically change the server address in tests * use the right element in test_a * lint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * skipping test_audio in CI due to different behavior of fake_server vs a real server, that runs in local tests * add conditional expected_missing_file_errors property to manage different behaviour between local tests and CI (due to fake_server) * lint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Askat <aaskat@users.noreply.github.com> Co-authored-by: Fábio Rosado <hello@fabiorosado.dev> Co-authored-by: Andrea Giammarchi <andrea.giammarchi@gmail.com>
252 lines
7.1 KiB
Python
252 lines
7.1 KiB
Python
try:
|
|
from textwrap import dedent
|
|
except ImportError:
|
|
dedent = lambda x: x
|
|
|
|
import examples
|
|
import shoelace
|
|
import styles
|
|
from markdown import markdown
|
|
from pyscript import when, window
|
|
from pyweb import pydom
|
|
from pyweb.ui import elements as el
|
|
from pyweb.ui.elements import a, button, div, grid, h1, h2, h3
|
|
|
|
MAIN_PAGE_MARKDOWN = dedent(
|
|
"""
|
|
## What is pyweb.ui?
|
|
Pyweb UI is a totally immagnary exercise atm but..... imagine it is a Python library that allows you to create
|
|
web applications using Python only.
|
|
|
|
It is based on base HTML/JS components but is extensible, for instance, it can have a [Shoelace](https://shoelace.style/) backend...
|
|
|
|
PyWeb is a Python library that allows you to create web applications using Python only.
|
|
|
|
## What can I do with Pyweb.ui?
|
|
|
|
You can create web applications using Python only.
|
|
"""
|
|
)
|
|
|
|
# First thing we do is to load all the external resources we need
|
|
shoelace.load_resources()
|
|
|
|
|
|
# Let's define some convenience functions first
|
|
def create_component_details(component_label, component):
|
|
"""Create a component details card.
|
|
|
|
Args:
|
|
component (str): The name of the component to create.
|
|
|
|
Returns:
|
|
the component created
|
|
|
|
"""
|
|
# Get the example from the examples catalog
|
|
example = component["instance"]
|
|
details = (
|
|
getattr(example, "__doc__", "")
|
|
or f"Details missing for component {component_label}"
|
|
)
|
|
|
|
return div(
|
|
[
|
|
# Title and description (description is picked from the class docstring)
|
|
h1(component_label),
|
|
markdown(details),
|
|
# Example section
|
|
h2("Example:"),
|
|
create_component_example(component["instance"], component["code"]),
|
|
],
|
|
style={"margin": "20px"},
|
|
)
|
|
|
|
|
|
def add_component_section(component_label, component, parent_div):
|
|
"""Create a link to a component and add it to the left panel.
|
|
|
|
Args:
|
|
component (str): The name of the component to add.
|
|
|
|
Returns:
|
|
the component created
|
|
|
|
"""
|
|
# Create the component link element
|
|
div_ = div(
|
|
a(component_label, href="#"),
|
|
style={"display": "block", "text-align": "center", "margin": "auto"},
|
|
)
|
|
|
|
# Create a handler that opens the component details when the link is clicked
|
|
@when("click", div_)
|
|
def _change():
|
|
new_main = create_component_details(component_label, component)
|
|
main_area.html = ""
|
|
main_area.append(new_main)
|
|
|
|
# Add the new link element to the parent div (left panel)
|
|
parent_div.append(div_)
|
|
return div_
|
|
|
|
|
|
def create_component_example(widget, code):
|
|
"""Create a grid div with the widget on the left side and the relate code
|
|
on the right side.
|
|
|
|
Args:
|
|
widget (ElementBase): The widget to add to the grid.
|
|
code (str): The code to add to the grid.
|
|
|
|
Returns:
|
|
the grid created
|
|
|
|
"""
|
|
# Create the grid that splits the window in two columns (25% and 75%)
|
|
grid_ = grid("29% 2% 74%")
|
|
|
|
# Add the widget
|
|
grid_.append(div(widget, style=styles.STYLE_EXAMPLE_INSTANCE))
|
|
|
|
# Add the code div
|
|
widget_code = markdown(dedent(f"""```python\n{code}\n```"""))
|
|
grid_.append(shoelace.Divider(vertical=True))
|
|
grid_.append(div(widget_code, style=styles.STYLE_CODE_BLOCK))
|
|
|
|
return grid_
|
|
|
|
|
|
def create_main_area():
|
|
"""Create the main area of the right side of page, with the description of the
|
|
demo itself and how to use it.
|
|
|
|
Returns:
|
|
the main area
|
|
|
|
"""
|
|
div_ = div(
|
|
[
|
|
h1("Welcome to PyWeb UI!", style={"text-align": "center"}),
|
|
markdown(MAIN_PAGE_MARKDOWN),
|
|
]
|
|
)
|
|
|
|
main = el.main(
|
|
style={
|
|
"padding-top": "4rem",
|
|
"padding-bottom": "7rem",
|
|
"max-width": "52rem",
|
|
"margin-left": "auto",
|
|
"margin-right": "auto",
|
|
"padding-left": "1.5rem",
|
|
"padding-right": "1.5rem",
|
|
"width": "100%",
|
|
}
|
|
)
|
|
main.append(div_)
|
|
|
|
return main
|
|
|
|
|
|
def create_basic_components_page(label, kit_name):
|
|
"""Create the basic components page.
|
|
|
|
Returns:
|
|
the main area
|
|
|
|
"""
|
|
div_ = div(h2(label))
|
|
|
|
for component_label, component in examples.kits[kit_name].items():
|
|
div_.append(h3(component_label))
|
|
div_.append(create_component_example(component["instance"], component["code"]))
|
|
|
|
return div_
|
|
|
|
|
|
# ********** CREATE ALL THE LAYOUT **********
|
|
|
|
main_grid = grid("140px 20px auto", style={"min-height": "100%"})
|
|
|
|
# ********** MAIN PANEL **********
|
|
main_area = create_main_area()
|
|
|
|
|
|
def write_to_main(content):
|
|
main_area.html = ""
|
|
main_area.append(content)
|
|
|
|
|
|
def restore_home():
|
|
write_to_main(create_main_area())
|
|
|
|
|
|
def basic_components():
|
|
write_to_main(
|
|
create_basic_components_page(label="Basic Components", kit_name="elements")
|
|
)
|
|
# Make sure we highlight the code
|
|
window.hljs.highlightAll()
|
|
|
|
|
|
def markdown_components():
|
|
write_to_main(create_basic_components_page(label="", kit_name="markdown"))
|
|
|
|
|
|
def create_new_section(title, parent_div):
|
|
basic_components_text = h3(
|
|
title, style={"text-align": "left", "margin": "20px auto 0"}
|
|
)
|
|
parent_div.append(basic_components_text)
|
|
parent_div.append(
|
|
shoelace.Divider(style={"margin-top": "5px", "margin-bottom": "30px"})
|
|
)
|
|
return basic_components_text
|
|
|
|
|
|
# ********** LEFT PANEL **********
|
|
left_div = div()
|
|
left_panel_title = h1(
|
|
"PyWeb.UI", style={"text-align": "center", "margin": "20px auto 30px"}
|
|
)
|
|
left_div.append(left_panel_title)
|
|
left_div.append(shoelace.Divider(style={"margin-bottom": "30px"}))
|
|
# Let's map the creation of the main area to when the user clocks on "Components"
|
|
when("click", left_panel_title)(restore_home)
|
|
|
|
# BASIC COMPONENTS
|
|
basic_components_text = h3(
|
|
"Basic Components",
|
|
style={"text-align": "left", "margin": "20px auto 0", "cursor": "pointer"},
|
|
)
|
|
left_div.append(basic_components_text)
|
|
left_div.append(shoelace.Divider(style={"margin-top": "5px", "margin-bottom": "30px"}))
|
|
# Let's map the creation of the main area to when the user clocks on "Components"
|
|
when("click", basic_components_text)(basic_components)
|
|
|
|
# MARKDOWN COMPONENTS
|
|
markdown_title = create_new_section("Markdown", left_div)
|
|
when("click", markdown_title)(markdown_components)
|
|
|
|
|
|
# SHOELACE COMPONENTS
|
|
shoe_components_text = h3(
|
|
"Shoe Components", style={"text-align": "left", "margin": "20px auto 0"}
|
|
)
|
|
left_div.append(shoe_components_text)
|
|
left_div.append(shoelace.Divider(style={"margin-top": "5px", "margin-bottom": "30px"}))
|
|
|
|
# Create the links to the components on th left panel
|
|
print("SHOELACE EXAMPLES", examples.kits["shoelace"])
|
|
for component_label, component in examples.kits["shoelace"].items():
|
|
add_component_section(component_label, component, left_div)
|
|
|
|
left_div.append(shoelace.Divider(style={"margin-top": "5px", "margin-bottom": "30px"}))
|
|
left_div.append(a("Gallery", href="gallery.html", style={"text-align": "left"}))
|
|
# ********** ADD LEFT AND MAIN PANEL TO MAIN **********
|
|
main_grid.append(left_div)
|
|
main_grid.append(shoelace.Divider(vertical=True))
|
|
main_grid.append(main_area)
|
|
pydom.body.append(main_grid)
|