@redocly/theme 0.9.12 → 0.9.14

package/src/Sidebar/SidebarLayout.tsx

@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useEffect } from 'react';
 import styled from 'styled-components';
 
 import { Sidebar } from '@theme/Sidebar/Sidebar';
@@ -13,26 +13,49 @@ import { useThemeConfig } from '@theme/hooks/useThemeConfig';
 import { MobileSidebarIcon } from './MobileSidebarIcon';
 
 interface SidebarLayoutProps {
-  versions: React.ReactNode;
-  menu: React.ReactNode;
+  versions?: React.ReactNode;
+  menu?: React.ReactNode;
   backLink?: {
     label: string;
     slug: string;
   };
   footer?: React.ReactNode;
+  actions?: React.ReactNode;
   header?: React.ReactNode;
   growContent?: boolean;
+  collapsed?: boolean;
+  onToggleMenu?: (isOpen: boolean) => void;
 }
 
+const StyledFooterWrapper = styled(FooterWrapper)`
+  display: none;
+
+  ${({ theme }) => theme.mediaQueries?.medium} {
+    display: flex;
+  }
+`;
+
 export function SidebarLayout({
   versions,
   menu,
   footer,
   header,
   growContent,
+  collapsed,
+  onToggleMenu,
 }: SidebarLayoutProps): JSX.Element | null {
   const [isOpen, setIsOpen] = useMobileMenu();
-  const toggleMenu = () => setIsOpen(!isOpen);
+  const [mappedCollapsed, setMappedCollapsed] = React.useState(collapsed);
+
+  useEffect(() => {
+    setMappedCollapsed(collapsed && !isOpen);
+  }, [isOpen, collapsed, setMappedCollapsed]);
+
+  const toggleMenu = () => {
+    onToggleMenu?.(!isOpen);
+    setIsOpen(!isOpen);
+  };
+
   const { search, sidebar } = useThemeConfig();
 
   if (sidebar?.hide) {
@@ -40,20 +63,45 @@ export function SidebarLayout({
   }
 
   return (
-    <Wrapper data-component-name="Sidebar/SidebarLayout">
-      <MobileSidebarButton opened={isOpen} onClick={toggleMenu}>
-        <MobileSidebarIcon />
-      </MobileSidebarButton>
-
-      {!search?.hide && search?.placement === 'sidebar' ? <SidebarSearch /> : null}
-      <Sidebar animate={true} opened={isOpen}>
-        {header ? <HeaderWrapper>{header}</HeaderWrapper> : null}
-        {versions}
-        <MenuContainer growContent={growContent}>{menu}</MenuContainer>
-        {footer ? <FooterWrapper>{footer}</FooterWrapper> : null}
-      </Sidebar>
-    </Wrapper>
+    <>
+      {mappedCollapsed ? (
+        footer ? (
+          <Wrapper collapsed={true}>
+            <StyledFooterWrapper data-component-name="Sidebar/FooterWrapper" collapsed={true}>
+              {footer}
+            </StyledFooterWrapper>
+            <MobileSidebarButton opened={isOpen} onClick={toggleMenu}>
+              <MobileSidebarIcon />
+            </MobileSidebarButton>
+          </Wrapper>
+        ) : null
+      ) : (
+        <Wrapper data-component-name="Sidebar/SidebarLayout">
+          <MobileSidebarButton opened={isOpen} onClick={toggleMenu}>
+            <MobileSidebarIcon />
+          </MobileSidebarButton>
+          {!search?.hide && search?.placement === 'sidebar' ? <SidebarSearch /> : null}
+          <Sidebar animate={true} opened={isOpen}>
+            {header ? <HeaderWrapper>{header}</HeaderWrapper> : null}
+            {versions ? <>{versions}</> : null}
+            <MenuContainer growContent={growContent}>{menu}</MenuContainer>
+            {footer && !isOpen ? (
+              <FooterWrapper data-component-name="Sidebar/FooterWrapper">{footer}</FooterWrapper>
+            ) : null}
+          </Sidebar>
+        </Wrapper>
+      )}
+    </>
   );
 }
 
-const Wrapper = styled.div``;
+const Wrapper = styled.div<{ collapsed?: boolean }>`
+  ${({ collapsed }) =>
+    collapsed &&
+    `
+        display: flex;
+        flex-direction: column;
+        justify-content: flex-end;
+        border-right: 1px solid var(--sidebar-border-color);
+    `}
+`;

package/src/Sidebar/index.ts

@@ -13,6 +13,7 @@ export * from '@theme/Sidebar/MenuItemLabel';
 export * from '@theme/Sidebar/MenuLink';
 export * from '@theme/Sidebar/MenuLinkItem';
 export * from '@theme/Sidebar/MobileSidebarButton';
+export * from '@theme/Sidebar/MobileSidebarIcon';
 export * from '@theme/Sidebar/Separator';
 export * from '@theme/Sidebar/SeparatorItem';
 export * from '@theme/Sidebar/Sidebar';

package/src/SidebarActions/ChangeViewButton.tsx

@@ -0,0 +1,20 @@
+import React from 'react';
+
+import { LayoutVariant } from './SidebarActions';
+import { StyledChangeViewButton, ChangeViewSvgRow, ChangeViewSvgColumn } from './styled';
+
+interface ChangeViewButtonProps {
+  layout: LayoutVariant;
+  onClick: () => void;
+}
+
+export const ChangeViewButton = ({
+  layout,
+  onClick,
+}: ChangeViewButtonProps): JSX.Element | null => {
+  return (
+    <StyledChangeViewButton title="Change layout" onClick={onClick}>
+      {layout === LayoutVariant.STACKED ? <ChangeViewSvgRow /> : <ChangeViewSvgColumn />}
+    </StyledChangeViewButton>
+  );
+};

package/src/SidebarActions/CollapseSidebarButton.tsx

@@ -0,0 +1,21 @@
+import React from 'react';
+
+import { StyledToggleRightPanelButton, HideLeftPanelSVG, ShowLeftPanelSVG } from './styled';
+
+interface CollapseSidebarButtonProps {
+  initialValue: boolean;
+  onClick: () => void;
+}
+export const CollapseSidebarButton = ({
+  initialValue,
+  onClick,
+}: CollapseSidebarButtonProps): JSX.Element => {
+  return (
+    <StyledToggleRightPanelButton
+      title={initialValue ? 'Show sidebar' : 'Hide sidebar'}
+      onClick={onClick}
+    >
+      {initialValue ? <HideLeftPanelSVG /> : <ShowLeftPanelSVG />}
+    </StyledToggleRightPanelButton>
+  );
+};

package/src/SidebarActions/SidebarActions.tsx

@@ -0,0 +1,64 @@
+import React from 'react';
+
+import { ChangeViewButton } from './ChangeViewButton';
+import { ToggleRightPanelButton } from './ToggleRightPanelButton';
+import { CollapseSidebarButton } from './CollapseSidebarButton';
+import { ControlsWrap, ControlsWrapChangeLayoutButtons } from './styled';
+
+export enum LayoutVariant {
+  STACKED = 'stacked',
+  THREE_PANEL = 'three-panel',
+}
+
+interface SidebarActionsProps {
+  showChangeLayoutButton: boolean;
+  showRightPanelToggle: boolean;
+  layout: LayoutVariant;
+  initialShowRightPanelToggle: boolean;
+  collapsedSidebar: boolean;
+  isOpenapiDocs: boolean;
+  hideCollapseSidebarButton?: boolean;
+  onChangeRightPanelViewClick: () => void;
+  onChangeViewClick: () => void;
+  onChangeCollapseSidebarClick: () => void;
+  requestAccessButton?: React.ReactElement | null;
+}
+
+export const SidebarActions = ({
+  showChangeLayoutButton,
+  showRightPanelToggle,
+  layout,
+  initialShowRightPanelToggle,
+  hideCollapseSidebarButton = false,
+  collapsedSidebar,
+  isOpenapiDocs,
+  onChangeRightPanelViewClick,
+  onChangeViewClick,
+  onChangeCollapseSidebarClick,
+  requestAccessButton,
+}: SidebarActionsProps) => {
+  return (
+    <ControlsWrap isOpenapiDocs={isOpenapiDocs} isCollapsed={collapsedSidebar}>
+      {isOpenapiDocs && (
+        <ControlsWrapChangeLayoutButtons isCollapsed={collapsedSidebar}>
+          {initialShowRightPanelToggle && (
+            <ToggleRightPanelButton
+              showRightPanelToggle={showRightPanelToggle}
+              onClick={onChangeRightPanelViewClick}
+            />
+          )}
+          {showChangeLayoutButton && showRightPanelToggle && (
+            <ChangeViewButton layout={layout} onClick={onChangeViewClick} />
+          )}
+        </ControlsWrapChangeLayoutButtons>
+      )}
+      {!collapsedSidebar && requestAccessButton}
+      {!hideCollapseSidebarButton && (
+        <CollapseSidebarButton
+          initialValue={collapsedSidebar}
+          onClick={onChangeCollapseSidebarClick}
+        />
+      )}
+    </ControlsWrap>
+  );
+};

package/src/SidebarActions/ToggleRightPanelButton.tsx

@@ -0,0 +1,21 @@
+import React from 'react';
+
+import { StyledToggleRightPanelButton, HideRightPanelSVG, ShowRightPanelSVG } from './styled';
+
+interface ToggleRightPanelButtonProps {
+  showRightPanelToggle: boolean;
+  onClick: () => void;
+}
+export const ToggleRightPanelButton = ({
+  showRightPanelToggle,
+  onClick,
+}: ToggleRightPanelButtonProps): JSX.Element => {
+  return (
+    <StyledToggleRightPanelButton
+      title={showRightPanelToggle ? 'Hide samples' : 'Show samples'}
+      onClick={onClick}
+    >
+      {showRightPanelToggle ? <HideRightPanelSVG /> : <ShowRightPanelSVG />}
+    </StyledToggleRightPanelButton>
+  );
+};

package/src/SidebarActions/index.tsx

@@ -0,0 +1 @@
+export { SidebarActions, LayoutVariant } from './SidebarActions';

package/src/SidebarActions/styled.tsx

@@ -0,0 +1,157 @@
+import React from 'react';
+import styled, { css } from 'styled-components';
+
+export const ShowLeftPanelSVG = styled(() => (
+  <svg width="14" height="14" viewBox="0 0 14 14" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path
+      d="M4.375 7L8.75 2.625L9.3625 3.2375L5.6 7L9.3625 10.7625L8.75 11.375L4.375 7Z"
+      fill="var(--color-emphasis-400)"
+    />
+  </svg>
+))`
+  position: absolute;
+`;
+
+export const HideLeftPanelSVG = styled(() => (
+  <svg width="14" height="14" viewBox="0 0 14 14" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path
+      d="M9.62495 7L5.24995 11.375L4.63745 10.7625L8.39995 7L4.63745 3.2375L5.24995 2.625L9.62495 7Z"
+      fill="var(--color-emphasis-400)"
+    />
+  </svg>
+))`
+  position: absolute;
+`;
+
+export const StyledToggleRightPanelButton = styled.a`
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  cursor: pointer;
+  z-index: 1;
+  /* Rectangle 201 */
+  border-radius: var(--border-radius);
+  padding: var(--spacing-unit);
+
+  &:hover {
+    background-color: var(--sidebar-item-active-background-color);
+  }
+`;
+
+export const HideRightPanelSVG = styled(() => (
+  <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path
+      d="M14 2H2C1.73478 2 1.48043 2.10536 1.29289 2.29289C1.10536 2.48043 1 2.73478 1 3V13C1 13.2652 1.10536 13.5196 1.29289 13.7071C1.48043 13.8946 1.73478 14 2 14H14C14.2652 14 14.5196 13.8946 14.7071 13.7071C14.8946 13.5196 15 13.2652 15 13V3C15 2.73478 14.8946 2.48043 14.7071 2.29289C14.5196 2.10536 14.2652 2 14 2V2ZM2 3H10V13H2V3Z"
+      fill="var(--color-emphasis-400)"
+    />
+  </svg>
+))`
+  position: absolute;
+`;
+
+export const ShowRightPanelSVG = styled(() => (
+  <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path
+      d="M14 2H2C1.73478 2 1.48043 2.10536 1.29289 2.29289C1.10536 2.48043 1 2.73478 1 3V13C1 13.2652 1.10536 13.5196 1.29289 13.7071C1.48043 13.8946 1.73478 14 2 14H14C14.2652 14 14.5196 13.8946 14.7071 13.7071C14.8946 13.5196 15 13.2652 15 13V3C15 2.73478 14.8946 2.48043 14.7071 2.29289C14.5196 2.10536 14.2652 2 14 2V2ZM2 3H10V13H2V3ZM14 13H11V3H14V13Z"
+      fill="var(--color-emphasis-400)"
+    />
+  </svg>
+))`
+  position: absolute;
+`;
+
+export const StyledChangeViewButton = styled.a`
+  display: flex;
+  position: relative;
+  justify-content: center;
+  align-items: center;
+  cursor: pointer;
+  border-radius: var(--border-radius);
+  z-index: 1;
+  /* Rectangle 201 */
+  padding: var(--spacing-unit);
+
+  &:hover {
+    background-color: var(--sidebar-item-active-background-color);
+  }
+`;
+
+export const ChangeViewSvgRow = styled(() => (
+  <svg width="14" height="14" viewBox="0 0 14 14" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path
+      d="M1.75 2.625L12.25 2.625L12.25 1.75L1.75 1.75L1.75 2.625Z"
+      fill="var(--color-emphasis-400)"
+    />
+    <path
+      d="M1.75 5.6875L12.25 5.6875L12.25 4.8125L1.75 4.8125L1.75 5.6875Z"
+      fill="var(--color-emphasis-400)"
+    />
+    <path
+      d="M2.625 11.375L2.625 8.75L11.375 8.75L11.375 11.375L2.625 11.375ZM2.625 12.25L11.375 12.25C11.6071 12.25 11.8296 12.1578 11.9937 11.9937C12.1578 11.8296 12.25 11.6071 12.25 11.375L12.25 8.75C12.25 8.51794 12.1578 8.29538 11.9937 8.13128C11.8296 7.96719 11.6071 7.875 11.375 7.875L2.625 7.875C2.39294 7.875 2.17038 7.96719 2.00628 8.13128C1.84219 8.29538 1.75 8.51793 1.75 8.75L1.75 11.375C1.75 11.6071 1.84219 11.8296 2.00628 11.9937C2.17038 12.1578 2.39294 12.25 2.625 12.25Z"
+      fill="var(--color-emphasis-400)"
+    />
+  </svg>
+))`
+  position: absolute;
+`;
+
+export const ChangeViewSvgColumn = styled(() => (
+  <svg width="14" height="14" viewBox="0 0 14 14" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path
+      d="M2.625 12.25L2.625 1.75L1.75 1.75L1.75 12.25L2.625 12.25Z"
+      fill="var(--color-emphasis-400)"
+    />
+    <path
+      d="M5.6875 12.25L5.6875 1.75L4.8125 1.75L4.8125 12.25L5.6875 12.25Z"
+      fill="var(--color-emphasis-400)"
+    />
+    <path
+      d="M11.375 11.375L8.75 11.375L8.75 2.625L11.375 2.625L11.375 11.375ZM12.25 11.375L12.25 2.625C12.25 2.39294 12.1578 2.17038 11.9937 2.00628C11.8296 1.84219 11.6071 1.75 11.375 1.75L8.75 1.75C8.51794 1.75 8.29538 1.84219 8.13128 2.00628C7.96719 2.17038 7.875 2.39294 7.875 2.625L7.875 11.375C7.875 11.6071 7.96719 11.8296 8.13128 11.9937C8.29538 12.1578 8.51794 12.25 8.75 12.25L11.375 12.25C11.6071 12.25 11.8296 12.1578 11.9937 11.9937C12.1578 11.8296 12.25 11.6071 12.25 11.375Z"
+      fill="var(--color-emphasis-400)"
+    />
+  </svg>
+))`
+  position: absolute;
+`;
+
+export const ControlsWrap = styled.span<{
+  iconCount?: number;
+  isCollapsed?: boolean;
+  isOpenapiDocs?: boolean;
+}>`
+  display: none;
+  justify-content: ${({ isOpenapiDocs }) => (isOpenapiDocs ? 'space-between' : 'flex-end')};
+  bottom: 0;
+  flex-direction: row;
+  gap: var(--spacing-unit);
+  align-items: center;
+  margin-left: '15px';
+  z-index: 2;
+  background: var(--sidebar-background-color);
+
+  ${({ isCollapsed }) =>
+    isCollapsed &&
+    css`
+      flex-direction: column;
+      gap: 10px;
+      padding-bottom: 10px;
+    `}
+
+  ${({ theme }) => css`
+    ${theme.mediaQueries[theme.showAtBreakpoint.sidebar]} {
+      display: flex;
+    }
+
+    ${theme.mediaQueries.print} {
+      display: none;
+    }
+  `}
+`;
+
+export const ControlsWrapChangeLayoutButtons = styled.span<{ isCollapsed?: boolean }>`
+  display: flex;
+  bottom: 0;
+  flex-direction: ${({ isCollapsed }) => (isCollapsed ? 'column-reverse' : 'row')};
+  gap: ${({ isCollapsed }) => (isCollapsed ? '10px' : 'var(--spacing-unit)')};
+  align-items: center;
+`;