Expand EuiFlyout usage to help EuiCollapsibleNav

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 - Added `textTransform` property to `schemaDetectors` prop of `EuiDataGrid`([#4752](https://github.com/elastic/eui/pull/4752))
 - Added `color`, `continuityAbove`, `continuityAboveBelow`, `continuityBelow`, `continuityWithin`, `eraser`, `fullScreenExit`, `function`, `percent`, `wordWrap`, and `wordWrapDisabled` glyphs to `EuiIcon` ([#4779](https://github.com/elastic/eui/pull/4779))
+- Added `as`, `role`, `closeButtonProps`, `closeButtonPosition`, `outsideClickCloses`, `side`, `type`, and `pushMinBreakpoint` props to `EuiFlyout` ([#4713](https://github.com/elastic/eui/pull/4713))
+- Extended `EuiFlyout` `size` prop to accept any CSS `width` value ([#4713](https://github.com/elastic/eui/pull/4713))
+- Extended `EuiFlyout` and most of its props in `EuiCollapsibleNav` ([#4713](https://github.com/elastic/eui/pull/4713))
+
+**Breaking changes**
+
+- Changed the default of `EuiFlyout` `ownFocus` to `true` ([#4713](https://github.com/elastic/eui/pull/4713))
+- Wrapped `EuiFlyout` within the `EuiOverlayMask` when `ownFocus=true` ([#4713](https://github.com/elastic/eui/pull/4713))
+- Changed `EuiCollapsibleNav` width sizing from a Sass variable to a `size` prop ([#4713](https://github.com/elastic/eui/pull/4713))
+- Changed `EuiOverlayMask` z-indexing when positioned `below` header to using `top` offset ([#4713](https://github.com/elastic/eui/pull/4713))
 
 ## [`33.0.0`](https://github.com/elastic/eui/tree/v33.0.0)
 

src-docs/src/components/guide_components.scss

@@ -211,7 +211,7 @@ $elasticLogoTextDark: #1C1E23;
   height: 100%;
   left: 0;
   top: 0;
-  z-index: $euiZHeader + 1;
+  z-index: $euiZHeader;
   overflow: auto;
 
   &--withHeader {

src-docs/src/services/playground/knobs.js

@@ -324,7 +324,7 @@ const Knob = ({
             }}
           />
         );
-      } else return null;
+      } else return helpText || null;
 
     case PropTypes.Custom:
       if (custom && custom.use) {
@@ -352,9 +352,9 @@ const Knob = ({
     case PropTypes.Function:
     case PropTypes.Array:
     case PropTypes.Object:
-      return null;
+      return helpText || null;
     default:
-      return assertUnreachable();
+      return helpText || assertUnreachable();
   }
 };
 

src-docs/src/views/collapsible_nav/collapsible_nav.tsx

@@ -8,16 +8,25 @@ import { EuiText } from '../../../../src/components/text';
 import { EuiCode } from '../../../../src/components/code';
 
 export default () => {
-  const [navIsOpen, setNavIsOpen] = useState(false);
-  const [navIsDocked, setNavIsDocked] = useState(false);
+  const [navIsOpen, setNavIsOpen] = useState<boolean>(
+    JSON.parse(
+      String(localStorage.getItem('euiCollapsibleNavExample--isDocked'))
+    ) || false
+  );
+  const [navIsDocked, setNavIsDocked] = useState<boolean>(
+    JSON.parse(
+      String(localStorage.getItem('euiCollapsibleNavExample--isDocked'))
+    ) || false
+  );
 
   return (
     <>
       <EuiCollapsibleNav
         isOpen={navIsOpen}
         isDocked={navIsDocked}
+        size={240}
         button={
-          <EuiButton onClick={() => setNavIsOpen(!navIsOpen)}>
+          <EuiButton onClick={() => setNavIsOpen((isOpen) => !isOpen)}>
             Toggle nav
           </EuiButton>
         }
@@ -27,9 +36,20 @@ export default () => {
             <h2>I am some nav</h2>
           </EuiTitle>
           <EuiSpacer />
+          <EuiText size="s" color="subdued">
+            <p>
+              The docked status is being stored in{' '}
+              <EuiCode>localStorage</EuiCode>.
+            </p>
+          </EuiText>
+          <EuiSpacer />
           <EuiButton
             onClick={() => {
               setNavIsDocked(!navIsDocked);
+              localStorage.setItem(
+                'euiCollapsibleNavExample--isDocked',
+                JSON.stringify(!navIsDocked)
+              );
             }}>
             Docked: {navIsDocked ? 'on' : 'off'}
           </EuiButton>
@@ -39,8 +59,9 @@ export default () => {
       {navIsDocked && (
         <EuiText size="s" color="subdued">
           <p>
-            The button gets hidden by default when the nav is docked unless you
-            set <EuiCode language="js">showButtonIfDocked = true</EuiCode>.
+            The <EuiCode>button</EuiCode> gets hidden by default when the nav is
+            docked unless you set{' '}
+            <EuiCode language="js">showButtonIfDocked = true</EuiCode>.
           </p>
         </EuiText>
       )}

src-docs/src/views/collapsible_nav/collapsible_nav_all.tsx

@@ -56,11 +56,9 @@ const LearnLinks: EuiPinnableListGroupItemProps[] = [
 ];
 
 export default () => {
-  const [navIsOpen, setNavIsOpen] = useState(
-    JSON.parse(String(localStorage.getItem('navIsDocked'))) || false
-  );
+  const [navIsOpen, setNavIsOpen] = useState(true);
   const [navIsDocked, setNavIsDocked] = useState(
-    JSON.parse(String(localStorage.getItem('navIsDocked'))) || false
+    JSON.parse(String(localStorage.getItem('nav2IsDocked'))) || false
   );
 
   /**
@@ -234,7 +232,7 @@ export default () => {
               onClick={() => {
                 setNavIsDocked(!navIsDocked);
                 localStorage.setItem(
-                  'navIsDocked',
+                  'nav2IsDocked',
                   JSON.stringify(!navIsDocked)
                 );
               }}

src-docs/src/views/collapsible_nav/collapsible_nav_example.js

@@ -1,8 +1,6 @@
 import React from 'react';
 import { Link } from 'react-router-dom';
 
-import { renderToHtml } from '../../services';
-
 import { GuideSectionTypes } from '../../components';
 
 import {
@@ -11,23 +9,22 @@ import {
   EuiText,
   EuiCallOut,
   EuiCollapsibleNavGroup,
+  EuiHorizontalRule,
 } from '../../../../src/components';
 
+import { collapsibleNavConfig } from './playground';
+
 import CollapsibleNav from './collapsible_nav';
 const collapsibleNavSource = require('!!raw-loader!./collapsible_nav');
-const collapsibleNavHtml = renderToHtml(CollapsibleNav);
 
 import CollapsibleNavGroup from './collapsible_nav_group';
 const collapsibleNavGroupSource = require('!!raw-loader!./collapsible_nav_group');
-const collapsibleNavGroupHtml = renderToHtml(CollapsibleNavGroup);
 
 import CollapsibleNavList from './collapsible_nav_list';
 const collapsibleNavListSource = require('!!raw-loader!./collapsible_nav_list');
-const collapsibleNavListHtml = renderToHtml(CollapsibleNavList);
 
 import CollapsibleNavAll from './collapsible_nav_all';
 const collapsibleNavAllSource = require('!!raw-loader!./collapsible_nav_all');
-const collapsibleNavAllHtml = renderToHtml(CollapsibleNavAll);
 
 export const CollapsibleNavExample = {
   title: 'Collapsible nav',
@@ -46,19 +43,15 @@ export const CollapsibleNavExample = {
           type: GuideSectionTypes.JS,
           code: collapsibleNavSource,
         },
-        {
-          type: GuideSectionTypes.HTML,
-          code: collapsibleNavHtml,
-        },
       ],
       text: (
         <>
           <p>
-            <strong>EuiCollapsibleNav</strong> is a similar implementation to{' '}
+            <strong>EuiCollapsibleNav</strong> is a custom implementation of{' '}
             <Link to="/layout/flyout">
               <strong>EuiFlyout</strong>
             </Link>
-            ; the visibility of which must be maintained by the consuming
+            ; the visibility of which must still be maintained by the consuming
             application. An extra feature that it provides is the ability to{' '}
             <EuiCode>dock</EuiCode> the flyout. This affixes the flyout to the
             window and pushes the body content by adding left side padding.
@@ -72,11 +65,14 @@ export const CollapsibleNavExample = {
       props: { EuiCollapsibleNav },
       demo: <CollapsibleNav />,
       snippet: `<EuiCollapsibleNav
+  ownFocus={false}
+  size={240}
   button={<EuiButton onClick={() => setNavIsOpen(!navIsOpen)}>Toggle nav</EuiButton>}
   isOpen={navIsOpen}
   isDocked={navIsDocked}
   onClose={() => setNavIsOpen(false)}
 />`,
+      playground: collapsibleNavConfig,
     },
     {
       title: 'Collapsible nav group',
@@ -85,10 +81,6 @@ export const CollapsibleNavExample = {
           type: GuideSectionTypes.JS,
           code: collapsibleNavGroupSource,
         },
-        {
-          type: GuideSectionTypes.HTML,
-          code: collapsibleNavGroupHtml,
-        },
       ],
       text: (
         <>
@@ -130,10 +122,6 @@ export const CollapsibleNavExample = {
           type: GuideSectionTypes.JS,
           code: collapsibleNavListSource,
         },
-        {
-          type: GuideSectionTypes.HTML,
-          code: collapsibleNavListHtml,
-        },
       ],
       text: (
         <>
@@ -152,7 +140,15 @@ export const CollapsibleNavExample = {
           <p>Below are a few established patterns to use.</p>
         </>
       ),
-      demo: <CollapsibleNavList />,
+      demo: (
+        <div>
+          <CollapsibleNavList />
+          <EuiHorizontalRule margin="none" />
+        </div>
+      ),
+      demoPanelProps: {
+        paddingSize: 'none',
+      },
       snippet: `<EuiCollapsibleNavGroup
   title="Kibana"
   iconType="logoKibana"
@@ -179,10 +175,6 @@ export const CollapsibleNavExample = {
           type: GuideSectionTypes.JS,
           code: collapsibleNavAllSource,
         },
-        {
-          type: GuideSectionTypes.HTML,
-          code: collapsibleNavAllHtml,
-        },
       ],
       text: (
         <>

src-docs/src/views/collapsible_nav/playground.js

@@ -0,0 +1,54 @@
+import { PropTypes } from 'react-view';
+import { EuiCollapsibleNav } from '../../../../src/components/';
+import { propUtilityForPlayground } from '../../services/playground';
+
+export const collapsibleNavConfig = () => {
+  const docgenInfo = Array.isArray(EuiCollapsibleNav.__docgenInfo)
+    ? EuiCollapsibleNav.__docgenInfo[0]
+    : EuiCollapsibleNav.__docgenInfo;
+  const propsToUse = propUtilityForPlayground(docgenInfo.props);
+
+  propsToUse.isOpen = {
+    ...propsToUse.isOpen,
+    value: true,
+  };
+
+  propsToUse.ownFocus = {
+    ...propsToUse.ownFocus,
+    value: false,
+    disabled: true,
+  };
+
+  propsToUse.size = {
+    ...propsToUse.size,
+    type: PropTypes.Number,
+    value: 240,
+  };
+
+  propsToUse.as = {
+    ...propsToUse.as,
+    type: PropTypes.string,
+    value: 'nav',
+  };
+
+  propsToUse.as = {
+    ...propsToUse.as,
+    type: PropTypes.string,
+    value: 'nav',
+  };
+
+  return {
+    config: {
+      componentName: 'EuiCollapsibleNav',
+      props: propsToUse,
+      scope: {
+        EuiCollapsibleNav,
+      },
+      imports: {
+        '@elastic/eui': {
+          named: ['EuiCollapsibleNav'],
+        },
+      },
+    },
+  };
+};