@scality/core-ui 0.115.0

package/src/lib/components/icon/Icon.component.tsx

@@ -0,0 +1,280 @@
+import React, {
+  CSSProperties,
+  HTMLProps,
+  PropsWithChildren,
+  useEffect,
+  useState,
+} from 'react';
+import styled, { css } from 'styled-components';
+import { brand } from '../../style/theme';
+
+import { Loader } from '../loader/Loader.component';
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+import { SizeProp } from '@fortawesome/fontawesome-svg-core';
+import { useQuery } from 'react-query';
+
+export const iconTable = {
+  Account: 'fas faWallet',
+  Backend: 'fas faNetworkWired',
+  Tape: 'fas faTape',
+  'Node-backend': 'fas faServer',
+  'Volume-backend': 'fas faHdd',
+  'Node-pdf': 'fas faDatabase',
+  'Volume-pdf': 'fas faCompactDisc',
+  Network: 'fas faProjectDiagram',
+  Bucket: 'fas faGlassWhiskey',
+  'Cloud-backend': 'fas faCloud',
+  Datacenter: 'fas faWarehouse',
+  'Simple-user': 'fas faUser',
+  User: 'fas faUserCog',
+  Group: 'fas faUsers',
+  Alert: 'fas faBell',
+  Bell: 'far faBell',
+  'Lat-menu': 'fas faBars',
+  Dashboard: 'fas faDesktop',
+  Workflow: 'fas faRoute',
+  Expiration: 'fas faStopwatch',
+  Replication: 'fas faCoins',
+  Transition: 'fas faRocket',
+  Discovery: 'fas faReply',
+  Metrics: 'fas faChartLine',
+  Edit: 'fas faEdit',
+  Logs: 'far faFileAlt',
+  Lock: 'fa faLock',
+  'Lock-open': 'fa faLockOpen',
+  'Create-add': 'fas faPlus',
+  Delete: 'fas faTrash',
+  Save: 'fas faSave',
+  'External-link': 'fas faExternalLinkAlt',
+  Link: 'fas faLink',
+  Unlink: 'fas faUnlink',
+  Close: 'fas faTimes',
+  'Dropdown-down': 'fas faCaretDown',
+  'Dropdown-up': 'fas faCaretUp',
+  Search: 'fas faSearch',
+  More: 'fas faEllipsisV',
+  Info: 'fas faQuestionCircle',
+  Sync: 'fas faSync',
+  Export: 'fas faFileExport',
+  Copy: 'far faClone',
+  'Simple-upload': 'fas faUpload',
+  Upload: 'fas faFileUpload',
+  'Add-plus': 'fas faPlusSquare',
+  Minus: 'fas faMinus',
+  'Remove-minus': 'fas faMinusSquare',
+  Sort: 'fas faSort',
+  'Sort-up': 'fas faSortUp',
+  'Sort-down': 'fas faSortDown',
+  Calendar: 'fas faCalendarWeek',
+  'Calendar-minus': 'fas faCalendarMinus',
+  'Arrow-up': 'fas faArrowUp',
+  'Arrow-down': 'fas faArrowDown',
+  'Arrow-right': 'fas faArrowRight',
+  'Arrow-left': 'fas faArrowLeft',
+  'Arrow-alt-circle-up': 'fas faArrowAltCircleUp',
+  Folder: 'far faFolder',
+  File: 'far faFile',
+  'File-invoice': 'fas faFileInvoice',
+  'Deletion-marker': 'fas faBan',
+  'Map-marker': 'fas faMapMarkerAlt',
+  Location: 'fas faMapMarkerAlt',
+  'Info-circle': 'fas faInfoCircle',
+  'Exclamation-triangle': 'fas faExclamationTriangle',
+  'Exclamation-circle': 'fas faExclamationCircle',
+  Exclamation: 'fas faExclamation',
+  Check: 'fas faCheck',
+  Protected: 'fas faShieldAlt',
+  'Chevron-left': 'fas faChevronLeft',
+  'Chevron-right': 'fas faChevronRight',
+  'Chevron-down': 'fas faChevronDown',
+  'Chevron-up': 'fas faChevronUp',
+  'Angle-right': 'fas faAngleRight',
+  'Angle-double-right': 'fas faAngleDoubleRight',
+  Language: 'fas faLanguage',
+  Theme: 'fas faPalette',
+  Documentation: 'fas faClipboardList',
+  Support: 'fas faComments',
+  EULA: 'fas faFileContract',
+  'Log-out': 'fas faSignOutAlt',
+  Hourglass: 'far faHourglass',
+  Pause: 'fas faPause',
+  'Pause-circle': 'far faPauseCircle',
+  'Play-circle': 'far faPlayCircle',
+  Upgrade: 'fas faLevelUpAlt',
+  Expansion: 'fas faExpandAlt',
+  Rebalance: 'fas faBalanceScale',
+  Maintenance: 'fas faHardHat',
+  Role: 'fas faHatCowboy',
+  'Change-erasure': 'fas faExchangeAlt',
+  'Circle-health': 'fas faCircle',
+  'Circle-empty': 'far faCircle',
+  'Dot-circle': 'fas faDotCircle',
+  'Check-circle': 'fas faCheckCircle',
+  'Times-circle': 'fas faTimesCircle',
+  Toolbox: 'fas faToolbox',
+  Cubes: 'fas faCubes',
+  'File-alt': 'fas faFilesAlt',
+  Policy: 'fas faFileSignature',
+  Pen: 'fa faPen',
+  Pencil: 'fas faPencilAlt',
+  Eye: 'fas faEye',
+  EyeSlash: 'fas faEyeSlash',
+  Snowflake: 'fas faSnowflake',
+  Key: 'fas faKey',
+  Filter: 'fas faFilter',
+  Download: 'fas faDownload',
+  Certificate: 'fas faCertificate',
+  Redo: 'fas faRedoAlt',
+  Eraser: 'fas faEraser',
+  'ID-card': 'fas faIdCard',
+  Setting: 'fas faCog', //TODO: Rename to Gear in FA v6 <i class="fa-sharp fa-solid fa-gear"></i>
+};
+
+const IconStyled = styled(FontAwesomeIcon)`
+  ${(props) => {
+    const theme = props.theme;
+    if (props.color && theme[props.color]) {
+      return css`
+        color: ${theme[props.color]};
+      `;
+    }
+  }}
+`;
+
+export type IconName = keyof typeof iconTable;
+export type IconColor = keyof typeof brand;
+type Props = {
+  name: IconName;
+  size?: SizeProp;
+  color?: IconColor | CSSProperties['color'];
+  ariaLabel?: string;
+  withWrapper?: boolean;
+};
+
+const DelayedFallback = ({
+  children,
+  ...rest
+}: PropsWithChildren<HTMLProps<HTMLElement>>) => {
+  const [show, setShow] = useState(false);
+  useEffect(() => {
+    let timeout = setTimeout(() => setShow(true), 300);
+    return () => {
+      clearTimeout(timeout);
+    };
+  }, []);
+
+  return <i {...rest}>{show && children}</i>;
+};
+
+export const IconWrapper = styled.div<{ size: SizeProp }>`
+  ${(props) => {
+    const brand = props.theme;
+    return css`
+      color: ${brand.infoPrimary};
+      border: 1px solid ${brand.infoPrimary};
+      background: ${brand.backgroundLevel1};
+      ${props.size === 'lg'
+        ? `
+        width: 2.5rem;
+        height: 2.5rem;
+      `
+        : props.size === 'sm'
+        ? `
+        width: 1.75rem;
+        height: 1.75rem;
+      `
+        : props.size === 'xs'
+        ? `
+        width: 1.5rem;
+        height: 1.5rem;
+      `
+        : `
+        width: ${parseInt(props.size.replace('x', '')) * 2}rem;
+        height: ${parseInt(props.size.replace('x', '')) * 2}rem;
+      `}
+    `;
+  }}
+
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  border-radius: 100%;
+`;
+
+function NonWrappedIcon({
+  name,
+  size = '1x',
+  color = undefined,
+  ariaLabel = '',
+  ...rest
+}: Omit<Props, 'withWrapper'>) {
+  const iconInfo = iconTable[name];
+  if (!iconInfo) throw new Error(`${name}: is not a valid icon.`);
+
+  const { data, status } = useQuery({
+    queryKey: ['icon', name],
+    queryFn: async () => {
+      const [iconType, iconClass] = iconInfo.split(' ');
+      try {
+        const fontAwesomeType =
+          iconType === 'far'
+            ? 'free-regular-svg-icons'
+            : 'free-solid-svg-icons';
+        const icon = await import(
+          `@fortawesome/${fontAwesomeType}/${iconClass}.js`
+        );
+        return {
+          default: ({ name, color, size, ariaLabel, ...rest }) => (
+            <IconStyled
+              color={color}
+              icon={icon[iconClass]}
+              size={size}
+              aria-label={`${name} ${ariaLabel}`}
+              {...rest}
+            />
+          ),
+        };
+      } catch {
+        return {
+          default: ({ name, ariaLabel }) => (
+            <Loader size="base" aria-label={`${name} ${ariaLabel}`} />
+          ),
+        };
+      }
+    },
+  });
+
+  return (
+    <>
+      {(status === 'loading' || status === 'error') && (
+        <DelayedFallback aria-label={`${name} ${ariaLabel}`}>
+          <Loader size="base" />
+        </DelayedFallback>
+      )}
+
+      {status === 'success' && (
+        <data.default
+          name={name}
+          color={color}
+          size={size}
+          ariaLabel={ariaLabel}
+          {...rest}
+        />
+      )}
+    </>
+  );
+}
+
+function Icon({ withWrapper, ...props }: Props) {
+  if (withWrapper) {
+    return (
+      <IconWrapper size={props.size || '1x'}>
+        <NonWrappedIcon {...props} />
+      </IconWrapper>
+    );
+  }
+
+  return <NonWrappedIcon {...props} />;
+}
+
+export { Icon };

