From 0c6282bc6f6e12188addaf9505329b3126bc034f Mon Sep 17 00:00:00 2001 From: guerler Date: Fri, 8 Nov 2024 09:35:15 +0300 Subject: [PATCH] Add note to introduction page about lightweight vite without form builder --- docs/content/introduction.md | 5 ++++- docs/content/xml-framework.md | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/content/introduction.md b/docs/content/introduction.md index 5af81e0..f77e4ee 100644 --- a/docs/content/introduction.md +++ b/docs/content/introduction.md @@ -40,7 +40,10 @@ With Galaxy Charts, you can develop visualizations locally in Vue, taking advant - **Local and Remote Data Access**: Load data locally or connect to a remote Galaxy instance to access data providers and resources through the Galaxy API, giving you flexibility in sourcing data. - **Automated Testing**: Test your visualization thoroughly in the local environment, ensuring it’s fully functional and bug-free before deploying it to Galaxy. - **Enhanced Development Workflow**: By integrating state-of-the-art development tools, Galaxy Charts provides an efficient workflow that reduces the time and effort needed to build or embed 3rd-party visualizations. -- **Automated Input Form Rendering**: A standout feature of Galaxy Charts is its ability to dynamically generate an input form within a side panel on the right. This enables users to configure their visualizations. +- **Automated Form Rendering**: A standout feature of Galaxy Charts is its ability to dynamically generate an input form within a side panel on the right. This enables users to configure their visualizations. In short, Galaxy Charts transforms and simplifies the process of developing and deploying visualizations on the Galaxy platform, offering an unparalleled experience for developers working in the Galaxy ecosystem. +::: tip +If your visualization does not require form rendering, or if you prefer not to use Vue, consider following the [lightweight Vite only approach](/content/xml-framework.html#building-a-vite-plugin-vanilla-vue-react-and-more). Both approaches utilize Vite as the underlying build tool. However, one includes a Vue component library for seamless form integration, while the other offers a more lightweight setup without Vue, giving you the flexibility to work with plain JavaScript or another framework of your choice. +::: \ No newline at end of file diff --git a/docs/content/xml-framework.md b/docs/content/xml-framework.md index e876006..5776649 100644 --- a/docs/content/xml-framework.md +++ b/docs/content/xml-framework.md @@ -161,7 +161,7 @@ const datasetId = incoming.visualization_config.dataset_id; ``` ::: tip Note -With this setup, you can also utilize the additional XML sections and inputs described below. Unlike the Galaxy Charts Vue package, these elements won't be automatically rendered. However, if your visualization doesn't require user-configurable settings, this approach might be a better fit. It introduces no overhead and offers greater flexibility, allowing you to work with a variety of JavaScript frameworks or libraries. +Unlike the Galaxy Charts Vue package, the input form will not be automatically rendered. However, if your visualization does not require user-configurable settings, this approach might be a better fit. It introduces less overhead and offers greater flexibility, allowing you to work with a variety of JavaScript frameworks or libraries. ::: ## Use any JavaScript Technology!