feat: use Carbon Components UIShell for TopTabStripe

This PR switches TopTabStripe.tsx partially over to Carbon's UIShell. We still have to style the HeaderMenuItems ourselves to look like tabs, since carbon on its own does not do this. But this is only some CSS rules, not core component work.

Fixes #3819

Author: starpit

packages/core/src/webapp/cancel.ts

@@ -32,5 +32,6 @@ export default function doCancel(tab: Tab, block: Block) {
 
   const execUUID = block.getAttribute('data-uuid')
   const endEvent = { tab, execType: ExecType.TopLevel, cancelled: true, execUUID }
+  eventBus.emit('/command/complete', endEvent)
   eventBus.emit(`/command/complete/fromuser/${getTabId(tab)}`, endEvent)
 }

plugins/plugin-carbon-themes/web/css/carbon-gray10.css

@@ -2,7 +2,8 @@
 @import "kui--alternate.css";
 
 /* inverted sidecar */
-body[kui-theme="Carbon Gray10"] .kui--sidecar {
+body[kui-theme="Carbon Gray10"] .kui--sidecar,
+body[kui-theme="Carbon Gray10"] .bx--header .bx--side-nav {
   --color-base00: #262626;
   --color-base01: #171717;
   --color-base02: #565656;

plugins/plugin-carbon-themes/web/css/kui--alternate.css

@@ -1,95 +1,4 @@
-/* Alternate top tab stripe UI yoyo */
-
-body.kui--alternate .kui-header__title {
-  display: none;
-}
-body.kui--alternate .kui-header__title,
-body.kui--alternate .kui-tab,
-body.kui--alternate .kui-new-tab {
-  color: var(--tab-gray-text-color);
-  display: inline-flex;
-  justify-content: center;
-  align-items: center;
-  cursor: pointer;
-}
-
-body.kui--alternate .kui-header {
-  width: 100%;
-  height: 48px;
-  flex-basis: 48px;
-  display: flex;
-  background-color: var(--color-stripe-01);
-  padding: 0 1em 0 3em;
-  font-weight: 600;
-  box-shadow: 0 1px 10px 0 rgba(21, 41, 53, 0.1);
-  z-index: 1;
-}
-
-body.kui--alternate .kui-header__title {
-  padding-right: 28px;
-}
-
-body.kui--alternate .kui-tab {
-  position: relative;
-  border: none;
-  background: transparent;
-}
-
-body.kui--alternate .kui-tab--label {
-  text-align: left;
-  font-size: 0.875rem;
-  font-weight: 600;
-  padding: 0.5em 0 0;
-  border: none !important;
-}
-body.kui--alternate .left-tab-stripe-buttons .left-tab-stripe-button-closer {
-  transform: translateY(calc(-50% + 0.25em));
-}
-
-body.kui--alternate .left-tab-stripe-button.processing .kui-tab--label {
-  color: var(--active-tab-color);
-}
-
-body.kui--alternate .kui-tab--label-index:before {
-  content: counter(tab-index);
-}
-
-body.kui--alternate .kui-tab--active {
-  color: var(--active-tab-color);
-}
-
-body.kui--alternate .kui-tab.left-tab-stripe-button-selected {
-  margin-top: 0;
-}
-
-body.kui--alternate .kui-tab::after {
-  display: block;
-  content: "";
-  position: absolute;
-  width: 100%;
-  height: 2px;
-  background-color: transparent;
-  bottom: 0;
-  transition: all 0.2s;
-  pointer-events: none;
-}
-
-body.kui--alternate .kui-tab:hover:after,
-body.kui--alternate .kui-tab--active:after {
-  background-color: currentColor;
-}
-
-body.kui--alternate #new-tab-button.kui-new-tab {
-  padding-top: 0.5em;
-}
-
-body.kui--alternate .kui-header a.kui--tab-navigatable {
-  padding: 0.5em;
-}
-
-body.kui--alternate .kui-new-tab__text {
-  color: var(--tab-gray-text-color);
-}
+/* Alternate look for carbon themes */
 
 body.kui--alternate .repl:not(.kui--input-stripe) .repl-block {
   padding-left: 2em;
@@ -107,19 +16,6 @@ body.kui--alternate .repl-prompt-righty svg path {
   fill: var(--color-text-01);
 }
 
-/* status indicators */
-body.kui--alternate .repl-block .repl-prompt-right-element-status-icon svg {
-  transform: scale(0.875);
-  filter: none;
-}
-body.kui--alternate .repl-block.valid-response .repl-prompt-right-element-status-icon svg.kui--icon-ok {
-  display: none;
-}
-body.kui--alternate .repl .repl-prompt-right-element-status-icon.deemphasize {
-  order: -1;
-  margin-right: 0.5em;
-  margin-left: 0;
-}
-body.kui--alternate .kui--repl-prompt-buttons {
-  order: -2;
+body.kui--alternate .bx--header {
+  font-size: 1em;
 }

plugins/plugin-client-common/src/components/About.tsx

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2020 IBM Corporation
+ *
+ * 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 * as React from 'react'
+import { i18n } from '@kui-shell/core'
+import { SideNavMenu, SideNavMenuItem, SideNav, SideNavItems } from 'carbon-components-react'
+
+import '../../web/css/static/About.scss'
+import 'carbon-components/scss/components/ui-shell/_content.scss'
+import 'carbon-components/scss/components/ui-shell/_side-nav.scss'
+
+const strings = i18n('client', 'about')
+
+interface Props {
+  expanded: boolean
+}
+
+interface State {
+  current: { nav: number; tab: number }
+}
+
+export default class About extends React.PureComponent<Props, State> {
+  public constructor(props: Props) {
+    super(props)
+
+    this.state = {
+      current: { nav: 0, tab: 0 }
+    }
+  }
+
+  private configure(menuIdx: number) {
+    return (
+      <SideNavMenu title={strings('Configure')} isActive defaultExpanded>
+        <SideNavMenuItem
+          href="#" // needed for tab navigation
+          key={0}
+          data-mode={'theme'} // needed for tests
+          isActive={this.state.current.nav === menuIdx && this.state.current.tab === 0}
+          onClick={() => {
+            this.setState({ current: { nav: menuIdx, tab: 0 } })
+          }}
+        >
+          <span className="kui--mode-placeholder" data-mode="theme">
+            {strings('Theme')}
+          </span>
+        </SideNavMenuItem>
+      </SideNavMenu>
+    )
+  }
+
+  public render() {
+    return (
+      <SideNav aria-label="Side navigation" {...this.props} isChildOfHeader isFixedNav>
+        <SideNavItems>
+          {/* this.state.allNavs.map((nav, idx) => this.renderSideNavMenu(idx)) */}
+          {this.configure(0)}
+        </SideNavItems>
+      </SideNav>
+    )
+  }
+}

plugins/plugin-client-common/src/components/Screenshot.tsx

@@ -204,6 +204,7 @@ export default class Screenshot extends React.PureComponent<Props, State> {
         direction="top"
         className="kui--screenshot-tooltip"
         showIcon
+        tabIndex={-1}
         renderIcon={React.forwardRef(function screenshotIcon(props, ref) {
           return (
             <a

plugins/plugin-client-common/src/components/StatusStripe/index.tsx

@@ -18,6 +18,7 @@
 /* eslint-disable react/prop-types */
 
 import * as React from 'react'
+import { inElectron } from '@kui-shell/core'
 import { SettingsAdjust16 as SettingsIcon } from '@carbon/icons-react'
 
 import Screenshot from '../Screenshot'
@@ -58,9 +59,7 @@ export default class StatusStripe extends React.PureComponent {
       <div className="kui--status-stripe" id="kui--status-stripe">
         {this.widgets()}
         <div className="kui--status-stripe-button">
-          <div className="kui--status-stripe-element">
-            <Screenshot />
-          </div>
+          <div className="kui--status-stripe-element">{inElectron() && <Screenshot />}</div>
         </div>
 
         <div className="kui--status-stripe-button">
@@ -70,7 +69,7 @@ export default class StatusStripe extends React.PureComponent {
               className="kui--tab-navigatable clickable"
               id="help-button"
               aria-label="Help"
-              tabIndex={2}
+              tabIndex={0}
               onClick={() => this.doAbout()}
             >
               <SettingsIcon />

plugins/plugin-client-common/src/components/TabContainer.tsx

@@ -15,13 +15,14 @@
  */
 
 import * as React from 'react'
-import { eventBus } from '@kui-shell/core'
+import { inElectron, eventBus } from '@kui-shell/core'
 
-import Search from './Search'
 import TabModel from './TabModel'
 import TopTabStripe, { TopTabStripeConfiguration } from './TopTabStripe'
 import TabContent, { TabContentOptions } from './TabContent'
 
+import '../../web/css/static/TabContainer.scss'
+
 /**
  *
  * TabContainer
@@ -148,6 +149,8 @@ export default class TabContainer extends React.PureComponent<Props, State> {
   }
 
   public render() {
+    const Search = inElectron && React.lazy(() => import('./Search'))
+
     return (
       <div className="kui--full-height">
         <TopTabStripe
@@ -158,7 +161,9 @@ export default class TabContainer extends React.PureComponent<Props, State> {
           onCloseTab={(idx: number) => this.onCloseTab(idx)}
           onSwitchTab={(idx: number) => this.onSwitchTab(idx)}
         />
-        <Search />
+        <React.Suspense fallback={<div />}>
+          <Search />
+        </React.Suspense>
         <div className="tab-container">
           {this.state.tabs.map((_, idx) => (
             <TabContent key={idx} uuid={_.uuid} active={idx === this.state.activeIdx} state={_.state} {...this.props}>

plugins/plugin-client-common/src/components/TopTabStripe/NewTabButton.tsx

@@ -26,13 +26,13 @@ export default class NewTabButton extends React.PureComponent<Props> {
     return (
       <a
         href="#"
-        className="kui--tab-navigatable kui-new-tab__plus left-tab-stripe-button smaller-button kui-new-tab"
+        className="kui--tab-navigatable kui--new-tab__plus left-tab-stripe-button smaller-button kui-new-tab"
         id="new-tab-button"
         data-balloon-disabled="Open a new tab"
         data-balloon-pos="right"
         data-balloon-length="fit"
         aria-label="Open a new tab"
-        tabIndex={2}
+        tabIndex={0}
         onClick={() => this.props.onNewTab()}
       >
         <Add20 className="kui-new-tab__plus" focusable="false" preserveAspectRatio="xMidYMid meet" aria-hidden="true" />

plugins/plugin-client-common/src/components/TopTabStripe/Tab.tsx

@@ -17,6 +17,7 @@
 import * as React from 'react'
 import { Close16 } from '@carbon/icons-react'
 import { i18n, eventBus, Event, ExecType, Theme } from '@kui-shell/core'
+import { HeaderMenuItem } from 'carbon-components-react'
 
 const strings = i18n('plugin-core-support')
 
@@ -37,6 +38,7 @@ type Props = TabConfiguration & {
 interface State {
   title: string
   processing: boolean
+  isFreshlyCreated: boolean
   topTabNames: 'command' | 'fixed'
 }
 
@@ -49,8 +51,9 @@ export default class Tab extends React.PureComponent<Props, State> {
     super(props)
 
     this.state = {
-      title: this.props.productName,
+      title: strings('Tab'),
       processing: false,
+      isFreshlyCreated: true,
       topTabNames: props.topTabNames || 'command'
     }
 
@@ -93,12 +96,12 @@ export default class Tab extends React.PureComponent<Props, State> {
             !event.route.match(/^\/(tab|getting\/started)/) // ignore our own events and help
           ) {
             if (this.isUsingCommandName()) {
-              this.setState({ processing: true, title: event.command || this.state.title })
+              this.setState({ processing: true, title: event.command || this.state.title, isFreshlyCreated: false })
               return
             }
           }
 
-          this.setState({ processing: true })
+          this.setState({ processing: true, isFreshlyCreated: false })
         }
       }
     }
@@ -120,16 +123,17 @@ export default class Tab extends React.PureComponent<Props, State> {
 
   public render() {
     return (
-      <a
+      <HeaderMenuItem
         href="#"
+        data-tab-names={this.state.topTabNames}
+        data-fresh={this.state.isFreshlyCreated}
         className={
-          'kui-tab left-tab-stripe-button kui--tab-navigatable' +
-          (this.props.active ? ' kui-tab--active left-tab-stripe-button-selected' : '') +
+          'kui--tab kui--tab-navigatable' +
+          (this.props.active ? ' kui--tab--active' : '') +
           (this.state.processing ? ' processing' : '')
         }
         data-tab-button-index={this.props.idx + 1}
         aria-label="tab"
-        tabIndex={2}
         onMouseDown={evt => {
           evt.preventDefault()
           evt.stopPropagation()
@@ -138,25 +142,25 @@ export default class Tab extends React.PureComponent<Props, State> {
           this.props.onSwitchTab(this.props.idx)
         }}
       >
-        <div className="kui-tab--label left-tab-stripe-button-label">
+        <div className="kui--tab--label">
           {this.isUsingCommandName() && this.state.title}
-          {!this.isUsingCommandName() && <span className="kui-tab--label-text">{strings('Tab')} </span>}
-          {!this.isUsingCommandName() && <span className="kui-tab--label-index"></span>}
+          {!this.isUsingCommandName() && <span className="kui--tab--label-text">{strings('Tab')} </span>}
+          {!this.isUsingCommandName() && <span className="kui--tab--label-index"></span>}
         </div>
 
         {this.props.closeable && (
           <div
-            className="left-tab-stripe-button-closer"
+            className="kui--tab-close"
             onClick={evt => {
               evt.stopPropagation()
               evt.preventDefault()
               this.props.onCloseTab(this.props.idx)
             }}
           >
-            <Close16 focusable="false" width={12} height={16} preserveAspectRatio="xMidYMid meet" aria-hidden="true" />
+            <Close16 focusable="false" preserveAspectRatio="xMidYMid meet" aria-hidden="true" />
           </div>
         )}
-      </a>
+      </HeaderMenuItem>
     )
   }
 }