Improvements

• cleanups and refactorings made possible by having Python 3.8 as minimum version (by @falkoschindler)

Bugfixes

• fixed on-air URL (by @rodja)

Bugfixes

• Remove NumPy dependency (#1167 by @dyipon, @falkoschindler)
• Fix deletion of dynamically created elements (by @falkoschindler)

Bugfixes

• netifaces package is now an optional dependency (#1166 by @falkoschindler and @rodja)
• fixed unexpected clearing of content (by @falkoschindler)
• added missing httpx dependency (by @rodja)

New features and improvements

• New dependency management to reduce payload, improve load times and support ESM (#658 by @dclause, @falkoschindler)
• Simplify API for registering custom Vue components and JavaScript dependencies (#1134 by @rodja, @falkoschindler)
• Improve generic event registration to provide access to sender and additional event arguments (#583, #664, #672, #1095 by @michelemoretti, @bobanovo, @falkoschindler)
• Provide source maps for minified dependencies (#753 by @aaad, @falkoschindler)
• Tech-preview for NiceGUI On Air: use ui.run(on_air=True) to get a temporary public URL through which your local app is accessible via the internet (@falkoschindler, @rodja)
• Reduce size of PyPI package by making pywebview, plotly and matplotlib optional (#1010, #1143 by @firai, @rodja)
• Use snake_case style arguments for ui.notify() (#930 by @CatamountJack)
• Allow using ui.menu for custom context menus (#747 by @falkoschindler)
• Remove no-parent-event prop for ui.menu (#713 by @falkoschindler)
• Add on_change parameter for ui.knob (#1119 by @rodja)
• Add ui.scroll_area element (#1072 by @eli-kha, @falkoschindler)

Bugfixes

• Fix memory leak on client when removing elements (#1089 by @Kamil-Och, @CrystalWindSnake, @falkoschindler)
• Fix on_shutdown callback not being called on Windows 10 (#1050 by @chhinze, @firai)
• Fix ui.footer(fixed=False) (#1136 by @falkoschindler)
• Find IP addresses more robustly using netifaces (#1137 by @falkoschindler)
• Fix two favicon issues (#1139 by @falkoschindler)
• Fix table selection not going away after removing selection (#1115, #1122 by @struffel, @Trickshotblaster, @falkoschindler)

Documentation

• Add demo for removing default padding with ui.query selector (#1120 by @rodja)

Breaking changes and migration guide

Generic event registration with .on()

The argument passed to the event handler is now of type GenericEventArguments. So instead of

grid.on('cellClicked', lambda msg: ui.label(f'{msg["args"]["data"]["name"]} has been clicked!'))

we access the event arguments like this:

grid.on('cellClicked', lambda e: ui.label(f'{e.args["data"]["name"]} has been clicked!'))

See https://nicegui.io/documentation/generic_events for more information.

Custom Vue components and JavaScript libraries

We radically simplified the API to register custom components and external libraries. Now you can pass the location of the component and additional libraries as parameter to the derived class:

class CustomElement(ui.element, component='custom_element.js', libraries=['lib/some-library.min.js']):
    super().__init__()
    ...

Note that you don't have to pass a tag to the base initializer. It will be set automatically. Besides libraries you can specify exposed_libraries (will be added to importmaps) and extra_libraries (will be registered but not automatically requested by that element). All library parameters support absolute and relative paths (relative to the Python file), either as str or as Path, and support globbing.

Exclude parameter

The exclude parameter of ui.run is gone. Due to NiceGUI's new dynamic dependency management there is no need to explicitly exclude individual elements.

Python 3.7

With NiceGUI 1.3 we drop support for Python 3.7, which had its end of life on June 27, 2023.

New features and improvements

• Allow passing arguments to refreshable.refresh() (#1096 by @CrystalWindSnake, @falkoschindler)
• Allow passing an awaitable to ui.timer (#1098 by @rodja)
• Improved DOM placement of page layout elements for better accessibility (#1097 by @ProbablyBrian, @falkoschindler)

Bugfixes

• Fix run_method() for Quasar component wrappers like ui.input and ui.select (#1092, #1093 by @CatamountJack, @cj, @rodja, @falkoschindler)
• Fix warning about background tasks not being awaited as it happened sometimes with app.storage (#1099, #1104 by @rodja, @falkoschindler)

Documentation

• Fix URL to Google Icons (#1106 by @frankhuurman, @rodja)
• Use Tortoise ORM in the database example (#1114 by @rodja)

Development

• Fix Slack notification GitHub Action for missing webhook URL (#1068, #1084, #1105 by @michangelis)
• Update pytests to avoid deprecation warnings (#1110 by @falkoschindler)

New features and improvements

• Support the clearable prop with ui.select (#1069 by @CrystalWindSnake, @falkoschindler)
• Only create storage directory if needed (#1080, #1085 by @rodja, @falkoschindler)
• Add toggle() method to ui.menu (#860 by @patrickwasp, @falkoschindler)

Bugfixes

• Always update ui.input after server-side value change (#1071, #1088 by @pythonormen, @eshyun, @falkoschindler)
• Avoid ui.input to repeat change events in a loop (#1086 by @CrystalWindSnake, @falkoschindler)
• Fix update of ui.plotly (#1037, #1070 by @duane-impulse, @falkoschindler)
• Fix serving media files from subdirectories (#1076 by @falkoschindler)
• Ensure move events from joystick are only sent between start/end (#1082 by @rodja)

Documentation

• Fix typo in bindings docs (#1075 by @suspiciousRaccoon)
• Add example for NiceGUI with ROS2 (#1059, #1083 by @JensOgorek, @rodja)
• Add documentation for ui.separator (#1081 by @rodja)
• Add log handler demo (#1078 by @BrianLandry)

New features and improvements

• Support autocomplete ui.input on mobile devices (#852, #1063 by @rodja, @phoskee, @falkoschindler)
• Add error property for input elements with validation (#894 by @itay-raveh, @falkoschindler)
• Introduce min, max and out_of_limits for ui.number (#924, #1049 by @ukoehler, @falkoschindler)
• Support dynamic column attributes like sort and format functions for ui.table (#1058, #1061 by @juledwar, @falkoschindler)

Bugfixes

• Fix ui.select when using with_input and multiple (#1044 by @groucho86, @falkoschindler)
• Fix image and media sources for reverse proxies with subpath (#934, #1038 by @rodja, @falkoschindler)

Development

• Condense mypy and pytest config files to pyproject.toml (#1053 by @xec-abailey)

New features and improvements

• Introduce ui.stepper element based on Quasar's QStepper (#679, #1033 by @bobwatcherx, @falkoschindler)
• Ignore events on disabled or hidden elements by default (#983, #1030 by @thetableman, @falkoschindler)
• Introduce icon parameter for ui.button (#1021 by @falkoschindler)

Documentation

• Provide ui.image demo for Base64 data (#1036 by @falkoschindler)

Bugfixes

• Fix ui.image on Windows (#1039 by @Hamza-Rafi, @falkoschindler)
• Fix ui.mermaid when updated with content beginning with a line break (#1031 by @jsharer, @falkoschindler)
• Avoid treating Base64 data as a filepath (#1023 by @gitUser000, @falkoschindler)

Improvement

• switch from python-magic to internal mimetype module to reduce external dependencies introduced in v1.2.18 (#1020 by @rodja)

New features and improvements

• Use keep-alive for tab panels (#1017 by @rodja and @falkoschindler)
• Allow streaming of media files and auto-serve local files passed as source for image, interactive_image, video and audio (#1016 by @rodja)
• mutli-select support for ui.select (#995 by @falkoschindler)
• Ability to set storage_secret for run_with (#1012 by @awfulness)
• Conda package does not need importlib-metadata anymore (#1002 by @ErikRtvl and @rodja)
• Allow passing ui.tab objects into ui.tab_panel (#999 by @BrianLandry and @rodja)
• Event_handler: allow passing lambdas which call an async function (#994 by @rodja)

Documentation

• Provide online search for the documentation (#1011 by @rodja and @falkoschindler)
• Add geolocation demo to demonstrate running async JavaScript (#1009 by @falkoschindler)
• Fixed docs in table.py (#992 by @Ruibin-Liu)
• Update menu_and_tabs example to use tab_panels (#1013, #1014 by @xec-abailey)

Bug Fixes

• no more content duplication when creating a ui.log element while client is already connected (#906 by @falkoschindler)

New features and improvements

• save general and user specific data with new app.storage interface (#967, #978 by @rodja and @falkoschindler)
• introduction of observable dict, list and set (#977 by @falkoschindler)
• allow binding to Mapping type and ignore missing attributes (#981 by @falkoschindler)

Documentation

• Extended and enhanced "generic events" documentation (#984 by @rodja and @falkoschindler )

New features and improvements

• Allow using NiceGUI elements as link targets (#964 by @rodja)
• Allow using event handlers without event arguments but with a default argument (#965 by @falkoschindler)
• improved favicon routing (#963 by @rodja)
• Allow calling native window methods from NiceGUI's main thread (#917 by @rodja)
• Add a specialization of FastAPI's APIRouter to modularize large page structures (#897 by @rodja)

Documentation

• Refactored todo list example to use on_change callbacks (#970 by @rodja)
• Add Lightbox example (#968 by @rodja)

New features and enhancements

• Support dynamic props (#893, #896 by @falkoschindler, @duane-impulse)
• Implement __iter__ for elements and slots (#958 by @falkoschindler, @DLu)
• Support clearable prop for ui.input(), ui.number and ui.textarea (#300 by @falkoschindler, @Mantanium)
• Try websocket first and use long polling only as fallback (#959 by @rodja)

Bugfixes

• Fix unexpected behavior when using refreshable UI at multiple places (#938 by @falkoschindler)
• Correctly track count of ui.chart series (#948, #951 by @falkoschindler, @gengyudong)
• Fix type annotation for ui.page decorator (#949 by @@falkoschindler, @AndrewMHenry)
• Fix pyright typing issues with on() (#722 by @falkoschindler, @cj)

Documentation

• Add SimPy example (#955 by @rodja)
• Add a simple todo list example (#923, #954 by @falkoschindler, @metaperl)
• Add demo for reacting on content changes via binding (#950 by @rodja)
• Add tooltips to the icon-links on nicegui.io (#942 by @rodja, @falkoschindler)
• Add demo for masonry layout (#941 by @rodja)
• Add icon demo for ui.button (#933 by @rodja)
• Fix closeBtn argument in ui.notify documentation (#928 by @CatamountJack)

Enhanced ui.avatar, more documentation, and bugfixes

Improvements

• Allow images inside ui.avatar (#903 by @rodja)

Documentation Updates

• Fixed type hint for set_visibility() method (#911 by @jonathanunderwood and @rodja)
• New demo showing multiline notifications (#914 by @rodja)
• New demo showing how to add rows (#913 by @rodja)

Bug Fixes

• Special characters like % can't be pushed to ui.log (#899 by @falkoschindler and @phoskee)
• element.move() does not work as expected in some cases (#898 by @falkoschindler)

Bugfix

• Fix issue with table not rendering Decimal values (#901 by @stefan-sherwood, @falkoschindler)
• Ignore socket failures when gathering ip addresses (#900 by @rodja)

New features and enhancements

• Support internationalization for Quasar elements (#874 by @phoskee, @falkoschindler)
• Allow moving elements with element.move() (#880 by @falkoschindler)
• Support HTML and newlines in chat message (#881 by @falkoschindler)
• Include all possible IPs in welcome message (#855 by @ChrisJefferson, @falkoschindler)
• Improve performance using dataclasses with slots (#891 by @falkoschindler)

Bugfix

• Fix grabbing client ip from sio environ (#877 by @rodja)

Documentation

• Move detailed page documentation to "more" (#888 by @rodja)
• Add background demo to ui.query (#887 by @rodja)
• Improved discoverability for "more" documenation (#886 by @rodja)
• New "Chat with AI" example (#884 by @wptmdoorn, @falkoschindler)
• Fix timestamps in "Chat App" example (#882 by @phoskee)
• Add demo for tables in ui.markdown and improve styling (#876 by @rodja)
• Add sqlite database example (#822 by @godsarmy, @rodja, @falkoschindler)

New features and enhancements

• Allow awaiting button clicks (#849 by @rodja)

@ui.page('/')
async def index():
    b = ui.button('Step')
    await b.clicked()
    ui.label('One')
    await b.clicked()
    ui.label('Two')
    await b.clicked()
    ui.label('Three')

• Use case-insensitive matching for ui.input's autocompletion (#856 by @phoskee)
• Use root_path as prefix (#848, #857 by @wdroz)

Bugfixes

• Fix special characters in ui.log (#865 by @phoskee, @falkoschindler)
• Fix wrong container for ui.refreshable with async functions (#863 by @markbaumgarten, @rodja)

Documentation

• Fix typo on documentation of ui.button (#853, #854 by @masykur8d, @rodja)
• Add an example with an editable Pandas DataFrame (#851 by @miek770)
• Add new demos showing how to bind to dictionaries and global variables (#850 by @Devavrat8492, @falkoschindler)

Improved bindings, ui.grid, ui.chat_message and more

New features and enhancements

• Add autocomplete for ui.input (#824 by @phoskee, @falkoschindler)
• Allow binding dictionaries (#829 by @falkoschindler)
• Add binding methods for disableable elements (@falkoschindler)
• Introduce ui.grid (#827 by @falkoschindler)
• Introduce ui.chat_message (#826 by @markbaumgarten, @rodja, @falkoschindler)
• Support ui.refreshable with async functions (@rodja, @falkoschindler)
• Style blockquotes in ui.markdown elements (#820, #825 by @atomicrichard, @falkoschindler)
• Introduce seek method for ui.video (#812 by @rodja, @falkoschindler)
• Support base64 and SVG favicons (#808 by @rodja)
• Add mount_path parameter to ui.run_with (#842 by @Viicos)

Bugfixes

• Fix layout issue with ui.refreshable (#841 by @falkoschindler)
• Avoid memory leak with ui.refreshable (@rodja, @falkoschindler)
• Fix new event registrations not being sent to the client (#834 by @falkoschindler)

Documentation

• Allow choosing from different elements for the live demo (#837 by @phoskee)
• Improve menu accessibility on mobile devices (#811 by @falkoschindler)

"Refreshable" UI functions, better dark mode support and an interactive styling demo

New features and enhancements

• Introduce ui.refreshable (#782 by @rodja, @falkoschindler)
• Add enable and disable methods for input elements (#560, #797 by @Help-i-am-lost, @falkoschindler)
• Introduce ui.dark_mode (#342, #783 by @smojef, @falkoschindler)
• Add min/max/step/prefix/suffix parameters to ui.number (#765, #790 by @1081, @falkoschindler)
• Switch back to Starlette's StaticFiles (#714, #723 by @clueple, @falkoschindler)
• Relax version restriction for FastAPI dependency (#805, #807 by @Viicos)

Bugfixes

• Fix ui.upload behind reverse proxy with subpath (#787 by @falkoschindler)
• Fix hidden label when text is 0 (#791 by @AndrewMHenry, @falkoschindler)

Documentation

• Add an interactive demo for classes, style and props (#795 by @phoskee, @falkoschindler)
• Improve documentation for ui.timer (@falkoschindler)
• Add a demo for creating a ui.table from a pandas dataframe (#30 by @bdshoener, @falkoschindler)

• Fix updating and replacing ui.links (#779 by @Yonsh, @rodja, @falkoschindler)
• Add FastAPI kwargs to @ui.page (#773 by @rodja)
• Add support for emoji favicons (#767 by @rodja)

New features and enhancements

• allow creating ui.aggrid from pandas dataframe (#557 by @falkoschindler)
• fix navigation links behind reverse proxy with subpath (#556 by @rodja, @falkoschindler)
• allow sending "leading" and/or "trailing" events when throttling (#751 by @falkoschindler)
• raise an exception when hiding internal routes with app.add_static_files (#742 by @2000Nic and @falkoschindler)
• add “dark” color to ui.colors (#740 by @SilvesterSJ and @falkoschindler)
• introduce ui.download (#656 by @terrytrent and @falkoschindler)
• introduce color arguments for elements like ui.button that accept Quasar, Tailwind, and CSS colors (#371 by @Diegiwg, @miqsoft and @falkoschindler)
• allow running in Python’s interactive mode by auto-disabling reload (by @rodja and @falkoschindler)

Documentation

• enhance Trello "drag and drop" example to use a ToDo data model (#749 by @rodja)
• add workaround to docs for native mode when WebView2Loader.dll fails load (#744 by @vonpawn)
• add documentation and demo about element borders inside a ui.card (#726 by @miqsoft and @falkoschindler)
• add hint about exception when running executable with no console on Windows (#681 by @spehj, @hditano, @executionunit, @clueple, @edsase, @ymweagle and @falkoschindler)

Bugfixes

• wait until server is alive before calling webview.start (#607, #755 by @al-eax)
• docker image fails; missing docutils (#739 by @Paradoxdruid and @rodja)
• apply ui.number’s format on blur (#736 by @tmichela and @falkoschindler)
• fix overwritten and undeletable characters for ui.input with masks (#731 by @phoskee and @falkoschindler)
• fix memory leak when clearing and redrawing a group in ui.scene (#727 by @h0uter and @falkoschindler)
• fix replacement of custom elements like ui.interactive_image (#600 by @DavidLeBonk, @falkoschindler and @dclause)

Bugfix release #2 for windows venv: missing files in static folder (https://github.com/zauberzeug/nicegui/issues/714, #720 by @kiwifoxtrot, @clueple, @PabloCR, @falkoschindler and @rodja)

Bugfix release for windows venv: missing files in static folder (#714 by @kiwifoxtrot, @clueple, @falkoschindler and @rodja)

New Features

• Introduce Tailwind CSS class manager for auto-complete suggestions (#362 by @Diegiwg, @falkoschindler)
• Introduce ui.splitter element (#676 by @abulka)
• Introduce ui.query function, e.g. for easy background configuration (#448, #411 by @falkoschindler, @rodja)
• Add option to disable grid in ui.scene (#700 by @JakobGue)
• Make native window more configurable (#674 by @falkoschindler, @Skjolbir)

Bugfixes

• Allow returning a RedirectResponse from an async page function (#693 by @rodja, @espeoceka)
• Allow running NiceGUI on Replit.com (#431, #539, #548 by @gloomie, @CCR010, @then77, @falkoschindler)
• Stop web browser from opening before ui.run() (#412, #625 by @tobb10001, @JS-Aibel)

Community

• Add Discord link to site header to improve community discoverability (#671 by @dclause)

Improvements

• Add support for NumPy arrays with dtype=object in ui.plotly (#601, #669 by @rbeeli, @JS-Aibel)
• Simplify event protocol between server and client (#644 by @falkoschindler
• Allow nesting elements inside of ui.interactive_image (#618 by @ThonAfterPy, @falkoschindler)

Bugfixes

• Fix timing issue during initializing ui.scene (#659 by @falkoschindler)
• Fix SVG content in ui.interactive_image when cross is False (#642 by @falkoschindler)
• Fix parsing line breaks in ui.mermaid (#641 by @cedricWassenaar, @falkoschindler)
• Fix DOM mutation issue when replacing a ui.interactive_image (#624 by @dclause, @falkoschindler, @DavidLeBonk)

Documentation

• Improve PyInstaller documentation, add various packaging tips (#639 by @abulka)
• Add new new AG Grid demo demo (#629 by @Slanderkin)
• Add citation file to GitHub (#660 by @rodja, @tjakobi)

Release Notes

This release includes several improvements and bug fixes.

Features

• Automatically strip indentation from markdown content (#617 by @falkoschindler)
• Add syntax highlighting for code blocks in ui.markdown (#612 by @falkoschindler, @pythonormen)
• Provide search-as-you-type within the options of ui.select (#272 by @falkoschindler, @shakamoushie)

Bug Fixes

• Fix issue when replacing a ui.interactive_image (#600, #616 by @dclause, @DavidLeBonk, @falkoschindler)
• Fix single selection for ui.table (#609 by @falkoschindler)
• Correctly initialize ui.color_input's popup (#603 by @RobinSchfr, @falkoschindler)

Documentation

• Improve documentation with more demos and more complete API reference (#439 by @falkoschindler, @Quadrum1)

Thank you to all contributors who helped make this release possible.

Bug Fixes

• Fixed an issue where an exception was thrown when closing the window in native mode on Windows. (#584, #602 by @al-eax, @rodja)
• Fixed an error when updating ui.chart before it is successfully mounted. (#581 by @dclause)
• Fixed using PyInstaller with native mode. (#579, #582 by @rodja)
• Fixed texture rendering in ui.scene (#591 by @falkoschindler)

Updates

• Updated Plotly to version 2.20.0. (#580 by @dclause)

Enhancements

• Re-introduced auto-wrap for flex containers such as ui.row and ui.column. (#595 by @DavidLeBonk, @falkoschindler)

Thank you to all our contributors!

We are excited to announce the release of NiceGUI 1.2.0! While including many great new features, we want to specially highlight the introduction of a “native” mode which allows Electron-like capabilities by not opening a browser but a native window on your desktop. Of course this can also be packaged into an executable.

Breaking Changes

The implementation of ui.table is no longer based on AG Grid but rather on QTable from Quasar which is in line with the other components. The AG Grid element is still available through ui.aggrid (see #370 and #500 for details; by @dclause, @falkoschindler, @Diegiwg and @rbeeli).

All web dependencies have been upgraded to their most recent stable version (with the exception of Mermaid, which is at 9.x instead of 10.x due to technical reasons). In general, this should not change the behavior of NiceGUI applications (#524 by @dclause and @falkoschindler).

The upgrade of TailwindCSS can, however, change the interpretation of contradicting Tailwind classes: The effective class order has been nondeterministic and using contradicting classes was dangerous and discouraged by the Tailwind developers. Now the order is deterministic such that the result does not change when, e.g., moving the element around. But this could change the behavior of your app if it relies on a certain interpretation order. See this very informative post and this comment for more information.

Other Features and Enhancements

• make NiceGUI the Electron of Python by introducing ui.run(native=True) which will open a desktop window instead of a browser tab (#89, #558, #519 by @eli-kha, @rodja, @al-eax, @smojef, @bobwatcherx, @hditano, @ItsCubeTime and @falkoschindler)
• add point cloud support for 3D scenes (#545 by @kielnino)
• add support for scoped slots (#514, #501 by @dclause and @falkoschindler)
• provide a global exception handler (#289, #445 by @smojef and @falkoschindler)
• allow clearing the content of a ui.log element (#414 by @Allen-Taylor and @falkoschindler)
• allow looping ui.audio and ui.video (#555 by @chook100 and @falkoschindler)

Bug Fixes

• make elements that are ignored by ui.keyboard configurable (#460 by @MrTLMWD and @falkoschindler)
• support 32-bit Windows using the built-in json package instead of orjson (#518, #532 by @rbeeli, @ghuserlb, @rodja and @falkoschindler)

Documentation

• improve documentation for authentication demo (#527 by @Shmuma and @rodja)
• improve explanation of menu placement (#541 by @rodja)
• improve deployment documentation uncovered by experiments with Heroku (#469 by @krummja and @rodja)
• improve script executor demo by fixing asyncio.create_subprocess_exec for Windows (#486 by @wielandb, @spehj and @rodja)
• improve NGINX subpath demo (#245 by @rodja)

New Features and Enhancements

• Added persistent tabs functionality to ui.tabs (Issue #488 by @wwoods)
• Improved opencv_webcam example by respecting IO and CPU, and moving some work off the main thread (Issue #490 by @rodja)

Bug Fixes

• Fixed an issue where installation would fail due to python-multipart-0.0.5 dependency (Issue #504 by @nahakiole)
• Aligned mute and unmute buttons with their actual function in the Audio reference (Issue #503 by @g-bulgarit)
• Fixed an issue where ui.tabs lost state when changing tabs (Issue #488 by @falkoschindler)

Thanks for all the great contributions. We hope you enjoy the new features and improvements in NiceGUI v1.1.11!

New Features

• new ui.knob element (Issue #424 by @Diegiwg).
• new ui.avatar element (Issue #416 by @Diegiwg).
• Support for multiple paths for the same page builder function (Issue #418 by @rodja).
• Added mouse buttons and modifier keys to MouseEventArguments (Issue #444 by @falkoschindler, triggered by #425 from @smojef).
• SSL parameters for ui.run (Issue #421 by @falkoschindler, triggered by #387 from @morningstarsabrina).

Enhancements

• Improved performance and enhanced integration with plotly.js (PR #380 by @rbeeli).
• Automatic string conversion of display methods (Issue #446 by @smojef).

Bug Fixes

• Numerous errors in the example files (Issue #454 by @wielandb).
• Using keyword arguments from Quasar's API in ui.notify() don't work (Issue #458 by @MrTLMWD).

Documentation

• More explanations in the script executor example (Commit fbc878aa)
• Improved authentication example (Commit 4ac21c5 and bdaab55)
• Added Trello-like drag and drop example (Issue #397 by @kausar007).
• Added contribution guide on development with Docker, setup and formatting ((Issue #432 by @rbeeli)).
• Updated description on how to execute the automated tests (Issue #436 by @rbeeli).

Huge thank to all contributors for their valuable help in making NiceGUI better.

New Features

• Introduced a new multiline textarea element (Issue #390 by @falkoschindler).

Documentation

• Improved documentation for server hosting (Issue #355 by @JS-Aibel and @rodja).
• Added documentation for launching NiceGUI app as an executable with PyInstaller (Issue #355 by @JS-Aibel and @rodja).
• Fixed pip dependency conflicts with docutils used on website (Issue #399 by @smojef and @rodja).

Thank you to everyone who contributed to this release, including @JS-Aibel and @smojef. We hope that you will enjoy using NiceGUI 1.1.9!

New Features

• Added support for creating tabs (Issue #251 by @JS-Aibel).
• Added a new component for loading spinners along with an example in the documentation (Issue #368 by @rbeeli).
• Added support for input validation rules (Issue #336 by @falkoschindler).

Documentation

• Improved the documentation for core concepts (Issue #242 by @falkoschindler).
• Extended the documentation with new examples and explanations (Issue #242 by @falkoschindler).

Thank you to everyone who contributed to this release, including @JS-Aibel, and @rbeeli. We hope that you will enjoy using NiceGUI 1.1.8!

Fixes

• Drawers now behave correctly thanks to the resolution of #308.
• Disabling Tailwind no longer causes a JavaScript runtime error. (#369)

Enhancements

• NiceGUI now integrates with Plotly.py, adding more visualization options. (#317, thanks @misterkramer)
• The AG Grid table's getSelectedRows function is now exposed for easier use. (#363, thanks @Diegiwg)

Documentation

• Documentation and type-hinting have been added to the base element class ui.element to improve the overall developer experience. (#356, thanks @washad)

We would like to extend a special thank you to @misterkramer, @Diegiwg, and @washad for their contributions to this release.

Enhancements

• Improved the update performance for large UIs on slow machines (#338). The internal implementation on when we send out updates has changed quite a lot. Reach out if you experience any upgrade problems.
• Improved the performance for parsing props, classes and style (#341)
• Side panel on the reference page for more overview (towards #242)
• integrated Mermaid with ui.mermaid() and inside markdown (see reference for an example); thank you @SebastienDorgan for contributing (#278, #277)

<img width="794" alt="mermaid" src="https://user-images.githubusercontent.com/131391/218241939-4cf3ce32-527f-476f-ad32-dc86ea728fa9.png">

Examples

• showing expanding/collapsing a drawer plus using tabs in layout (#308)
• demonstrating search-as-you-type (related to #272)
• opening a dialog for selecting files locally on the server (#283)

Bugfixes

• Tailwind dark: prefix does not work (#311)

Thanks to all contributors who helped make this release possible. As always, if you encounter any issues or have any feedback, please don't hesitate to reach out to us.

• improve initialization of ui.interactive_image to avoid "Too many packets in payload" (#209, #320)
• prevent ui.input, ui.number, and ui.color_input from dropping keys when typing fast (#287, #306, thanks @FI-Mihej for the pull request)
• fix camera's look_at target in 3D scene (#296)
• replace dummy images for API reference (#314)
• catch WebGL exception in ui.scene and show error message (#315, #325)
• allow creating UI elements within app.on_startup (#316)
• improve stability of pytests (#321)
• cleanup background_tasks and introduce create_lazy() (#323)
• allow opening and closing ui.expansion programmatically (#330)
• improve node selection, expansion, and ticking events in ui.tree (#331)
• fix initialization of ui.input, ui.number, and ui.color_input without label or placeholder
• fix awaiting a ui.dialogin Python <=3.9
• fix legibility of the connection popup in dark mode

New Features and Enhancements

• allowing async callbacks for generic events: Element.on() (#285, #305)
• mobile friendly display by setting viewport (#274, thanks @jfroco for the pull request)
• introduction of date/time pickers ui.date and ui.time (#270, #263)
• improved ui.log: Now new clients see previously pushed lines. And reloading the browser does not clear the log. (#288, #292)
• better error message when running NiceGUI with main guard (#286)
• support listening for all kinds of keys and modifiers through ui.input.on() (#276)
• allow creating different types of Highcharts (for example stockChart) (#284)
• better support for password input (#271)
• links can now be opened in a new tab (#273)

Bugfixes

• removed unexpected outline when interacting with keyboard (#298)
• fixed missing font (#295)

• fixed AttributeError: module 'nicegui.globals' has no attribute 'tailwind' (#244)
• improved memory management in edge cases

• improved shutdown behaviour (#238)
• introducing app.remove_route()
• introducing getElement() JavaScript function (#230)
• showing popup when connection is lost (#199, #239)
• fixed memory issues
• using process name to identify spawned process (#189)
• allow disabling tailwind (#231, still experimental since it impacts layout and style of built-in elements)
• improved documentation
• avoid duplicate favicon routes for index page (#240)

Breaking Changes

• using Quasar Uploader for ui.upload (#227, #220)
• reworked lifecycle functions (#232, #234)
  • adding on_connect() and on_disconnect() functions to client
  • renamed await client.handshake() to await client.connected()
  • introduce await client.disconnected()
  • providing app.on_connect() and app.on_disconnect() functions which are called for every client
  • move on_startup(), on_shutdown() and add_static_files() from ui into app

Other Changes

• hold references to tasks in task_logger to prevent garbage collection (#236, #237)
• fixed argument list for table.call_api_method() (#233)
• add support for checkboxRenderer in ui.table (#228)
• allow running NiceGUI without Tailwind (#231)

• Prevent object duplication in ui.scene when using without page decorator (#218)
• Fixed favicon routes for pages that are created during or after startup (#222)
• Allow using HTML in ui.table (#217)
• Support ui.run_javascript within ui.on_connect (#219)

• Fixing lost state changes with ui.timer (#207, #206)
• Caching markdown to speed up repeated requests (#205)
• Allow to load Highcharts "extra" libraries like solid-gauge (#210, #211)
• Fixing dynamically adding/removing chart series (#208)
• Adding svg clock example

changes

• update table by replacing whole DOM element #204
• added OpenCV webcam example
• more documentation for ui.interactive_image

internals

• fixed some mypy errors
• removing client references when timer terminates
• auto-pruning slot stacks

• add support for aggrid table events #202
• fix memory issue: release objects when clients disconnect

• fix ui.plot on auto-index page

• fix scene.move_camera() having no effect #200
• introduce ui.video and ui.audio #201

• fixed memory leak in ui.line_plot #124
• fixed favicon for deep paths #194
• updated quasar doc links (thanks, @hroemer)

• remove deprecated lastModifiedDate in ui.upload #193
• introduced nicgui.globals.socket_io_js_extra_headers to provide extra headers for the javascript socket.io connection
• using the above variable to enable sticky connections for our fly.io deployment

NiceGUI version 0.9.28 is a bugfix release that resolves compatibility issues with the old 0.9 version. Thanks to the effort of @me21, this release addresses conflicts caused by the required cryptography version, which affected users running Debian Buster with only version 37.0.4 (see #374). We recommend upgrading to this latest release to avoid any compatibility issues.

• compatibility with debian buster (#374 and #375)

• support async JavaScript commands
• add reset() method for ui.upload
• bugfixes
• documentation improvements
• fix security alerts

• introduce ui.link_target
• introduce ui.badge
• add support for internal validation rules for input elements

Ensuring that the public docker image has the right version.

• new elements (special thanks to @hroemer for contribution #107):
  • ui.linear_progress
  • ui.circular_progress
• allow content binding for ui.markdown and ui.html
• improved docker image
• introduction of remove(element) method on groups (eg. column, row, card, ...) #145

• auto-update page before each await in a generator-style page (see #142 and #131)
• use Python 3.11 in tests and for the public docker image
• update ui.plot when leaving its context
• improved consistency of ui.update and element.update
• new example: infinite scrolling