package/src/lib/components/infomessage/InfoMessage.component.tsx

@@ -0,0 +1,47 @@
+import React from 'react';
+import styled, { useTheme } from 'styled-components';
+import { Stack } from '../../spacing';
+import { Icon } from '../icon/Icon.component';
+import { Link, Text } from '../text/Text.component';
+import { useComputeBackgroundColor } from './InfoMessageUtils';
+
+type Props = {
+  title: string | React.ReactNode;
+  content: React.ReactNode;
+  link?: string;
+};
+
+const InfoMessageContainer = styled.div`
+  background-color: ${(props) => props.theme.backgroundLevel2};
+  border-radius: 3px;
+  padding: 0.5rem;
+  display: flex;
+  flex-direction: column;
+  gap: 0.5rem;
+  color: white;
+`;
+
+export const InfoMessage = ({ title, content, link }: Props) => {
+  const { containerRef, backgroundColor } = useComputeBackgroundColor();
+  const theme = useTheme();
+
+  return (
+    <InfoMessageContainer
+      ref={containerRef}
+      style={{ backgroundColor: backgroundColor }}
+    >
+      <Stack>
+        <Icon name="Info-circle" color={theme.infoPrimary} size="lg" />
+        {typeof title === 'string' ? <Text isEmphazed>{title}</Text> : title}
+      </Stack>
+      <Text color="textSecondary" isGentleEmphazed>
+        {content}
+      </Text>
+      {link && (
+        <Link href={link} target="_blank" style={{ alignSelf: 'flex-end' }}>
+          More infos <Icon name="External-link"></Icon>
+        </Link>
+      )}
+    </InfoMessageContainer>
+  );
+};

