feature: add RadarComponent and export as TechRadarComponent

This commit is contained in:
Bilawal Hameed
2020-05-02 14:39:07 +02:00
parent e1f4cd0057
commit ef9e6ba6a8
2 changed files with 88 additions and 7 deletions
@@ -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<TechRadarComponentProps> = props => {
const errorApi = useApi<ErrorApi>(errorApiRef);
const { loading, error, data } = useTechRadarLoader(props);
useEffect(() => {
if (error) {
errorApi.post(error);
}
}, [error && error.message]);
return (
<>
{loading && <Progress />}
{!loading && !error && (
<Radar
{...props}
rings={data!.rings}
quadrants={data!.quadrants}
entries={data!.entries}
/>
)}
</>
);
};
RadarComponent.defaultProps = {
getData: getSampleData,
};
export default RadarComponent;
+3 -7
View File
@@ -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';