Skip to content

Latest commit

 

History

History
1292 lines (691 loc) · 36.7 KB

File metadata and controls

1292 lines (691 loc) · 36.7 KB

CHANGELOG

v3.12.3 (2026-05-26)

Bug Fixes

  • testing: Fix assert_images_match (f7df995)

Fix assertion error in assert_images_match where was asserted that the total number of mismatched pixels between the two images was inferior to a float between 0.0 and 1.0

Chores

Continuous Integration

v3.12.2 (2026-05-11)

Bug Fixes

  • user-script: Remove invalid version (94bed56)

Chores

Update pre-commit configuration to align with latest trame standards

v3.12.1 (2026-04-29)

Bug Fixes

  • ws: Enable ws proxy via MessageChannel (1af1f5d)

v3.12.0 (2026-04-29)

Continuous Integration

  • tests: Update python version (dfa0b05)

Features

  • Handler: Add a client script dispatcher widget (8b8aa26)

This new Handler widget aims to allow library consumers to register JS module files with minimal boilerplate, and later call functions defined in those registered scripts at runtime in the trame client. Scripts can be either ES or UMD modules and can be registered from the local filesystem or remote URL.

v3.11.4 (2026-03-24)

Bug Fixes

  • decorators: Gracefully Handle File Read Errors (#53, f330811)

Used so files with read errors don't halt execution, instead are handled gracefully and submitted to the server

Chores

  • js: Add type definitions to js-lib (d2512ff)

  • js: Advance @kitware/trame to v1.0.0 (b558e1d)

  • js: Remove vtk.js dependency from js-lib (ba2b813)

v3.11.3 (2026-02-19)

Bug Fixes

  • exit: Close websocket on exit (e8524b4)

v3.11.2 (2025-10-08)

Bug Fixes

  • layout: Add template name property in AbstractLayout (#48, 852a461)

Co-authored-by: Justine Antoine justine.antoine@kitware.com

v3.11.1 (2025-10-06)

Bug Fixes

  • input: Support webkitdirectory (2c084c8)

Add support for webkitdirectory parameter for Input element

v3.11.0 (2025-10-02)

Features

  • connect_parent: Add flag to disable auto widget connection (5ef388f)

v3.10.4 (2025-09-23)

Bug Fixes

  • Change selenium requirement to playwright (1870469)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

v3.10.3 (2025-09-23)

Bug Fixes

Signed-off-by: Patrick Avery patrick.avery@kitware.com

Continuous Integration

  • playwright: Use playwright for tests instead of selenium (cdd2e01)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

v3.10.2 (2025-09-11)

Bug Fixes

  • Add default slot to components (fbcdeea)

v3.10.1 (2025-08-18)

Bug Fixes

  • retry: Provide empty retry array in html (9e7ee79)

v3.10.0 (2025-08-18)

Features

  • launcher: Enable retry option on launcher (8b1ae2d)

v3.9.2 (2025-08-04)

Bug Fixes

  • js: Allow script/css loading failure (e46ccf3)

v3.9.1 (2025-06-04)

Bug Fixes

  • widget: Add getter/setter definition (3aced83)

v3.9.0 (2025-05-09)

Bug Fixes

  • html: New generated html widgets (c2e5c84)

Features

  • html: Update html/vue available components (b3652d2)

v3.8.2 (2025-05-06)

Bug Fixes

  • event: Remove scroll, resize, select from default (804206e)

v3.8.1 (2025-04-28)

Bug Fixes

  • model/bind/event: Fix event and directive processing (c6f6138)

  • mouse-event: Add missing enter/leave (dadd593)

v3.8.0 (2025-04-24)

Documentation

Features

  • v_on: Better handling events modifiers (942cbe3)

v3.7.1 (2025-04-10)

Bug Fixes

  • DeepReactive: Delete removed key (00417f4)

v3.7.0 (2025-04-08)

Features

  • vue3: Update vue.js to v3.5.13 (acdb5f0)

Co-authored-by: Justine Antoine justine.antoine@kitware.com

v3.6.1 (2025-03-24)

Bug Fixes

  • vue2-app: Fix URL params reading (0a6d33a)

v3.6.0 (2025-02-26)

Documentation

  • js: Add doc string to JS API (5c81263)

  • js-lib: Update library to fix js-doc annotation (533fbfd)

Features

  • TrameComponent: Provide helper class to handle method decoration (53390eb)

v3.5.2 (2025-01-20)

Bug Fixes

  • test: Fix test helpers for Windows (cd4b0d4)
  • Use full current python path when running Selenium server python process * Fix port parsing in xprocess logs for Windows * Add option to disable log prints to avoid test clutter

Continuous Integration

  • Skip changelog for codespell (15c968d)

Documentation

v3.5.1 (2024-12-30)

Bug Fixes

  • ci: Use pyproject and ruff (279a0c8)

v3.5.0 (2024-11-18)

Features

v3.4.0 (2024-10-20)

Features

  • DeepReactive: Add vue3 component to enable deep reactivity (3ea4dc9)

v3.3.2 (2024-09-24)

Bug Fixes

  • child-server: Add support for child server in SizeObserver/Style/Script (ff498fd)

v3.3.1 (2024-09-20)

Bug Fixes

  • script: Add script tag to client widgets (1e94bdf)

v3.3.0 (2024-09-20)

Bug Fixes

  • translation: Auto translate state names in event too (46a2c74)

Features

  • url: Can request url on layout when server started as task (f0584c1)

v3.2.5 (2024-08-15)

Bug Fixes

  • security: Clean url from trame search params (f0e093b)

Code Style

v3.2.4 (2024-08-14)

Bug Fixes

  • SharedArrayBuffer: Disable by default service worker (92e0659)

v3.2.3 (2024-08-13)

Bug Fixes

  • api: Add doc to method definition (7bdb00a)

v3.2.2 (2024-08-07)

Bug Fixes

  • base: Use for relative url resolution (1e42189)

v3.2.1 (2024-07-02)

Bug Fixes

  • numpy: Add support for numpy 2.0 (b45403b)

v3.2.0 (2024-06-19)

Features

  • SharedArrayBuffer: Enable by default while adding a disable option (49df5ed)

  • vue2: Add support for module scripts (9535d20)

v3.1.1 (2024-06-19)

Bug Fixes

  • ready: Remove unused future (9b1eb0c)

Chores

  • js-lib: Add starting point (6f64052)

  • js-lib: Update version (2358431)

Continuous Integration

  • js-lib: Add missing new keyword (0a1bf78)

  • js-lib: Auto publish (4d6cc61)

  • js-lib: Bump version to rename exported object (557d1c4)

  • js-lib: Fix publication automation (539f09f)

  • js-lib: Try publishing library (c877746)

Documentation

  • js-lib: Fix vite example (cc8ef8f)

v3.1.0 (2024-05-31)

Features

  • widget: Add state/ctrl/context property (d12b475)

v3.0.3 (2024-05-16)

Bug Fixes

  • jupyter: Allow jupyter-hub to be autodetected (4ec5db2)

v3.0.2 (2024-04-17)

Bug Fixes

  • SizeObserver: New network don't properly handle native js type (d9f9871)

v3.0.1 (2024-04-12)

Bug Fixes

  • ClientTriggers: Add built-in exit event (0103d30)

Continuous Integration

v3.0.0 (2024-04-10)

Bug Fixes

  • msgpack: Convert msgpack Uint8Array into blob for backward compatibility (566c274)

  • wslink: Simplify file upload helper by removing chunking (f87d8de)

BREAKING CHANGE: this requires the new chunking wslink

Continuous Integration

  • Disable test due to cross version dep (aabb2de)

Features

  • wslink: Use msgpack and chunking for ws data exchange (77e17f5)

BREAKING CHANGE: use wslink>=2 that deeply change network handling

BREAKING CHANGES

  • wslink: Use wslink>=2 that deeply change network handling

v2.17.1 (2024-04-05)

Bug Fixes

  • jupyter-hub: Fix url generator and add auto detect (3da386c)

v2.17.0 (2024-04-04)

Continuous Integration

Features

  • client: Add ClientStateChange/ClientTriggers/LifeCycleMonitor/SizeObserver (5fa7fcf)

v2.16.5 (2024-03-26)

Bug Fixes

  • template: Properly template name mapping (589991f)

v2.16.4 (2024-03-20)

Bug Fixes

  • loading: Use fetch instead of iframe (d21b992)

v2.16.3 (2024-03-13)

Bug Fixes

  • Uniform init.py for package (589e617)

v2.16.2 (2024-03-03)

Bug Fixes

  • template: Allow template name with underscore (dedd0aa)

replace underscore with - to be vue.js compatible

fix #465

v2.16.1 (2024-02-16)

Bug Fixes

  • docs: Fix typo in CHANGELOG.md (9f1542a)

  • vue3: Fix vue3 components remounting every time a key is added to state (417a71f)

v2.16.0 (2024-02-14)

Features

  • loading: Enable loading screen to be overriden (9d13b21)

For that just provide your own ./loading/index.html

Then in vue3, you can also override dynamically the error view for disconnect or disconnect-with-reconnect. You just need to define layout for "error" and "error_reconnect". Also a variable "trame_error_report_msg" will be available for you to leverage in your custom template.

v2.15.0 (2024-01-17)

Features

  • raw_attrs: Widgets support raw_attrs at construction (131618a)

v2.14.2 (2023-12-29)

Bug Fixes

  • translation: Proper type handling with state translation (37b0e08)

v2.14.1 (2023-12-12)

Bug Fixes

  • debug: Add helper for finding invalid args (d1d5c8f)

v2.14.0 (2023-12-08)

Bug Fixes

  • py: Remove python 3.9 requirement (17f2029)

Continuous Integration

  • tests: Add trame-server as a dependency (ed23fc4)

Features

  • translator: Template patching via translator (350bd63)

Testing

  • translator: Improve Translator tests (d7c99f7)

v2.13.0 (2023-12-01)

Features

  • widget: Allow style attr to be dict (11f4ca5)

v2.12.7 (2023-11-27)

Bug Fixes

  • jupyter: Iframe builders return a dict instead of a str (083b046)

v2.12.6 (2023-10-19)

Bug Fixes

  • WebModule: Add helper for serving web content (501caec)

v2.12.5 (2023-10-06)

Bug Fixes

  • global: Expose state methods on global trame.state (0238651)

v2.12.4 (2023-10-05)

Bug Fixes

  • ipywidget: Can skip ipywidget even if available (091410b)

v2.12.3 (2023-10-05)

Bug Fixes

  • jupyter: Better base url handling with extension (fdc7156)

v2.12.2 (2023-10-04)

Bug Fixes

  • jupyter: Allow base url to be customized (547b388)

v2.12.1 (2023-10-03)

Bug Fixes

  • js: Handle exception when accessing cross-origin parent window (9f12f69)

  • jupyter: Kernel generate www when collocated with server (c883fae)

v2.12.0 (2023-09-28)

Features

  • jupyter: Add support for jupyter extension (6d2bc50)

v2.11.3 (2023-09-07)

Bug Fixes

  • router: Add infrastructure to handle routes for vue3 (021f871)

v2.11.2 (2023-08-14)

Bug Fixes

  • vue3: Getter helper is now working (0008761)

v2.11.1 (2023-08-10)

Bug Fixes

  • directive: Add helper to register directives (e2add71)

v2.11.0 (2023-08-10)

Features

v2.10.0 (2023-07-19)

Features

  • vue3: Update vue version to latest (d49445c)

v2.9.4 (2023-06-23)

Bug Fixes

  • testing: Add utilities functions (68c8509)

v2.9.3 (2023-06-23)

Bug Fixes

  • testing: Add more testing helper (c5a4d9c)

v2.9.2 (2023-06-16)

Bug Fixes

  • testing: Allow enable_testing to be used as decorator (ce6f784)

v2.9.1 (2023-06-16)

Bug Fixes

  • testing: Add testing utilities (a1c9c5c)

Chores

Signed-off-by: Patrick Avery patrick.avery@kitware.com

Continuous Integration

  • selenium: Add dependencies (5524dc5)

  • server: Better management of port extract (2ce2c25)

  • test: Add selenium test (28657da)

  • test: Add trame as dependency (03b4e3b)

  • test: Explicitly use window (b57a62a)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

  • test: Remove vue3 tts validation (0c814d1)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

  • tests: Add back tts test (85e8d9a)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

  • tests: Add ref/js_call testing (36de070)

  • tests: Build vue components before running tests (d1b7039)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

  • tests: Comment out failing tests for now (2ec90a3)

We should fix these soon, though.

Signed-off-by: Patrick Avery patrick.avery@kitware.com

v2.9.0 (2023-06-08)

Features

  • jupyter: Add display support for layouts (5373ac8)

v2.8.0 (2023-05-24)

Features

  • widget: Remove attribute when setting to None (2f827cb)

v2.7.7 (2023-05-15)

Bug Fixes

  • Getter: Expose name, update(value), updateNested(path, value) (257669d)

v2.7.6 (2023-05-15)

Bug Fixes

  • getter: Enable reactive handling of dynamic name value (0576edd)

v2.7.5 (2023-03-27)

Bug Fixes

  • kwargs: Fix handling of vue2 of kwargs (28c463e)

  • kwargs: Fix handling of vue3 of kwargs (2e8815e)

Documentation

  • example: Make dynamic template hot reloadable (9dc58d4)

v2.7.4 (2023-03-06)

Bug Fixes

  • html: Add v-slot and v-model modifier (1863cc0)

v2.7.3 (2023-02-26)

Bug Fixes

  • vue3: Destruct from window (9350e37)

v2.7.2 (2023-02-26)

Bug Fixes

  • vue3: Keep template syntax similar to vue2 (c6778bc)

Documentation

  • examples: Update vue3 template without .value (276c389)

v2.7.1 (2023-02-22)

Bug Fixes

  • layout: Keep track of the original root (66355b3)

v2.7.0 (2023-02-14)

Features

  • vue2: Properly expose vue 2.7.14 for composition API (0371a12)

v2.6.3 (2023-02-13)

Bug Fixes

  • vue2.7: Include composition API in vue2 (ead4c74)

v2.6.2 (2023-02-13)

Bug Fixes

  • vue3: Add support for ref/js_call (ec983ff)

Documentation

  • readme: Cleanup for vue2-3 (3846b2c)

v2.6.1 (2023-02-11)

Bug Fixes

  • default-var: Allow right default to be a dict to update many vars (ca7a5dc)

  • vue3: Fix client update for client_only props (093cecd)

v2.6.0 (2023-02-09)

Bug Fixes

  • py: Removed unused component from Python (d581e43)

  • refs: Start on js_call/ref handling (3aa2c53)

  • vue2: Rename components to match vue3 trame ones (ae98400)

  • vue2/3: Parity (0d91ded)

Continuous Integration

  • codespell: Skip public/*.js (2c9533a)

  • codespell: Utils/vtk/index.js for pixelX (463e2bd)

  • vue2/3: Update path (fdb9c43)

Documentation

  • example: Add client widgets example (e81909f)

Features

  • vue3: Add support for vue@3 (423599b)

v2.5.1 (2023-01-27)

Bug Fixes

  • version: Add trame_client.version (0b970b5)

The get_version() function added here will also be used in all other trame-* packages.

Partially addresses Kitware/trame#183

Signed-off-by: Patrick Avery patrick.avery@kitware.com

v2.5.0 (2023-01-23)

Features

  • utils.tree: Add helper to convert obj for VTreeview (f78edd9)

v2.4.2 (2023-01-19)

Bug Fixes

  • text: Fix error message text grammar (911259f)

v2.4.1 (2023-01-13)

Bug Fixes

  • Reconnect: Allow template name to be used (3cad023)

v2.4.0 (2022-12-18)

Bug Fixes

  • cache: Try to prevent web caching (2bb25a0)

Features

  • Reconnect: Add support for reconnection (45a3b20)

If you add ?reconnect in the URL, you will get a button to let you try to reconnect. If you add ?reconnect=auto in the URL, the client will try to reconnect automatically and stop after 10 attempts.

v2.3.6 (2022-12-12)

Bug Fixes

  • trigger: Access client via this.client (9963d32)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

v2.3.5 (2022-12-09)

Bug Fixes

  • trigger: Add decorator logic for file objects (05235d5)

This is needed for the triggers to work properly with the file objects.

Signed-off-by: Patrick Avery patrick.avery@kitware.com

v2.3.4 (2022-12-08)

Bug Fixes

  • Style: Add wwidget.client.Style widget to add custom css (48d0e0c)

  • trigger: Apply decorators on args/kwargs (8a3971a)

  • wslink: Update version to support relative sessionManagerURL (2e62e57)

v2.3.3 (2022-12-07)

Bug Fixes

  • sessionManagerURL: Add option to read it from the html element dataset (7d174c4)

  • sessionManagerURL: Use data-session-manager-url (b9cbd68)

v2.3.2 (2022-12-04)

Bug Fixes

  • decorators: Replace blob.arrayBuffer with backward-compatible code (439b50e)

blob.arrayBuffer() is not available in IE11, which we need to use for the pywebview desktop apps.

We can instead replace it with this code that is more backward-compatible, and it works with IE11.

Signed-off-by: Patrick Avery patrick.avery@kitware.com

v2.3.1 (2022-11-08)

Bug Fixes

  • protocol: Update wslink for protocol resolution (12b64ab)

v2.3.0 (2022-10-24)

Features

  • install: Generator json files dependency optional for runtime (9312181)

v2.2.2 (2022-10-21)

Bug Fixes

  • state: Ensure flush to not skip pending change (73694c5)

v2.2.1 (2022-10-20)

Bug Fixes

  • state: Local change don't need server round trip (4eba70d)

v2.2.0 (2022-08-29)

Features

  • decorator: Implement file chunking to prevent size limit (171a787)

v2.1.5 (2022-08-10)

Bug Fixes

  • download: Allow promise as content (87bc3d7)

Chores

  • semantic-release: Bump version to latest (5e05792)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

Documentation

  • ci: Add coverage and codecov upload (c90ed26)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

  • coverage: Add .coveragerc (f451bad)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

  • coverage: Remove codecov PR comment (e9b0d9b)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

Signed-off-by: Patrick Avery patrick.avery@kitware.com

v2.1.4 (2022-06-19)

Bug Fixes

  • virtual-node: Follow builder pattern when possible (d0a5ce8)

v2.1.3 (2022-06-14)

Bug Fixes

  • desktop: Add edge 18 support (2238072)

v2.1.2 (2022-06-14)

Bug Fixes

  • cfe: Add chrome 66 compatibility for cfe runtime (5dc7b5b)

v2.1.1 (2022-06-10)

Bug Fixes

  • state: Prevent equal value to trigger change (8ab648d)

Documentation

  • contributing: Add CONTRIBUTING.rst (ad214da)

Signed-off-by: Patrick Avery patrick.avery@kitware.com

v2.1.0 (2022-06-04)

Features

  • VirtualNode: Introduce the virtual node concept (e1585ed)

v2.0.3 (2022-06-03)

Bug Fixes

  • use_: Fix case sensitivity of use_host(name) (78c4bfd)

v2.0.2 (2022-05-30)

Bug Fixes

  • state: Properly handle _filter after reload (c43046b)

v2.0.1 (2022-05-27)

Bug Fixes

  • CI: Add initial CI with semantic-release (51323fd)

This also fixes any pre-commit issues.

Signed-off-by: Patrick Avery patrick.avery@kitware.com

  • client: Latest client build (cfef0b4)

  • Template: Expose it in widgets.html (ea90cc4)

Documentation

  • api: Add missing information (f0a7d64)

  • api: Add missing information (857238f)

  • api: Add missing information (b341015)