2023-01-03 21:20:27 +08:00
|
|
|
import { useAsync } from 'react-use';
|
2022-04-22 21:33:13 +08:00
|
|
|
|
2019-06-26 19:15:45 +08:00
|
|
|
import { renderMarkdown } from '@grafana/data';
|
2025-05-15 15:17:14 +08:00
|
|
|
import { Trans, useTranslate } from '@grafana/i18n';
|
2019-06-03 23:55:59 +08:00
|
|
|
import { getBackendSrv } from '@grafana/runtime';
|
2023-01-03 21:20:27 +08:00
|
|
|
import { LoadingPlaceholder } from '@grafana/ui';
|
2018-12-17 23:42:02 +08:00
|
|
|
|
|
|
|
interface Props {
|
2023-01-03 21:20:27 +08:00
|
|
|
pluginId: string;
|
2018-12-17 23:42:02 +08:00
|
|
|
}
|
|
|
|
|
2023-01-03 21:20:27 +08:00
|
|
|
export function PluginHelp({ pluginId }: Props) {
|
2025-05-15 15:17:14 +08:00
|
|
|
const { t } = useTranslate();
|
|
|
|
|
2023-01-03 21:20:27 +08:00
|
|
|
const { value, loading, error } = useAsync(async () => {
|
|
|
|
return getBackendSrv().get(`/api/plugins/${pluginId}/markdown/query_help`);
|
|
|
|
}, []);
|
2018-12-17 23:42:02 +08:00
|
|
|
|
2023-01-03 21:20:27 +08:00
|
|
|
const renderedMarkdown = renderMarkdown(value);
|
2018-12-18 21:40:54 +08:00
|
|
|
|
2023-01-03 21:20:27 +08:00
|
|
|
if (loading) {
|
2025-04-07 16:48:03 +08:00
|
|
|
return <LoadingPlaceholder text={t('plugins.plugin-help.loading', 'Loading help...')} />;
|
2018-12-17 23:42:02 +08:00
|
|
|
}
|
|
|
|
|
2023-01-03 21:20:27 +08:00
|
|
|
if (error) {
|
2024-11-21 20:59:14 +08:00
|
|
|
return (
|
|
|
|
<h3>
|
|
|
|
<Trans i18nKey="plugins.plugin-help.error">An error occurred when loading help.</Trans>
|
|
|
|
</h3>
|
|
|
|
);
|
2018-12-19 17:53:14 +08:00
|
|
|
}
|
2018-12-18 21:40:54 +08:00
|
|
|
|
2023-01-03 21:20:27 +08:00
|
|
|
if (value === '') {
|
2024-11-21 20:59:14 +08:00
|
|
|
return (
|
|
|
|
<h3>
|
|
|
|
<Trans i18nKey="plugins.plugin-help.not-found">No query help could be found.</Trans>
|
|
|
|
</h3>
|
|
|
|
);
|
2018-12-17 23:42:02 +08:00
|
|
|
}
|
2023-01-03 21:20:27 +08:00
|
|
|
|
|
|
|
return <div className="markdown-html" dangerouslySetInnerHTML={{ __html: renderedMarkdown }} />;
|
2018-12-17 23:42:02 +08:00
|
|
|
}
|