v2.0.1

Fix: Resolve dependency mismatch with nicegui-highcharts

v2.0.0

New features and enhancements, breaking changes and migration guide

This major release introduces several new features and enhancements, as well as breaking changes. We always try to keep breaking changes to a minimum, guide you through the migration process using deprecation warnings, and provide migration instructions. Please read the following release notes carefully to understand the changes and adapt your code accordingly before upgrading.

• Semantic versioning

  NiceGUI 2.0 starts to implement semantic versioning, which means that we will follow the MAJOR.MINOR.PATCH versioning scheme. This release is a major version because it introduces breaking changes. We will increment the MAJOR version for breaking changes, the MINOR version for new features and enhancements, and the PATCH version for bug fixes.

• Fix Quasar's layout rules for ui.card that remove children's borders and shadows (#726, #1295, #2265, #2301, #3444 by @miqsoft, @v479038280, @ghbm-itk, @falkoschindler)

  ⚠️ BREAKING: Quasar's QCard, the foundation of NiceGUI's ui.card, usually comes without any padding and requires nested card sections wrapping the actual content. NiceGUI simplified the use of cards by adding padding, flex layout and gaps automatically. But because a QCard also removes the outer-most borders and shadows of its children, this caused unexpected results in certain cases. NiceGUI 2.0 fixes the behavior of ui.card by disabling Quasar's respective CSS rules.

• Improve the API of ui.table (#2633, #2731, #3263, #3264, #3525 by @bojh, @rohitsathish, @tmlmt, @falkoschindler)

  ⚠️ BREAKING: The API for adding and removing rows in a ui.table has been improved. Passing rows as multiple arguments has been deprecated. Now these methods expect lists of rows.

  The column argument for ui.table is optional now. If not provided, the columns are infered from the first row.

  A new update_from_pandas method has been introduced to update rows and columns from a new dataframe.

  A new column_defaults parameter has been introduced to allow specifying some properties for all columns at once.

• Improve support for drawing items in ui.leaflet (#2422, #3586 by @joseph-fidelis, @falkoschindler)

  ⚠️ BREAKING: The ui.leaflet element used to remove drawn items and required the user code to add new layers to the map for visualization. Now such items remain visible by default. This new behavior can be disabled by passing hide_drawn_items=True to ui.leaflet.

• Unify declaration of third-party dependencies (#2991 by @falkoschindler, @rodja)

  ⚠️ BREAKING: This release deprecates the libraries, extra_libraries and exposed_libraries parameters for subclassing ui.element. It introduces a new dependencies parameter to be used instead. New examples "Custom Vue Component" and "Signature Pad" demonstrate how to use NPM and this parameter for integrating custom components based on third-party JavaScript libraries.

• Reserve bottom space in validation elements for error messages (#2484, #2492, #2738, #3013, #3446, #3660 by @akai-1024, @huche6, @atticus-lv, @rodja, @falkoschindler)

  ⚠️ BREAKING: UI elements with input validation like ui.input used to omit the bottom space for a potential error message. This caused a layout jump when the first error occurred. This release fixes this issue be reserving the space by default whenever the validation argument and property is not None. You can disable this behavior using the "hide-bottom-space" prop.

• Remove ui.timer objects from UI hierarchy after they are finished (#3626, #3647 by @fwerner, @rodja)

  Especially one-shot timers are now removed from the UI hierarchy after their callback has been executed. This avoids a potential memory leak.

• Disable FastAPI docs by default (#3570, #3589 by @Yuerchu, @python-and-fiction, @rodja)

  ⚠️ BREAKING: NiceGUI apps used to automatically serve FastAPI docs at /docs, /redoc, and /openapi.json. This behavior has been disabled. You can enable it by passing fastapi_docs=True to ui.run. Furthermore, you can specify the individual routes by setting core.app.docs_url, core.app.redoc_url, and core.app.openapi_url.

• Make client.ip available before socket connection is established (#2399, #3287, #3445 by @rodja, @falkoschindler)

  ⚠️ BREAKING: The client's IP is now already available before the page built and is returned to the client. On the auto-index page the client.ip property is None. If you need to check if the socket connection is established, use client.has_socket_connection instead.

• Remove and update deprecated APIs (#3648 by @falkoschindler)

  ⚠️ BREAKING: Several deprecated APIs have been removed. The remaining deprecations will show warnings including the version when they will be removed. Please update your code accordingly.

  • ui.run_javascript() and related methods:
    The respond and check_interval parameters are not needed anymore and got removed.
  • context:
    The get_slot_stack() method has been replaced with the slot_stack property.
    The get_slot() method has been replaced with the slot property.
    The get_client() method has been replaced with the client property.
  • Layout elements ui.header, ui.footer, ui.drawer, ui.left_drawer and ui.right_drawer:
    Nesting top level layout elements now raises a RuntimeError.
  • Storage:
    NiceGUI no longer migrates files from the system's default encoding to UTF-8. This was only a temporary migration. All storage files should be encoded with UTF-8 by now.
  • ui.aggrid:
    The method call_api_method has been replaced with run_grid_method.
    The method call_column_method has been replaced with run_column_method.
  • ui.chart is now ui.highchart.
  • ui.open has been replaced with ui.navigate.to.
  • ui.add_style has been removed. Use ui.add_css, ui.add_scss, or ui.add_sass instead.

Documentation and examples

• Use newer langchain package (#3595 by @rodja)

Python Dependencies

• Bump ruff from 0.6.2 to 0.6.3 (#3646 by @dependabot)
• Bump plotly from 5.23.0 to 5.24.0 (#3645 by @dependabot)
• Bump FastAPI from 0.109.2 to 0.112.2 and remove the upper bound (#3384, #3499, #3519, #3604, #3622, #3623 by @pierrecdn, @dependabot, @aersam)

JavaScript Dependencies

The following JavaScript dependencies have been updated to the latest versions (#3654 by @falkoschindler):

• Vue: 3.3.6 → 3.4.38
• Quasar: 2.13.0 → 2.16.9
• TailwindCSS: 3.2.0 → 3.4.10 (resolves #3169 and #3176)
• Socket.IO: 4.7.2 → 4.7.5
• ES Module Shims: 1.8.0 → 1.10.0
• AG Grid: 30.2.0 → 32.1.0 (resolves #3393 and #3538)
• CodeMirror: 6.0.1 (unchanged)
• ECharts: 5.4.3 → 5.5.1
• ECharts-GL: 2.0.9 (unchanged)
• Leaflet: 1.9.4 (unchanged)
• Leaflet-draw: 1.0.4 (unchanged)
• Mermaid: 10.5.1 → 11.0.2
• nippleJS: 0.10.1 → 0.10.2
• Plotly: 2.27.0 → 2.35.0 (resolves #3086)
• three.js: 0.157.0 → 0.168.0
• tween.js: 21.0.0 → 25.0.0
• vanilla-jsoneditor: 0.18.10 → 0.23.8

Many thanks to all contributors and users who reported issues and provided feedback. We hope you enjoy this new release!

v1.4.37

New features and enhancements

• Provide a public API for accessing _props, _classes and _style (#3588 by @falkoschindler, @marcuslimdw)
• Introduce IconElement mixin to allow binding the icon of various elements (#3596, #3600 by @WolfgangFahl, @falkoschindler)
• Provide sorted and filtered rows from ui.aggrid via get_client_data() (#3581, #3582 by @JeppeKlitgaard, @falkoschindler)
• Use correct version for citation file (#3587 by @falkoschindler)

Bugfixes

• Warn about accessing the clipboard in non-secure environments (#3564, #3636 by @JeppeKlitgaard, @falkoschindler)
• Ensure cv2.VideoCapture is only called once (#2321, #3619 by @jiang131072, @rodja)
• Allow testing NiceGUI apps without selenium being installed (#3510, #3511, #3585 by @marcuslimdw, @falkoschindler, @rodja)
• Fix ui.page_title() in native mode (#3583 by @MastSE, @python-and-fiction, @rodja, @falkoschindler)
• Delay events before handshake (#3530, #3580 by @vmlstandard, @rodja, @falkoschindler)
• Fix support for creating background tasks from awaitables (#3579 by @falkoschindler)
• Fix user and group IDs in the docker image (#3437, #3567 by @zan73, @rodja)

Documentation

• Add a demo about toggling the theme with ui.aggrid (#3611, #3612 by @mxiaonian, @python-and-fiction, @falkoschindler)
• Add possible values for align_items in ui.row, ui.column and ui.card (#3602 by @frankhuurman, @falkoschindler)
• Fix typo in the "Descope Auth" example (#3593 by @deeppunster)
• Add a demo about customizing a ui.color_picker (#3571 by @zobac, @falkoschindler)
• Add a section about testing complex elements with the User simulation (#3616, #3635 by @zx000097, @rodja, @falkoschindler)

Dependencies

• Bump watchfiles from 0.23.0 to 0.24.0 (#3634 by @dependabot)
• Bump selenium from 4.23.1 to 4.24.0 (#3633 by @dependabot)
• Bump pytest-watcher from 0.4.2 to 0.4.3 (#3632 by @dependabot)
• Bump httpx from 0.27.0 to 0.27.2 (#3615 by @dependabot)
• Bump ruff from 0.6.1 to 0.6.2 (#3574 by @dependabot)
• Bump pytest-asyncio from 0.23.8 to 0.24.0 (#3573 by @dependabot)

v1.4.36

New features and enhancements

• Defer some rarely used imports to reduce startup times (#3533, #3548, #3559, #3562 by @ed2050, @falkoschindler)
• Simplify sizing and styling of ui.joystick (#1707, #3531, #3546 by @LarsEggimann, @python-and-fiction, @falkoschindler)

Bugfixes

• Fix auto_close = False for ui.context_menu (#3539 by @gavinpotter, @falkoschindler)
• Fix events on hidden and disabled elements (#3522, #3524 by @Noghpu, @python-and-fiction, @falkoschindler)
• Fix duplicate objects in ui.scene when reloading the page (#3339, #3452 by @afullerx, @falkoschindler)
• Fix JavaScript errors when emitting certain events On Air (#3561 by @falkoschindler, @rodja)

Documentation

• Link to a new example for FullCalendar with plugins (#3526, #3553 by @dorel14, @rodja)

Dependencies

• Bump aiohttp from 3.10.3 to 3.10.5 (#3543 by @dependabot)
• Bump pywebview from 5.1 to 5.2 (#3542 by @dependabot)
• Bump ruff from 0.5.7 to 0.6.1 (#3520, #3528 by @dependabot)

v1.4.35

New features and enhancements

• Improvements to ui.tree:
  • Allow filtering nodes (#3436, #3481, #3482 by @MohAid, @falkoschindler)
  • Allow selecting and ticking nodes programmatically (#3436, #3476 by @MohAid, @arunaseva, @falkoschindler)
• Improvements to ui.scene:
  • Allow updating a point cloud (#3468 by @voigta, @falkoschindler)
  • Allow specifying the list of click events (#3451, #3463 by @h0uter, @falkoschindler)
  • Allow subscribing to the "drag" event (#3450, #3466 by @h0uter, @frankvp11, @falkoschindler)
  • Introduce get_camera to get the current camera parameters (#3459, #3465 by @thaije, @falkoschindler)
• Support ui.select elements for user simulation tests (#3486, #3487 by @marcuslimdw, @rodja, @falkoschindler)
• Provide two additional pytest plugins to make user and screen able to load independently (#3510, #3511 by @marcuslimdw, @rodja)
• Add dependabot configuration and bump dependencies (#3393, #3453, #3489, #3490, #3491, #3492, #3493, #3495, #3496, #3497, #3498, #3501, #3502, #3503, #3504, #3505 by @gaby, @falkoschindler, @dependabot)

Bugfix

• Fix JavaScript error caused by new ui.notify (#3454, #3457 by @falkoschindler)

Documentation

• Fix demos awaiting JavaScript responses (#3472, #3517 by @v479038280, @python-and-fiction, @falkoschindler)
• Add documentation for the create_user fixture (#3512 by @rodja)

v1.4.34

Bugfix

• Fix missing dependency in Docker image (@falkoschindler, @codingpaula)

v1.4.31

New features and enhancements

• Introduce a new integration test framework (#1931, #2496, #3121, #3413 by @rodja, @ed2050, @MarcDelahousse, @codingpaula, @falkoschindler):
  • a new user fixture cuts away the browser and replaces it by a lightweight simulation entirely in Python; a test for a login page can now be written like this:

          async def test_login():
              await user.open('/')
              user.find('Username').type('user1')
              user.find('Password').type('pass1').trigger('keydown.enter')
              await user.should_see('Hello user1!')
              user.find('logout').click()
              await user.should_see('Log in')

  • a new ElementFilter allows to find and manipulate UI elements during tests and in production
  • a new pytest plugin allows to use both NiceGUI fixtures screen and user via pytest_plugins = ['nicegui.testing.plugin']
• Remove icecream dependency (#3439 by @falkoschindler)
• Provide tests for run.io_bound and run.cpu_bound (#2234 by @rodja, @falkoschindler)

Documentation

• Add more links to the documentation (#3434 by @rodja)
• Improve the documentation overview (#3409 by @rodja)
• Say browser session cookie is "signed", not "encrypted" (#3424 by @NickCrews)
• Restrict access to all routes in the "Authentication" example (#3403, #3417 by @Daniel-Fei, @falkoschindler, @rodja)

v1.4.30

New features and enhancements

• Introduce get_computed_prop method for any UI element; provide computed, filtered and sorted rows for ui.table (#3395 by @srobertson86, @falkoschindler)
• Support app.shutdown() even for ui.run(reload=True) (#3320 by @NiklasNeugebauer, @python-and-fiction, @falkoschindler)
• Allow pretty-printing storage JSON files (#3367, #3396 by @sseshan7, @falkoschindler)

Bugfixes

• Update ui.number after sanitization (#3324, #3389 by @eddie3ruff, @python-and-fiction, @falkoschindler)
• Fix value updates in ui.editor after client-side changes (#1088, #3217, #3346 by @tjongsma, @falkoschindler, @frankvp11, @python-and-fiction)

Documentation

• Improve notes about contributing (#3390 by @codingpaula, @falkoschindler)
• Add info about failing pre-commit hook (#3362 by @rodja)
• Fix parameter description for input validation (#3350 by @python-and-fiction, @falkoschindler)
• Extend tooltip documentation (#3322, #3331, #3338 by @FSchmidt-FUNKE, @python-and-fiction, @rodja, @falkoschindler)

v1.4.29

New features and enhancements

• Support named slots in Element.move() (#3319 by @NiklasNeugebauer, @falkoschindler)
• Add pytest-watcher dependency to the devcontainer (#3327 by @rodja)

Bugfixes

• Enforce amd64 platform for devcontainer to fix chromedriver on Mac (#3328 by @rodja)
• Fix misleading error message if storage secret is set (#2520, #3273, #3310 by @dr-yd, @kwmartin, @Bacoknight, @Dan1001, @erdincka, @j4nSolo, @MaiHoangViet1809, @bin-san, @python-and-fiction, @falkoschindler, @rodja)
• Ignore CancelledError in check_for_late_return_value (#3268, #3296 by @CatamountJack, @falkoschindler)

Documentation

• Add documentation about BindableProperty for better binding performance (#1975, #3325, #3333 by @eponymic, @v479038280, @python-and-fiction, @falkoschindler)
• Fix link to Quasar's Tab Panels (#3329 by @rodja)
• Add ui.teleport demo for placing charts in table cells (#3309 by @frankvp11, @falkoschindler)
• Provide info on how to run the docs locally (#3304, #3305 by @DeflateAwning, @python-and-fiction, @rodja)

v1.4.28

New features and enhancements

• Add request object to the client (#1695, #2399, #3286 by @DoPaminexL, @rodja, @falkoschindler)
• Introduce ui.skeleton (#3082, #3202 by @patrickwasp, @frankvp11, @falkoschindler)
• Added support for 3D graphing for ui.echart (#3184, #3195 by @natankeddem, @falkoschindler)
• Add min, max and step properties to ui.range (#3167, #3191, #3242, #3260 by @bojh, @falkoschindler, @Ezbaze)
• Allow changing grid parameters of ui.scene (#3254, #3257 by @v479038280, @python-and-fiction, @falkoschindler)

Bugfixes

• Fix SVG of ui.pyplot not filling its container (#3277, #3289 by @Guilhermwn, @python-and-fiction, @falkoschindler)
• Fix change event value of ui.number differing from value property (#3110, #3142, #3281 by @CrystalWindSnake, @Lucas-lyh, @frankvp11, @falkoschindler)

Documentation

• Add demos for using ui.refreshable with local scope (#2535, #3219, #3233, #3279 by @Ezbaze, @ruisilvestre-snapp, @arunmp25, @falkoschindler, @rodja)
• Add demo for ui.upload with large files (#3220, #3235 by @Rjdrenth)
• Add demo on how to use ui.teleport for fancy radio options (#3224, #3230 by @pierrecdn, @rodja)
• Improve date picker demo with input element and add similar demo for time picker (#3155, #3226 by @tmlmt)
• Add details and examples in docs for running apps with https (#3155, #3213 by @tmlmt, @rodja)