mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
### Changes
1. adds `hidePanelChrome` parameter to `ReactEmbeddableRenderer`. When
true, embeddable is rendered without `PresentationPanel` wrapper
2. Removes `embeddable-explorer` plugin
3. Moves Embeddable developer example into embeddable_examples plugin
4. Creates new examples that demonstrate how to use
`ReactEmbeddableRenderer`
<img width="600" alt="Screenshot 2024-04-23 at 5 19 18 PM"
src="5167a2a4
-1968-42e6-92f7-4577c9cda3c6">
Follow-up work to narrow scope of this PR
1. add key concepts to embeddable overview
2. add "Register new embeddable type" tab that details how to create a
new embeddable and shows how you can add embeddable examples to
dashboard
3. group embeddable examples into a single item in "Add panel" menu - to
show best practices of how to keep menu clean
4. remove class based example embeddables
### Test instructions
1. start kibana with `yarn start --run-examples`
5. Open kibana menu and click "Developer examples"
6. Click "Embeddables" card and run examples
---------
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
137 lines
3.8 KiB
TypeScript
137 lines
3.8 KiB
TypeScript
/*
|
|
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
|
* or more contributor license agreements. Licensed under the Elastic License
|
|
* 2.0 and the Server Side Public License, v 1; you may not use this file except
|
|
* in compliance with, at your election, the Elastic License 2.0 or the Server
|
|
* Side Public License, v 1.
|
|
*/
|
|
|
|
import React, { useMemo, useState } from 'react';
|
|
|
|
import { ReactEmbeddableRenderer } from '@kbn/embeddable-plugin/public';
|
|
import {
|
|
EuiCodeBlock,
|
|
EuiFlexGroup,
|
|
EuiFlexItem,
|
|
EuiSpacer,
|
|
EuiSuperDatePicker,
|
|
EuiSwitch,
|
|
EuiText,
|
|
OnTimeChangeProps,
|
|
} from '@elastic/eui';
|
|
import { BehaviorSubject, Subject } from 'rxjs';
|
|
import { TimeRange } from '@kbn/es-query';
|
|
import { useBatchedOptionalPublishingSubjects } from '@kbn/presentation-publishing';
|
|
import { SearchEmbeddableRenderer } from '../react_embeddables/search/search_embeddable_renderer';
|
|
import { SEARCH_EMBEDDABLE_ID } from '../react_embeddables/search/constants';
|
|
import type { Api, State } from '../react_embeddables/search/types';
|
|
|
|
export const RenderExamples = () => {
|
|
const initialState = useMemo(() => {
|
|
return {
|
|
rawState: {
|
|
timeRange: undefined,
|
|
},
|
|
references: [],
|
|
};
|
|
// only run onMount
|
|
}, []);
|
|
|
|
const parentApi = useMemo(() => {
|
|
return {
|
|
reload$: new Subject<void>(),
|
|
timeRange$: new BehaviorSubject<TimeRange>({
|
|
from: 'now-24h',
|
|
to: 'now',
|
|
}),
|
|
};
|
|
// only run onMount
|
|
}, []);
|
|
|
|
const [api, setApi] = useState<Api | null>(null);
|
|
const [hidePanelChrome, setHidePanelChrome] = useState<boolean>(false);
|
|
const [dataLoading, timeRange] = useBatchedOptionalPublishingSubjects(
|
|
api?.dataLoading,
|
|
parentApi.timeRange$
|
|
);
|
|
|
|
return (
|
|
<div>
|
|
<EuiSuperDatePicker
|
|
isLoading={dataLoading ? dataLoading : false}
|
|
start={timeRange.from}
|
|
end={timeRange.to}
|
|
onTimeChange={({ start, end }: OnTimeChangeProps) => {
|
|
parentApi.timeRange$.next({
|
|
from: start,
|
|
to: end,
|
|
});
|
|
}}
|
|
onRefresh={() => {
|
|
parentApi.reload$.next();
|
|
}}
|
|
/>
|
|
|
|
<EuiSpacer size="s" />
|
|
|
|
<EuiFlexGroup>
|
|
<EuiFlexItem>
|
|
<EuiText>
|
|
<p>
|
|
Use <strong>ReactEmbeddableRenderer</strong> to render embeddables.
|
|
</p>
|
|
</EuiText>
|
|
|
|
<EuiCodeBlock language="jsx" fontSize="m" paddingSize="m">
|
|
{`<ReactEmbeddableRenderer<State, Api>
|
|
type={SEARCH_EMBEDDABLE_ID}
|
|
state={initialState}
|
|
parentApi={parentApi}
|
|
onApiAvailable={(newApi) => {
|
|
setApi(newApi);
|
|
}}
|
|
hidePanelChrome={hidePanelChrome}
|
|
/>`}
|
|
</EuiCodeBlock>
|
|
|
|
<EuiSpacer size="s" />
|
|
|
|
<EuiSwitch
|
|
label="Set hidePanelChrome to render embeddable without Panel wrapper."
|
|
checked={hidePanelChrome}
|
|
onChange={(e) => setHidePanelChrome(e.target.checked)}
|
|
/>
|
|
|
|
<EuiSpacer size="s" />
|
|
|
|
<ReactEmbeddableRenderer<State, Api>
|
|
key={hidePanelChrome ? 'hideChrome' : 'showChrome'}
|
|
type={SEARCH_EMBEDDABLE_ID}
|
|
state={initialState}
|
|
parentApi={parentApi}
|
|
onApiAvailable={(newApi) => {
|
|
setApi(newApi);
|
|
}}
|
|
hidePanelChrome={hidePanelChrome}
|
|
/>
|
|
</EuiFlexItem>
|
|
|
|
<EuiFlexItem>
|
|
<EuiText>
|
|
<p>To avoid leaking embeddable details, wrap ReactEmbeddableRenderer in a component.</p>
|
|
</EuiText>
|
|
|
|
<EuiCodeBlock language="jsx" fontSize="m" paddingSize="m">
|
|
{`<SearchEmbeddableRenderer
|
|
timeRange={timeRange}
|
|
/>`}
|
|
</EuiCodeBlock>
|
|
|
|
<EuiSpacer size="s" />
|
|
|
|
<SearchEmbeddableRenderer timeRange={timeRange} />
|
|
</EuiFlexItem>
|
|
</EuiFlexGroup>
|
|
</div>
|
|
);
|
|
};
|