This is an automated email from the ASF dual-hosted git repository. kaxilnaik pushed a commit to branch v3-1-test in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 189272713da1ffab8f1ee51c237acdef6f77bff4 Author: Jens Scheffler <[email protected]> AuthorDate: Thu Sep 11 22:19:21 2025 +0200 Mark React Apps as Experimental for Airflow 3.1 (#55478) * Mark React Apps as Experimental for Airflow 3.1 * Apply suggestions from code review Co-authored-by: Brent Bovenzi <[email protected]> --------- Co-authored-by: Brent Bovenzi <[email protected]> (cherry picked from commit 6da5443399209b57ef928604b01826d07f4f1438) --- airflow-core/docs/administration-and-deployment/plugins.rst | 3 +++ airflow-core/docs/howto/custom-view-plugin.rst | 7 +++++++ 2 files changed, 10 insertions(+) diff --git a/airflow-core/docs/administration-and-deployment/plugins.rst b/airflow-core/docs/administration-and-deployment/plugins.rst index a93eb48ffdb..0e50686cd53 100644 --- a/airflow-core/docs/administration-and-deployment/plugins.rst +++ b/airflow-core/docs/administration-and-deployment/plugins.rst @@ -111,6 +111,8 @@ looks like: # A list of dictionaries containing external views and some metadata. See the example below. external_views = [] # A list of dictionaries containing react apps and some metadata. See the example below. + # Note: React apps are only supported in Airflow 3.1 and later. + # Note: The React app integration is experimental and interfaces might change in future versions. Particularly, dependency and state interactions between the UI and plugins may need to be refactored for more complex plugin apps. react_apps = [] # A callback to perform actions when Airflow starts and the plugin is loaded. @@ -218,6 +220,7 @@ definitions in Airflow. "category": "browse", } + # Note: The React app integration is experimental and interfaces might change in future versions. react_app_with_metadata = { # Name of the React app, this will be displayed in the UI. "name": "Name of the React App", diff --git a/airflow-core/docs/howto/custom-view-plugin.rst b/airflow-core/docs/howto/custom-view-plugin.rst index 1250475fcba..3520de1a652 100644 --- a/airflow-core/docs/howto/custom-view-plugin.rst +++ b/airflow-core/docs/howto/custom-view-plugin.rst @@ -54,6 +54,13 @@ available in :doc:`plugin </administration-and-deployment/plugins>`. Developing React Applications with the Bootstrap Tool ===================================================== +.. warning:: + React applications are new in Airflow 3.1 and should be considered experimental. The feature may be + subject to changes in future versions without warning based on user feedback and errors reported. + Dependency and state interactions between the UI and plugins may need to be refactored, which will also change the bootstrapped example project provided. + +|experimental| + Airflow provides a React plugin bootstrap tool to help developers quickly create, develop, and integrate external React applications into the core UI. This is the most flexible and recommended way to customize the Airflow UI. This tool generates a complete React project structure that builds as a library compatible with dynamic imports and shares React instances with the host Airflow application.