package/src/lib/components/infomessage/InfoMessageUtils.test.tsx

@@ -0,0 +1,110 @@
+import '@testing-library/jest-dom';
+import { render } from '@testing-library/react';
+import React from 'react';
+import { coreUIAvailableThemes } from '../../style/theme';
+import { CoreUiThemeProvider } from '../coreuithemeprovider/CoreUiThemeProvider';
+import { useComputeBackgroundColor } from './InfoMessageUtils';
+
+describe('useComputeBackgroundColor', () => {
+  const SUT = jest.fn();
+  afterEach(() => {
+    SUT.mockClear();
+  });
+  it('should return backgroundlevel2 by default', () => {
+    //S
+    const Component = () => {
+      const { containerRef, backgroundColor } = useComputeBackgroundColor();
+      SUT(backgroundColor);
+      return <div ref={containerRef}></div>;
+    };
+    render(
+      <CoreUiThemeProvider theme={coreUIAvailableThemes.darkRebrand}>
+        <Component />
+      </CoreUiThemeProvider>,
+    );
+    //V
+    expect(SUT).toHaveBeenCalledWith(
+      coreUIAvailableThemes.darkRebrand.backgroundLevel2,
+    );
+  });
+
+  it('should return backgroundlevel3 if parent element backgroundColor is level 2', () => {
+    //S
+    const Component = () => {
+      const { containerRef, backgroundColor } = useComputeBackgroundColor();
+      SUT(backgroundColor);
+      return (
+        <div
+          style={{
+            backgroundColor: coreUIAvailableThemes.darkRebrand.backgroundLevel2,
+          }}
+        >
+          <div ref={containerRef}></div>
+        </div>
+      );
+    };
+    render(
+      <CoreUiThemeProvider theme={coreUIAvailableThemes.darkRebrand}>
+        <Component />
+      </CoreUiThemeProvider>,
+    );
+    //V
+    expect(SUT).toHaveBeenCalledWith(
+      coreUIAvailableThemes.darkRebrand.backgroundLevel3,
+    );
+  });
+  it('should return backgroundlevel3 if parent of parent element backgroundColor is level 2', () => {
+    //S
+    const Component = () => {
+      const { containerRef, backgroundColor } = useComputeBackgroundColor();
+      SUT(backgroundColor);
+      return (
+        <div
+          style={{
+            backgroundColor: coreUIAvailableThemes.darkRebrand.backgroundLevel2,
+          }}
+        >
+          <div>
+            <div ref={containerRef}></div>
+          </div>
+        </div>
+      );
+    };
+    render(
+      <CoreUiThemeProvider theme={coreUIAvailableThemes.darkRebrand}>
+        <Component />
+      </CoreUiThemeProvider>,
+    );
+    //V
+    expect(SUT).toHaveBeenCalledWith(
+      coreUIAvailableThemes.darkRebrand.backgroundLevel3,
+    );
+  });
+  it('should return backgroundlevel2 if parent of parent element backgroundColor is level 3', () => {
+    //S
+    const Component = () => {
+      const { containerRef, backgroundColor } = useComputeBackgroundColor();
+      SUT(backgroundColor);
+      return (
+        <div
+          style={{
+            backgroundColor: coreUIAvailableThemes.darkRebrand.backgroundLevel3,
+          }}
+        >
+          <div>
+            <div ref={containerRef}></div>
+          </div>
+        </div>
+      );
+    };
+    render(
+      <CoreUiThemeProvider theme={coreUIAvailableThemes.darkRebrand}>
+        <Component />
+      </CoreUiThemeProvider>,
+    );
+    //V
+    expect(SUT).toHaveBeenCalledWith(
+      coreUIAvailableThemes.darkRebrand.backgroundLevel2,
+    );
+  });
+});

