added initial docs

This commit is contained in:
Bilawal Hameed
2020-04-24 15:26:50 +02:00
parent 4faf199f72
commit 9fdc99c3e8
4 changed files with 151 additions and 9 deletions
+2 -2
View File
@@ -49,12 +49,12 @@ export interface TechRadarAdditionalOptions {
svgProps?: object;
}
export type TechRadarApi = {
export interface TechRadarApi {
width: number;
height: number;
load: () => Promise<TechRadarLoaderResponse>;
additionalOpts: TechRadarAdditionalOptions;
};
}
export const techRadarApiRef = new ApiRef<TechRadarApi>({
id: 'plugin.techradar',
@@ -27,9 +27,9 @@ import {
ErrorApi,
} from '@backstage/core';
import Radar from '../components/Radar';
import { techRadarApiRef, TechRadar, TechRadarLoaderResponse } from '../api';
import { techRadarApiRef, TechRadarApi, TechRadarLoaderResponse } from '../api';
const useTechRadarLoader = (techRadarApi: TechRadar) => {
const useTechRadarLoader = (techRadarApi: TechRadarApi) => {
const [state, setState] = useState<{
loading: boolean;
error?: Error;
@@ -60,7 +60,7 @@ const useTechRadarLoader = (techRadarApi: TechRadar) => {
const RadarPage: FC<{}> = () => {
const errorApi = useApi<ErrorApi>(errorApiRef);
const techRadarApi = useApi<TechRadar>(techRadarApiRef);
const techRadarApi = useApi<TechRadarApi>(techRadarApiRef);
const { loading, error, data } = useTechRadarLoader(techRadarApi);
useEffect(() => {