Skip to content

Commit

Permalink
Update link
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronPlave committed Jul 22, 2024
1 parent 7d2cdf0 commit f86d6e7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/planning/plugins/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Advanced - UI Plugins

The Aerie UI provides an client-side API for customizing various aspects of the UI. This customization is accomplished by supplying the UI with specifically named javascript files in the `static/resources` directory of the application and enabling the plugins using runtime environment variables. These plugins are run in the Aerie UI browser context. The relevant portions of the API specification can be found on specific plugin pages below or for the entire specification please reference the Aerie UI [plugins.ts](https://github.com/NASA-AMMOS/aerie-ui/) type file (TODO make a link once merged). Plugins may also load additional supporting files from the `static/resources` directory or from external sources. Please note that additional resource requests to `static/resources/*` should be referenced as `/resources/*` given the client side routing setup.
The Aerie UI provides an client-side API for customizing various aspects of the UI. This customization is accomplished by supplying the UI with specifically named javascript files in the `static/resources` directory of the application and enabling the plugins using runtime environment variables. These plugins are run in the Aerie UI browser context. The relevant portions of the API specification can be found on specific plugin pages below or for the entire specification please reference the Aerie UI [plugin.ts](https://github.com/NASA-AMMOS/aerie-ui/blob/develop/src/types/plugin.ts) type file. Plugins may also load additional supporting files from the `static/resources` directory or from external sources. Please note that additional resource requests to `static/resources/*` should be referenced as `/resources/*` given the client side routing setup.

Plugins must export an asynchronous function named `getPlugin` that returns a subset of the Plugin API.

Expand Down

0 comments on commit f86d6e7

Please sign in to comment.