package/src/lib/components/infomessage/InfoMessageUtils.ts

@@ -0,0 +1,39 @@
+import { DefaultTheme, useTheme } from "styled-components";
+import { hex2RGB } from "../../utils";
+import { useEffect, useRef, useState } from "react";
+
+export const useComputeBackgroundColor = () => {
+    const theme = useTheme();
+    const containerRef = useRef<HTMLDivElement | null>(null);
+    const [backgroundColor, setBackgroundColor] = useState('');
+  
+    useEffect(() => {
+      containerRef.current &&
+        setBackgroundColor(getBackgroundColor(containerRef.current, theme));
+    }, [containerRef,theme]);
+  
+    return {
+      containerRef,
+      backgroundColor,
+    };
+  };
+
+export const getBackgroundColor = (element: HTMLElement, theme: DefaultTheme) => {
+    if (element.parentElement) {
+      const parentElementBackgroundColor = window.getComputedStyle(
+        element.parentElement,
+      )['background-color'];
+      if (/rgba\([0-9]+, [0-9]+, [0-9]+, 0\)/.test(parentElementBackgroundColor) || !window.getComputedStyle(element.parentElement,)['background-color']) {
+        return getBackgroundColor(element.parentElement, theme);
+      } else {
+        const rgbArray = hex2RGB(theme.backgroundLevel2);
+        if (
+          `rgb(${rgbArray[0]}, ${rgbArray[1]}, ${rgbArray[2]})` ===
+          parentElementBackgroundColor
+        ) {
+          return theme.backgroundLevel3;
+        }
+      }
+    }
+    return theme.backgroundLevel2;
+  };

package/src/lib/components/input/Input.component.style.ts

@@ -0,0 +1,141 @@
+import styled, { css } from 'styled-components';
+import { spacing } from '../../spacing';
+import { fontSize } from '../../style/theme';
+import { getThemePropSelector } from '../../utils';
+export const InputContainer = styled.div<{
+  disabled: boolean;
+  error: string;
+  type: string;
+}>`
+  display: inline-flex;
+  ${(props) => {
+    if (props.disabled) {
+      return css`
+        opacity: 0.3;
+        input,
+        textarea,
+        select,
+        i {
+          cursor: not-allowed;
+        }
+      `;
+    }
+  }}
+  .sc-checkbox {
+    margin: ${spacing.r4} 0;
+  }
+
+  &.sc-select {
+    width: 200px;
+  }
+
+  input.sc-input-type {
+    ${(props) => {
+      const { backgroundLevel1, statusCritical, textSecondary, border } =
+        props.theme;
+      return css`
+        background-color: ${backgroundLevel1};
+        color: ${textSecondary};
+        border: 1px solid ${props.error ? statusCritical : border};
+      `;
+    }};
+    padding: 8px ${spacing.r8};
+    font-size: ${fontSize.base};
+    display: block;
+    border-radius: 4px;
+  }
+
+  input.sc-input-type:focus {
+    border-color: ${getThemePropSelector('selectedActive')};
+    outline: none;
+  }
+
+  input[type='number'] {
+    /* Adding a padding to make room for the custom absolute postionned arrows */
+    padding-right: 20px;
+    -moz-appearance: textfield; /*For FireFox*/
+
+    &::-webkit-inner-spin-button {
+      /*For Webkits like Chrome and Safari*/
+      -webkit-appearance: none;
+      margin: 0;
+    }
+  }
+
+  ${(props) => {
+    if (props.type === 'number')
+      return css`
+        .sc-input-wrapper {
+          .sc-number-input-wrapper {
+            position: relative;
+          }
+          align-items: baseline;
+          .carets-wrapper {
+            display: flex;
+            flex-direction: column;
+            ${(props) => {
+              const { textSecondary } = props.theme;
+              return css`
+                color: ${textSecondary};
+              `;
+            }};
+            position: absolute;
+            right: ${spacing.r4};
+            top: 50%;
+            transform: translate(-50%, -50%);
+
+            i {
+              font-size: 0.8em;
+              cursor: pointer;
+            }
+          }
+        }
+      `;
+  }}
+
+  ${(props) => {
+    if (props.error) {
+      return css`
+        @keyframes shake {
+          from,
+          to {
+            transform: translate3d(0, 0, 0);
+          }
+
+          10%,
+          30%,
+          50%,
+          70%,
+          90% {
+            transform: translate3d(-5px, 0, 0);
+          }
+
+          20%,
+          40%,
+          60%,
+          80% {
+            transform: translate3d(5px, 0, 0);
+          }
+        }
+        animation-duration: 1s;
+        animation-fill-mode: both;
+        animation-name: shake;
+      `;
+    }
+  }};
+`;
+export const LabelStyle = styled.label`
+  align-self: flex-start;
+  padding: ${spacing.r8};
+  font-size: ${fontSize.base};
+  color: ${getThemePropSelector('textPrimary')};
+`;
+export const InputErrorMessage = styled.span`
+  color: ${getThemePropSelector('statusCritical')};
+  margin: ${spacing.r4} 0;
+  font-size: ${fontSize.small};
+`;
+export const InputWrapper = styled.div`
+  display: flex;
+  flex-direction: column;
+`;