20 lines
1.2 KiB
Plaintext
20 lines
1.2 KiB
Plaintext
---
|
|
sidebar_label: Compatibility and migration
|
|
---
|
|
|
|
# Compatibility and migration
|
|
|
|
Homarr preserves existing display definitions while moving network-enabled Custom JSX to the named-request model.
|
|
|
|
## JSX API versions
|
|
|
|
Missing `jsxApiVersion` means v1. Display-only v1 templates can be opened and saved as v2 with an empty request manifest. Inline `url`, `method`, `headers`, and body props are inert in v2.
|
|
|
|
Static v1 network components can be converted by creating a named request and replacing inline capability props with `requestId` and typed `params`. Dynamic target construction requires an administrator to design an explicit path template and parameter list. Existing non-GET base definitions stop polling and show a network-review state.
|
|
|
|
## Import versions
|
|
|
|
Exports use `homarr-custom-widget-v3`; v2 imports remain accepted. Import migration normalizes display configuration, preserves v1 semantics, and never imports secret values. The review screen must be accepted before persistence.
|
|
|
|
Test migration with the same base response and compare rendered output, query results, action simulation, permissions, and journal entries before enabling the migrated definition on shared boards.
|