-
Notifications
You must be signed in to change notification settings - Fork 884
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Joshua Li <joshuali925@gmail.com>
- Loading branch information
1 parent
dba3cb0
commit 50f69ae
Showing
8 changed files
with
172 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
65 changes: 65 additions & 0 deletions
65
src/plugins/data/public/ui/search_bar_extensions/search_bar_extension.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
/* | ||
* Copyright OpenSearch Contributors | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
import { EuiErrorBoundary, EuiPortal } from '@elastic/eui'; | ||
import { EuiPortalProps } from '@opensearch-project/oui'; | ||
import React, { useEffect, useMemo, useState } from 'react'; | ||
import { IIndexPattern } from '../../../common'; | ||
|
||
interface SearchBarExtensionProps { | ||
config: SearchBarExtensionConfig; | ||
dependencies: SearchBarExtensionDependencies; | ||
portalInsert: EuiPortalProps['insert']; | ||
} | ||
|
||
export interface SearchBarExtensionDependencies { | ||
/** | ||
* Currently selected index patterns. | ||
*/ | ||
indexPatterns?: IIndexPattern[]; | ||
} | ||
|
||
export interface SearchBarExtensionConfig { | ||
/** | ||
* The id for the search bar extension. | ||
*/ | ||
id: string; | ||
/** | ||
* Lower order indicates higher position on UI. | ||
*/ | ||
order: number; | ||
/** | ||
* A function that determines if the search bar extension is enabled and should be rendered on UI. | ||
* @returns whether the extension is enabled. | ||
*/ | ||
isEnabled: () => Promise<boolean>; | ||
/** | ||
* A function that returns the mount point for the search bar extension. | ||
* @param dependencies - The dependencies required for the extension. | ||
* @returns The mount point for the search bar extension. | ||
*/ | ||
getComponent: (dependencies: SearchBarExtensionDependencies) => React.ReactElement; | ||
} | ||
|
||
export const SearchBarExtension: React.FC<SearchBarExtensionProps> = (props) => { | ||
const [isEnabled, setIsEnabled] = useState(false); | ||
|
||
const component = useMemo(() => props.config.getComponent(props.dependencies), [ | ||
props.config, | ||
props.dependencies, | ||
]); | ||
|
||
useEffect(() => { | ||
props.config.isEnabled().then(setIsEnabled); | ||
}, [props.dependencies, props.config]); | ||
|
||
if (!isEnabled) return null; | ||
|
||
return ( | ||
<EuiPortal insert={props.portalInsert}> | ||
<EuiErrorBoundary>{component}</EuiErrorBoundary> | ||
</EuiPortal> | ||
); | ||
}; |
45 changes: 45 additions & 0 deletions
45
src/plugins/data/public/ui/search_bar_extensions/search_bar_extensions.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
/* | ||
* Copyright OpenSearch Contributors | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
import { EuiPortalProps } from '@elastic/eui'; | ||
import React from 'react'; | ||
import { | ||
SearchBarExtension, | ||
SearchBarExtensionConfig, | ||
SearchBarExtensionDependencies, | ||
} from './search_bar_extension'; | ||
|
||
interface SearchBarExtensionsProps { | ||
configs?: SearchBarExtensionConfig[]; | ||
dependencies: SearchBarExtensionDependencies; | ||
portalInsert: EuiPortalProps['insert']; | ||
} | ||
|
||
export const SearchBarExtensions: React.FC<SearchBarExtensionsProps> = (props) => { | ||
if (!props.configs) return null; | ||
|
||
const configs = props.configs | ||
.sort((a, b) => a.order - b.order) | ||
.reduce((acc, config) => { | ||
if (!acc.some((item) => item.id === config.id)) { | ||
acc.push(config); | ||
} | ||
// TODO inform user of duplicates? | ||
return acc; | ||
}, [] as SearchBarExtensionConfig[]); | ||
|
||
return ( | ||
<> | ||
{configs.map((config) => ( | ||
<SearchBarExtension | ||
key={config.id} | ||
config={config} | ||
dependencies={props.dependencies} | ||
portalInsert={props.portalInsert} | ||
/> | ||
))} | ||
</> | ||
); | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters