Add tooltip with documentation link in metadata summary

elastic · Jul 18, 2023 · 8444d69 · 8444d69
1 parent 3752130
commit 8444d69
Showing 1 changed file with 82 additions and 40 deletions.
diff --git a/x-pack/plugins/infra/public/components/asset_details/tabs/overview/metadata_summary.tsx b/x-pack/plugins/infra/public/components/asset_details/tabs/overview/metadata_summary.tsx
@@ -12,12 +12,16 @@ import {
   EuiFlexItem,
   EuiDescriptionList,
   EuiDescriptionListDescription,
+  EuiIcon,
+  EuiLink,
   EuiLoadingSpinner,
+  EuiPopover,
 } from '@elastic/eui';
 import { css } from '@emotion/react';
 import { i18n } from '@kbn/i18n';
 import React from 'react';
 import { FormattedMessage } from '@kbn/i18n-react';
+import { useBoolean } from '../../../../hooks/use_boolean';
 import type { InfraMetadata } from '../../../../../common/http_api';
 import { NOT_AVAILABLE_LABEL } from '../../translations';
 import { useTabSwitcherContext } from '../../hooks/use_tab_switcher';
@@ -42,6 +46,8 @@ const metadataData = (metadataInfo: InfraMetadata['info']) => [
   {
     field: 'hostIp',
     value: metadataInfo?.host?.ip,
+    tooltipLinkLabel: 'host.ip',
+    tooltipLink: 'https://www.elastic.co/guide/en/ecs/current/ecs-host.html#field-host-ip',
   },
   {
     field: 'hostOsVersion',
@@ -55,53 +61,89 @@ interface MetadataSummaryProps {
 }
 
 export const MetadataSummary = ({ metadata, metadataLoading }: MetadataSummaryProps) => {
+  const [isPopoverOpen, { off: closePopover, toggle: togglePopover }] = useBoolean(false);
   const { showTab } = useTabSwitcherContext();
 
   const onClick = () => {
     showTab(FlyoutTabIds.METADATA);
   };
 
   return (
-    <>
-      <EuiFlexGroup gutterSize="m" responsive={false} wrap justifyContent="spaceBetween">
-        <EuiFlexGroup alignItems="flexStart">
-          {metadataData(metadata?.info).map((metadataValue) => (
-            <EuiFlexItem key={metadataValue.field}>
-              <EuiDescriptionList data-test-subj="infraMetadataSummaryItem" compressed>
-                <EuiDescriptionListTitle
-                  css={css`
-                    white-space: nowrap;
-                  `}
-                >
-                  {columnTitles[metadataValue.field as MetadataFields]}
-                </EuiDescriptionListTitle>
-                <EuiDescriptionListDescription>
-                  {metadataLoading ? (
-                    <EuiLoadingSpinner />
-                  ) : (
-                    <ExpandableContent values={metadataValue.value ?? NOT_AVAILABLE_LABEL} />
-                  )}
-                </EuiDescriptionListDescription>
-              </EuiDescriptionList>
-            </EuiFlexItem>
-          ))}
-        </EuiFlexGroup>
-        <EuiFlexItem grow={false} key="metadata-link">
-          <EuiButtonEmpty
-            data-test-subj="infraMetadataSummaryShowAllMetadataButton"
-            onClick={onClick}
-            size="xs"
-            flush="both"
-            iconSide="right"
-            iconType="sortRight"
-          >
-            <FormattedMessage
-              id="xpack.infra.assetDetailsEmbeddable.metadataSummary.showAllMetadataButton"
-              defaultMessage="Show all"
-            />
-          </EuiButtonEmpty>
-        </EuiFlexItem>
+    <EuiFlexGroup gutterSize="m" responsive={false} wrap justifyContent="spaceBetween">
+      <EuiFlexGroup alignItems="flexStart">
+        {metadataData(metadata?.info).map((metadataValue) => (
+          <EuiFlexItem key={metadataValue.field}>
+            <EuiDescriptionList data-test-subj="infraMetadataSummaryItem" compressed>
+              <EuiDescriptionListTitle
+                css={css`
+                  white-space: nowrap;
+                `}
+              >
+                <EuiFlexGroup gutterSize="xs">
+                  <EuiFlexItem grow={false}>
+                    {columnTitles[metadataValue.field as MetadataFields]}
+                  </EuiFlexItem>
+                  <EuiFlexItem grow={false}>
+                    {metadataValue.tooltipLink && (
+                      <EuiPopover
+                        button={
+                          <EuiIcon
+                            data-test-subj="assetDetailsMetadataSummaryPopoverButton"
+                            type="questionInCircle"
+                            onClick={togglePopover}
+                          />
+                        }
+                        isOpen={isPopoverOpen}
+                        closePopover={closePopover}
+                        repositionOnScroll
+                        anchorPosition="upCenter"
+                      >
+                        <FormattedMessage
+                          id="xpack.infra.assetDetails.overviewMetadata.tooltip.documentationLabel"
+                          defaultMessage="See {documentation} for more details."
+                          values={{
+                            documentation: (
+                              <EuiLink
+                                data-test-subj="assetDetailsTooltipDocumentationLink"
+                                href={metadataValue.tooltipLink}
+                                target="_blank"
+                              >
+                                {metadataValue.tooltipLinkLabel}
+                              </EuiLink>
+                            ),
+                          }}
+                        />
+                      </EuiPopover>
+                    )}
+                  </EuiFlexItem>
+                </EuiFlexGroup>
+              </EuiDescriptionListTitle>
+              <EuiDescriptionListDescription>
+                {metadataLoading ? (
+                  <EuiLoadingSpinner />
+                ) : (
+                  <ExpandableContent values={metadataValue.value ?? NOT_AVAILABLE_LABEL} />
+                )}
+              </EuiDescriptionListDescription>
+            </EuiDescriptionList>
+          </EuiFlexItem>
+        ))}
       </EuiFlexGroup>
-    </>
+      <EuiFlexItem grow={false} key="metadata-link">
+        <EuiButtonEmpty
+          data-test-subj="infraMetadataSummaryShowAllMetadataButton"
+          onClick={onClick}
+          size="xs"
+          flush="both"
+          iconSide="right"
+          iconType="sortRight"
+        >
+          <FormattedMessage
+            id="xpack.infra.assetDetailsEmbeddable.metadataSummary.showAllMetadataButton"
+            defaultMessage="Show all"
+          />
+        </EuiButtonEmpty>
+      </EuiFlexItem>
+    </EuiFlexGroup>
   );
 };