diff --git a/plugins/tech-radar/src/components/RadarComponent.tsx b/plugins/tech-radar/src/components/RadarComponent.tsx new file mode 100644 index 0000000000..ffa6953986 --- /dev/null +++ b/plugins/tech-radar/src/components/RadarComponent.tsx @@ -0,0 +1,85 @@ +/* + * Copyright 2020 Spotify AB + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import React, { useEffect, useState, FC } from 'react'; +import { Progress, useApi, errorApiRef, ErrorApi } from '@backstage/core'; +import Radar from '../components/Radar'; +import { TechRadarComponentProps, TechRadarLoaderResponse } from '../api'; +import getSampleData from '../sampleData'; + +const useTechRadarLoader = (props: TechRadarComponentProps) => { + const [state, setState] = useState<{ + loading: boolean; + error?: Error; + data?: TechRadarLoaderResponse; + }>({ + loading: true, + error: undefined, + data: undefined, + }); + + useEffect(() => { + if (!props.getData) { + return; + } + + props + .getData() + .then((payload: TechRadarLoaderResponse) => { + setState({ loading: false, error: undefined, data: payload }); + }) + .catch((err: Error) => { + setState({ + loading: false, + error: err, + data: undefined, + }); + }); + }, []); + + return state; +}; + +const RadarComponent: FC = props => { + const errorApi = useApi(errorApiRef); + const { loading, error, data } = useTechRadarLoader(props); + + useEffect(() => { + if (error) { + errorApi.post(error); + } + }, [error && error.message]); + + return ( + <> + {loading && } + {!loading && !error && ( + + )} + + ); +}; + +RadarComponent.defaultProps = { + getData: getSampleData, +}; + +export default RadarComponent; diff --git a/plugins/tech-radar/src/index.ts b/plugins/tech-radar/src/index.ts index 926a7b410f..df22e57558 100644 --- a/plugins/tech-radar/src/index.ts +++ b/plugins/tech-radar/src/index.ts @@ -17,15 +17,11 @@ export { plugin } from './plugin'; /** - * The API for configuring the Tech Radar in a Backstage deployment. + * The TypeScript API for configuring Tech Radar. */ export * from './api'; /** - * Load sample data for Backstage users to get setup quickly. - * - * @example - * import { techRadarApiRef, TechRadar, loadSampleData } from '@backstage/plugin-tech-radar'; - * builder.add(techRadarApiRef, new TechRadar(800, 500, loadSampleData)); + * The React component for more advanced use cases. */ -export { default as loadSampleData } from './sampleData'; +export { default as TechRadarComponent } from './components/RadarComponent';