Skip to content

Commit

Permalink
Add note to introduction page about lightweight vite without form bui…
Browse files Browse the repository at this point in the history
…lder
  • Loading branch information
guerler committed Nov 8, 2024
1 parent 9014ddb commit 0c6282b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion docs/content/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
2 changes: 1 addition & 1 deletion docs/content/xml-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down

0 comments on commit 0c6282b

Please sign in to comment.