Commit b07c91f8 authored by Duggan, John's avatar Duggan, John
Browse files

Merge branch '67-add-enum-type-example-to-nova-trame-docs' into 'main' 

Auto-populate items for autocomplete/combobox and update docs

Closes #67

See merge request ndip/public-packages/nova-trame!53
parents 5679862f 146e8bb6

pyproject.toml

+1 −1
Original line number Diff line number Diff line 
[tool.poetry]

name = "nova-trame"

version = "0.16.0"

version = "0.17.0"

description = "A Python Package for injecting curated themes and custom components into Trame applications"

authors = ["Duggan, John <dugganjw@ornl.gov>"]

readme = "README.md"

src/nova/trame/view/components/input_field.py

+21 −7
Original line number Diff line number Diff line
@@ -70,7 +70,7 @@ class InputField: 
                    "rules": (f"[(v) => trigger('validate_pydantic_field', ['{field}', v, index])]",),

                }



                if field_type == "select" and issubclass(field_info.annotation, Enum):

                if field_type in ["autocomplete", "combobox", "select"] and issubclass(field_info.annotation, Enum):

                    args |= {"items": str([option.value for option in field_info.annotation])}



            if debounce > 0 and throttle > 0:
@@ -123,25 +123,39 @@ class InputField: 
            Number of milliseconds to wait after the last user interaction with this field before attempting to update

            the Trame state. If set to 0, then no debouncing will occur. If set to -1, then the environment variable

            `NOVA_TRAME_DEFAULT_DEBOUNCE` will be used to set this (defaults to 0). See the `Lodash Docs

            <https://lodash.com/docs/4.17.15#debounce>`_ for details.

            <https://lodash.com/docs/4.17.15#debounce>`__ for details.

        throttle : int

            Number of milliseconds to wait between updates to the Trame state when the user is interacting with this

            field. If set to 0, then no throttling will occur. If set to -1, then the environment variable

            `NOVA_TRAME_DEFAULT_THROTTLE` will be used to set this (defaults to 0). See the `Lodash Docs

            <https://lodash.com/docs/4.17.15#throttle>`_ for details.

            <https://lodash.com/docs/4.17.15#throttle>`__ for details.

        type : str

            The type of input to create. This can be any of the following:



            - autocomplete

            - autoscroll (produces a textarea that automatically scrolls to the bottom as new content is added)

            - autocomplete - Produces a dropdown menu that supports autocompletion as the user types. Items can be \

                automatically populated (see select option for details).

            - autoscroll - Produces a textarea that automatically scrolls to the bottom as new content is added.

            - checkbox

            - combobox

            - combobox - Produces a dropdown menu that supports autocompletion as the user types and allows users to \

                add new items. Items can be automatically populated (see select option for details).

            - file

            - input

            - otp

            - radio

            - range-slider

            - select

            - select - Produces a dropdown menu. This menu can have items automatically populated if the v_model is \

                connected to a Pydantic field that uses an Enum type. Otherwise, you must specify the items parameter \

                to `InputField`.



                .. literalinclude:: ../tests/test_input_field.py

                    :start-after: items autopopulation start

                    :end-before: items autopopulation end

                    :dedent:



                .. code-block:: python



                    InputField(v_model="dropdown.enum_field", type="select")



            - slider

            - switch

            - textarea

tests/test_input_field.py

+2 −0
Original line number Diff line number Diff line
@@ -97,6 +97,7 @@ def test_pydantic_validation(driver: Firefox) -> None: 




def test_items_attributes() -> None:

    # items autopopulation start

    class DropdownOptions(str, Enum):

        item_a = "item_a"

        item_b = "item_b"
@@ -107,6 +108,7 @@ def test_items_attributes() -> None: 
        str_field: str = Field(default="test")



    dropdown = Dropdown()

    # items autopopulation end



    class MyTrameApp(ThemedApp):

        def __init__(self, server: Server = None) -> None: