Merge branch 'main' of https://github.com/RENCI/APSViz-UI-V3 into iss…

…ue-310-secure-token

src/app.js

@@ -14,7 +14,7 @@ import { Acknowledgements } from "@components/acknowledgements";
 /**
  * renders the main content
  *
- * @returns JSX.Element
+ * @returns React.ReactElement
  * @constructor
  */
 const Content = () => {
@@ -51,7 +51,7 @@ const Content = () => {
 /**
  * renders the application
  *
- * @returns JSX.Element
+ * @returns React.ReactElement
  * @constructor
  */
 export const App = () => {

src/components/compare-panel/compare-panel.js

@@ -9,7 +9,7 @@ import Draggable from "react-draggable";
 /**
  * renders the compare mode selections.
  *
- * @returns JSX.Element
+ * @returns React.ReactElement
  * @constructor
  */
 export const ComparePanel = () => {

src/components/config/config.js

@@ -30,7 +30,7 @@ export const getDefaultInstanceName = () => {
 /**
  * handles getting the default instance name
  *
- * @returns JSX.Element
+ * @returns React.ReactElement
  * @constructor
  */
 export const Config = () => {

src/components/dialog/base-floating-dialog.js

@@ -29,7 +29,7 @@ BaseFloatingDialog.propTypes = {
  *
  * @param title - the name of the dialog: string
  * @param index - the index of the data
- * @param dialogObject the object to render in the dialog: {JSX.Element}
+ * @param dialogObject the object to render in the dialog: React.ReactElement
  * @param dataKey - the key to the data list elements in state: string
  * @param dataList - a data list in state: array
  * @param setDataList - method to update a data list in state: function

src/components/dialog/observation-chart.js

@@ -18,7 +18,7 @@ dayjs.extend(utc);
  * renders the observations as a chart
  *
  * @param dataUrl
- * @returns JSX.Element
+ * @returns React.ReactElement
  * @constructor
  */
 export default function ObservationChart(chartProps) {
@@ -287,7 +287,7 @@ function get_yaxis_ticks(data) {
  * Creates the chart.
  *
  * @param url
- * @returns JSX.Element
+ * @returns React.ReactElement
  * @constructor
  */
 function CreateObsChart(c) {

src/components/dialog/observation-dialog.js

@@ -7,7 +7,7 @@ import ObservationChart from "@dialog/observation-chart";
  * This component renders the observation dialog, including the chart
  *
  * @param obs_data
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const ObservationDialog = (obs_data) => {

src/components/trays/compare-layers/CompareLayersTray.js

@@ -35,7 +35,7 @@ const getModelRunGroupList = (layers) => {
 /**
  * This component renders the model selection tray
  *
- * @returns JSX.Element
+ * @returns React.ReactElement
  * @constructor
  */
 export const CompareLayersTray = () => {

src/components/trays/compare-layers/compare-layers.js

@@ -4,7 +4,7 @@ import { CompareLayersTray } from "@compare-layers/CompareLayersTray.js";
 /**
  * component that handles the comparison of layers on the map.
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const CompareLayers = () => {

src/components/trays/compare-layers/index.js

@@ -14,7 +14,7 @@ export const title = 'Compare Layers';
 /**
  * render the model selection component
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  */
 export const trayContents = () => (
       <Stack gap={ 2 } p={ 2 }>

src/components/trays/help-about/helpAboutTray.js

@@ -22,7 +22,7 @@ import SvgIcon from '@mui/material/SvgIcon';
  *
  * @param color
  * @param name
- * @returns JSX.Element
+ * @returns React.ReactElement
  */
 const getObsSVGIcon = ( color, name ) => {
     return (
@@ -44,7 +44,7 @@ const getObsSVGIcon = ( color, name ) => {
 /**
  * This component renders the help/about tray
  *
- * @returns JSX.Element
+ * @returns React.ReactElement
  * @constructor
  */
 export const HelpAboutTray = () => {

src/components/trays/help-about/help_about.js

@@ -4,7 +4,7 @@ import { HelpAboutTray } from "./helpAboutTray.js";
 /**
  * component that renders the help/about tray.
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const HelpAbout = () => {

src/components/trays/help-about/index.js

@@ -14,7 +14,7 @@ export const title = 'APSViz Help/About';
 /**
  * render the removal component
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  */
 export const trayContents = () => (
       <Stack gap={ 2 } p={ 2 }>

src/components/trays/layers/list.js

@@ -106,7 +106,7 @@ const newLayerDefaultState = (layer, group) => {
 /**
  * render the layers for the selected run groups
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const LayersList = () => {

src/components/trays/model-selection/index.js

@@ -14,7 +14,7 @@ export const title = 'ADCIRC Model selection';
 /**
  * render the model selection component
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  */
 export const trayContents = () => (
       <Stack gap={ 2 } p={ 2 }>

src/components/trays/model-selection/model-selection.js

@@ -4,7 +4,7 @@ import { ModelSelectionTray } from "@model-selection/modelSelectionTray.js";
 /**
  * component that handles the filtered selections of layers for the map.
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const ModelSelection = () => {

src/components/trays/model-selection/modelSelectionTray.js

@@ -6,7 +6,7 @@ import {TropicalTabForm} from "@model-selection/tropicalTab";
 /**
  * This component renders the model selection tray
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const ModelSelectionTray = () => {

src/components/trays/model-selection/synopticTab.js

@@ -13,7 +13,7 @@ import dayjs from 'dayjs';
 /**
  * Form to filter/select synoptic runs
  *
- * @returns JSX.Element
+ * @returns React.ReactElement
  * @constructor
  */
 export const SynopticTabForm = () => {

src/components/trays/model-selection/tropicalTab.js

@@ -9,7 +9,7 @@ import { getNamespacedEnvParam, getBrandingHandler } from "@utils/map-utils";
 /**
  * Form to filter/selt tropical runs
  *
- * @returns JSX.Element
+ * @returns React.ReactElement
  * @constructor
  */
 export const TropicalTabForm = () => {

src/components/trays/remove/index.js

@@ -17,7 +17,7 @@ export const title = 'Remove items';
 /**
  * render the tray
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  */
 export const trayContents = () => (
       <Stack gap={ 2 } p={ 2 }>

src/components/trays/remove/remove-models.js

@@ -5,7 +5,7 @@ import { useLayers } from "@context";
 /**
  * component that handles the removal of all model runs.
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const RemoveModels = () => {

src/components/trays/remove/remove-observations.js

@@ -5,7 +5,7 @@ import { useLayers } from "@context";
 /**
  * component that handles the removal of observations.
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const RemoveAllObservations = () => {

src/components/trays/remove/reset-compare.js

@@ -6,7 +6,7 @@ import { useLayers } from "@context";
  * component that handles the removal of styles from
  * local storage ADCIRC raster layers
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const ResetCompare = () => {

src/components/trays/remove/reset-styles.js

@@ -5,7 +5,7 @@ import { Button } from '@mui/joy';
  * component that handles the removal of styles from
  * local storage ADCIRC raster layers
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const ResetStyles = () => {

src/components/trays/settings/chart-yaxis.js

@@ -6,7 +6,7 @@ import LineAxisRoundedIcon from '@mui/icons-material/LineAxisRounded';
 /**
  * renders the observation chart Y-axis slider
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const ObsChartYAxis = () => {
@@ -63,7 +63,7 @@ export const ObsChartYAxis = () => {
 /**
  * renders the icon
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const YAxisSlider = () => {

src/components/trays/share/index.js

@@ -16,7 +16,7 @@ export const title = 'Share your view';
 /**
  * render the removal component
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  */
 export const trayContents = () => (
       <Stack gap={ 2 } p={ 2 }>

src/components/trays/share/share-comment.js

@@ -7,7 +7,7 @@ import { useLayers } from "@context";
 /**
  * renders the shared content on the app as defined in the query string
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const ShareComment = () => {

src/components/trays/share/shareViewTray.js

@@ -6,7 +6,7 @@ import { ShareComment } from "@share/share-comment";
 /**
  * renders the shared content on the app as defined in the query string
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const ShareViewTray = () => {

src/components/trays/share/share_view.js

@@ -4,7 +4,7 @@ import { ShareViewTray } from "@share/shareViewTray.js";
 /**
  * component that handles the filtered selections of layers for the map.
  *
- * @returns {JSX.Element}
+ * @returns React.ReactElement
  * @constructor
  */
 export const ShareView = () => {

src/context/map-context.js

@@ -92,7 +92,7 @@ export const LayersProvider = ({ children }) => {
    * get the layer icon
    *
    * @param productType
-   * @returns JSX.Element
+   * @returns React.ReactElement
    */
   const getLayerIcon = ( productType )=> {
       // grab the icon