feat(global-header): add spacer component (#412)

Signed-off-by: Christoph Jerolimov <jerolimov+git@redhat.com>

Author: christoph-jerolimov

workspaces/global-header/.changeset/empty-tools-attend.md

@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-global-header': patch
+---
+
+Add new Spacer component

workspaces/global-header/plugins/global-header/dev/configuration.md workspaces/global-header/docs/configuration.md

@@ -5,3 +5,4 @@ plugins:
 
 nav:
   - About: index.md
+  - Configuration: configuration.md

workspaces/global-header/mkdocs.yaml

@@ -42,6 +42,8 @@ import {
   GlobalHeader,
   globalHeaderPlugin,
   NotificationBanner,
+  Slot,
+  Spacer,
 } from '../src/plugin';
 
 import {
@@ -224,9 +226,19 @@ createDevApp()
       <Providers
         mountPoints={{
           'global.header/component':
-            defaultGlobalHeaderComponentsMountPoints.filter(
-              mp => mp.config.type !== ComponentType.SEARCH,
-            ),
+            defaultGlobalHeaderComponentsMountPoints.map(mp => {
+              if (mp.config.type === ComponentType.SEARCH) {
+                return {
+                  Component: Spacer,
+                  config: {
+                    type: ComponentType.SPACER,
+                    slot: Slot.HEADER_START,
+                    priority: 100, // the greater the number, the more to the left it will be
+                  },
+                };
+              }
+              return mp;
+            }),
           'global.header/create': defaultCreateDropdownMountPoints,
           'global.header/profile': defaultProfileDropdownMountPoints,
         }}

workspaces/global-header/plugins/global-header/dev/index.tsx

@@ -18,6 +18,7 @@ export enum ComponentType {
   LIST = 'list',
   LOGOUT = 'logout',
   SEARCH = 'search',
+  SPACER = 'spacer',
 }
 
 // @public
@@ -222,5 +223,19 @@ export type SoftwareTemplatesSectionProps = {
   hideDivider?: boolean;
 };
 
+// @public
+export const Spacer: ({
+  growFactor,
+  minWidth,
+}: SpacerProps) => React_2.JSX.Element;
+
+// @public (undocumented)
+export interface SpacerProps {
+  // (undocumented)
+  growFactor?: number;
+  // (undocumented)
+  minWidth?: number | string;
+}
+
 // (No @packageDocumentation comment for this package)
 ```

workspaces/global-header/plugins/global-header/report.api.md

@@ -98,6 +98,8 @@ export const GlobalHeaderComponent = ({
 
       const uniqueKey = `header-component-${index}`;
       switch (mp.config?.type) {
+        case ComponentType.SPACER:
+          return <mp.Component key={uniqueKey} />;
         case ComponentType.SEARCH:
           return (
             <ErrorBoundary key={uniqueKey}>

workspaces/global-header/plugins/global-header/src/components/GlobalHeaderComponent.tsx

@@ -0,0 +1,58 @@
+/*
+ * Copyright Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React from 'react';
+
+import { render } from '@testing-library/react';
+
+import { Spacer } from './Spacer';
+
+describe('Spacer', () => {
+  it('render some default styles', () => {
+    const { container } = render(<Spacer />);
+    expect(container.firstElementChild?.getAttribute('style')).toEqual(
+      'flex-grow: 1; min-width: 8px;',
+    );
+  });
+
+  it('accepts another grow factor', () => {
+    const { container } = render(<Spacer growFactor={2} />);
+    expect(container.firstElementChild?.getAttribute('style')).toEqual(
+      'flex-grow: 2; min-width: 8px;',
+    );
+  });
+
+  it('accepts number min width', () => {
+    const { container } = render(<Spacer minWidth={2} />);
+    expect(container.firstElementChild?.getAttribute('style')).toEqual(
+      'flex-grow: 1; min-width: 16px;',
+    );
+  });
+
+  it('accepts string min width', () => {
+    const { container } = render(<Spacer minWidth="24px" />);
+    expect(container.firstElementChild?.getAttribute('style')).toEqual(
+      'flex-grow: 1; min-width: 24px;',
+    );
+  });
+
+  it('accepts both', () => {
+    const { container } = render(<Spacer growFactor={2} minWidth={2} />);
+    expect(container.firstElementChild?.getAttribute('style')).toEqual(
+      'flex-grow: 2; min-width: 16px;',
+    );
+  });
+});

workspaces/global-header/plugins/global-header/src/components/Spacer/Spacer.test.tsx

@@ -0,0 +1,39 @@
+/*
+ * Copyright Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React from 'react';
+
+/**
+ * @public
+ */
+export interface SpacerProps {
+  growFactor?: number;
+  minWidth?: number | string;
+}
+
+/**
+ * @public
+ */
+export const Spacer = ({ growFactor = 1, minWidth = 1 }: SpacerProps) => {
+  return (
+    <div
+      style={{
+        flexGrow: growFactor,
+        minWidth: typeof minWidth === 'number' ? minWidth * 8 : minWidth,
+      }}
+    />
+  );
+};

workspaces/global-header/plugins/global-header/src/components/Spacer/Spacer.tsx

@@ -30,6 +30,7 @@ export type { HeaderLinkProps } from './components/HeaderLinkComponent/HeaderLin
 export type { MenuItemConfig } from './components/HeaderDropdownComponent/MenuSection';
 export type { SoftwareTemplatesSectionProps } from './components/HeaderDropdownComponent/SoftwareTemplatesSection';
 export type { RegisterAComponentSectionProps } from './components/HeaderDropdownComponent/RegisterAComponentSection';
+export type { SpacerProps } from './components/Spacer/Spacer';
 export type {
   GlobalHeaderComponentMountPoint,
   GlobalHeaderComponentMountPointConfig,
@@ -229,6 +230,22 @@ export const LogoutButton: React.ComponentType = globalHeaderPlugin.provide(
   }),
 );
 
+/**
+ * Spacer component that allow users to add a flexibel spacing between components.
+ *
+ * Supports two props: `growFactor` with default 1 and `minWidth` width default 8 pixels.
+ *
+ * @public
+ */
+export const Spacer = globalHeaderPlugin.provide(
+  createComponentExtension({
+    name: 'Spacer',
+    component: {
+      lazy: () => import('./components/Spacer/Spacer').then(m => m.Spacer),
+    },
+  }),
+);
+
 /**
  * NotificationBanner
  *

workspaces/global-header/plugins/global-header/src/plugin.ts

@@ -36,6 +36,10 @@ export enum Slot {
  * @public
  */
 export enum ComponentType {
+  /**
+   * Global Header spacer
+   */
+  SPACER = 'spacer',
   /**
    * Global Header Component dropdown button
    */