@spaced-out/ui-design-system 0.3.45 → 0.3.46

package/lib/components/Menu/Menu.d.ts

@@ -1,379 +0,0 @@
-import {$ReadOnly} from 'utility-types';
-import * as React from 'react';
-import {FixedSizeList} from 'react-window';
-import type {MenuClassNames, MenuLabelTooltip} from '../../types/menu';
-import {classify} from '../../utils/classify';
-import {
-  getFilteredComposeOptionsFromSearchText,
-  getFilteredComposeOptionsResultText,
-  getFilteredGroupTitleOptionsFromSearchText,
-  getFilteredGroupTitleOptionsResultText,
-  getFilteredOptionsFromSearchText,
-  getFilteredOptionsResultText,
-} from '../../utils/menu';
-import type {IconType} from '../Icon/Icon';
-import {SearchInput} from '../SearchInput';
-import {FormLabelSmall} from '../Text';
-import {MenuOptionButton} from './MenuOptionButton';
-import css from './Menu.module.css';
-type ClassNames = MenuClassNames;
-type OptionClassNames = $ReadOnly<{
-  wrapper?: string;
-}>;
-export type Virtualization = $ReadOnly<{
-  enable: boolean;
-  itemHeight?: number;
-  menuHeight?: number;
-}>;
-export type MenuOption = {
-  key: string;
-  classNames?: OptionClassNames;
-  label?: string;
-  secondaryLabel?: string;
-  customComponent?: React.ReactNode;
-  iconLeft?: string;
-  iconLeftType?: IconType;
-  iconRight?: string;
-  iconRightType?: IconType;
-  disabled?: boolean;
-  optionSize?: MenuSizeTypes;
-  optionVariant?: MenuOptionsVariant;
-  keepMenuOpenOnOptionSelect?: boolean;
-  indeterminate?: boolean;
-};
-// Render first available option set
-export type BaseMenuProps = {
-  onSelect?: (
-    option: MenuOption,
-    arg1: React.SyntheticEvent<HTMLElement> | null | undefined,
-  ) => unknown;
-  selectedOption?: MenuOption | null | undefined;
-  optionsVariant?: MenuOptionsVariant;
-  selectedKeys?: Array<string>;
-  classNames?: ClassNames;
-  size?: MenuSizeTypes;
-  width?: string;
-  menuDisabled?: boolean;
-  isFluid?: boolean;
-  // onTabOut is a callback function that is called when
-  // the user navigates outside of the menu using the tab key.
-  onTabOut?: () => unknown;
-  allowSearch?: boolean;
-  // A function that resolves the label for a MenuOption.
-  // It takes a MenuOption as a parameter and returns either a string or a React Node.
-  resolveLabel?: (option: MenuOption) => string | React.ReactNode;
-  // A function that resolves the secondaryLabel for a MenuOption.
-  // It takes a MenuOption as a parameter and returns either a string or a React Node.
-  resolveSecondaryLabel?: (option: MenuOption) => string | React.ReactNode;
-  // When virtualization is enabled, the MenuOptionButtons will be rendered only when they are present in the Menu's viewport
-  virtualization?: Virtualization;
-  header?: React.ReactNode;
-  footer?: React.ReactNode;
-  showResultText?: boolean;
-  staticLabels?: {
-    RESULT?: string;
-    RESULTS?: string;
-    SEARCH_PLACEHOLDER?: string;
-  };
-  showLabelTooltip?: MenuLabelTooltip;
-  allowWrap?: boolean;
-};
-export type MenuOptionTypes = {
-  options?: Array<MenuOption>;
-  composeOptions?: Array<Array<MenuOption>>;
-  groupTitleOptions?: Array<MenuGroupTitleOption>;
-};
-export type MenuSizeTypes = 'medium' | 'small';
-export type MenuOptionsVariant = 'checkbox' | 'radio' | 'normal';
-export type MenuGroupTitleOption = {
-  groupTitle?: React.ReactNode;
-  options?: Array<MenuOption>;
-  showLineDivider?: boolean;
-};
-export type MenuProps = BaseMenuProps & MenuOptionTypes;
-export type RenderOptionProps = MenuProps & {
-  searchText?: string;
-};
-const menuSizeMedium = 276,
-  menuSizeSmall = 228;
-const buttonSizeMedium = 40,
-  buttonSizeSmall = 32;
-
-const RenderOption = ({
-  options,
-  composeOptions,
-  groupTitleOptions,
-  classNames,
-  searchText = '',
-  showResultText = true,
-  staticLabels = {
-    RESULT: 'result',
-    RESULTS: 'results',
-    SEARCH_PLACEHOLDER: 'Search...',
-  },
-  ...restProps
-}: RenderOptionProps): React.ReactNode => {
-  const {
-    allowSearch,
-    size,
-    virtualization = {
-      enable: false,
-      menuHeight: null,
-      itemHeight: null,
-    },
-  } = restProps;
-
-  if (options && Array.isArray(options) && options.length) {
-    const optionsFiltered = !allowSearch
-      ? options
-      : getFilteredOptionsFromSearchText(options, searchText);
-    const finalResultText = !allowSearch
-      ? ''
-      : getFilteredOptionsResultText(optionsFiltered, staticLabels);
-    const {
-      enable: isVirtualizationEnabled,
-      menuHeight,
-      itemHeight,
-    } = virtualization;
-    return (
-      <>
-        {allowSearch && showResultText && (
-          <FormLabelSmall
-            className={css.filterOptionsResultText}
-            color="tertiary"
-          >
-            {finalResultText}
-          </FormLabelSmall>
-        )}
-        {virtualization && isVirtualizationEnabled ? (
-          <FixedSizeList
-            height={
-              menuHeight || (size === 'medium' ? menuSizeMedium : menuSizeSmall)
-            }
-            itemSize={
-              itemHeight ||
-              (size === 'medium' ? buttonSizeMedium : buttonSizeSmall)
-            }
-            itemCount={optionsFiltered.length}
-          >
-            {({index: idx, style}) => {
-              const buttonOption = optionsFiltered[idx];
-              return (
-                <React.Fragment key={buttonOption.key}>
-                  <MenuOptionButton
-                    option={buttonOption}
-                    classNames={classNames}
-                    style={style}
-                    {...restProps}
-                    isLastItem={idx === optionsFiltered.length - 1}
-                  />
-                </React.Fragment>
-              );
-            }}
-          </FixedSizeList>
-        ) : (
-          optionsFiltered.map((option, idx) => (
-            <React.Fragment key={option.key}>
-              <MenuOptionButton
-                option={option}
-                classNames={classNames}
-                {...restProps}
-                isLastItem={idx === optionsFiltered.length - 1}
-              />
-            </React.Fragment>
-          ))
-        )}
-      </>
-    );
-  }
-
-  if (
-    composeOptions &&
-    Array.isArray(composeOptions) &&
-    composeOptions.length
-  ) {
-    const optionsFiltered = !allowSearch
-      ? composeOptions
-      : getFilteredComposeOptionsFromSearchText(composeOptions, searchText);
-    const finalResultText = !allowSearch
-      ? ''
-      : getFilteredComposeOptionsResultText(optionsFiltered, staticLabels);
-    return (
-      <>
-        {allowSearch && showResultText && (
-          <FormLabelSmall
-            className={css.filterOptionsResultText}
-            color="tertiary"
-          >
-            {finalResultText}
-          </FormLabelSmall>
-        )}
-        {optionsFiltered.map(
-          (
-            composeMenuOptions,
-            index, // eslint-disable-next-line react/no-array-index-key
-          ) => (
-            <span key={index} className={css.menuDivider}>
-              {composeMenuOptions.map((option, idx) => (
-                <React.Fragment key={option.key}>
-                  <MenuOptionButton
-                    option={option}
-                    classNames={classNames}
-                    {...restProps}
-                    isLastItem={
-                      index === optionsFiltered.length - 1 &&
-                      idx === composeMenuOptions.length - 1
-                    }
-                  />
-                </React.Fragment>
-              ))}
-            </span>
-          ),
-        )}
-      </>
-    );
-  }
-
-  if (
-    groupTitleOptions &&
-    Array.isArray(groupTitleOptions) &&
-    groupTitleOptions.length
-  ) {
-    const optionsFiltered = !allowSearch
-      ? groupTitleOptions
-      : getFilteredGroupTitleOptionsFromSearchText(
-          groupTitleOptions,
-          searchText,
-        );
-    const finalResultText = !allowSearch
-      ? ''
-      : getFilteredGroupTitleOptionsResultText(optionsFiltered, staticLabels);
-    return (
-      <>
-        {allowSearch && showResultText && (
-          <FormLabelSmall
-            className={css.filterOptionsResultText}
-            color="tertiary"
-          >
-            {finalResultText}
-          </FormLabelSmall>
-        )}
-        {optionsFiltered.map(
-          (
-            optionsGroup,
-            index, // eslint-disable-next-line react/no-array-index-key
-          ) => (
-            <React.Fragment key={index}>
-              {!!optionsGroup.groupTitle && (
-                <div
-                  className={classify(
-                    css.groupTitleWrapper,
-                    classNames?.groupTitle,
-                  )}
-                >
-                  {optionsGroup.groupTitle}
-                </div>
-              )}
-
-              {optionsGroup.options?.map((option, idx) => (
-                <React.Fragment key={option.key}>
-                  <MenuOptionButton
-                    option={option}
-                    classNames={classNames}
-                    {...restProps}
-                    isLastItem={
-                      index === optionsFiltered.length - 1 &&
-                      idx ===
-                        (optionsGroup.options &&
-                          optionsGroup.options.length - 1)
-                    }
-                  />
-                </React.Fragment>
-              ))}
-            </React.Fragment>
-          ),
-        )}
-      </>
-    );
-  }
-
-  return <></>;
-};
-
-export const Menu: React$AbstractComponent<MenuProps, HTMLDivElement> =
-  React.forwardRef<MenuProps, HTMLDivElement>(
-    (props: MenuProps, ref): React.ReactNode => {
-      const {
-        classNames,
-        size = 'medium',
-        width,
-        isFluid = true,
-        allowSearch,
-        virtualization = {
-          enable: false,
-          menuHeight: null,
-          itemHeight: null,
-        },
-        header,
-        footer,
-        staticLabels,
-      } = props;
-      const [searchText, setSearchText] = React.useState('');
-      const {menuHeight} = virtualization;
-      const hasHeader = header ? true : false;
-      const hasFooter = footer ? true : false;
-      return (
-        <div
-          className={classify(
-            css.menuCard,
-            {
-              [css.fluid]: isFluid,
-              [css.medium]: size === 'medium',
-              [css.mediumWithHeader]:
-                size === 'medium' && hasHeader && !hasFooter,
-              [css.mediumWithFooter]:
-                size === 'medium' && !hasHeader && hasFooter,
-              [css.mediumWithHeaderAndFooter]:
-                size === 'medium' && hasFooter && hasHeader,
-              [css.small]: size === 'small',
-              [css.smallWithHeader]:
-                size === 'small' && hasHeader && !hasFooter,
-              [css.smallWithFooter]:
-                size === 'small' && !hasHeader && hasFooter,
-              [css.smallWithHeaderAndFooter]:
-                size === 'small' && hasFooter && hasHeader,
-              [css.menuCardTopPaddingZero]: header,
-              [css.menuCardBottomPaddingZero]: footer,
-            },
-            classNames?.wrapper,
-          )}
-          style={{
-            width,
-            maxHeight: menuHeight ? menuHeight + 'px' : '',
-          }}
-          ref={ref}
-        >
-          {hasHeader && (
-            <div className={classify(css.menuHeader, classNames?.header)}>
-              {header}
-            </div>
-          )}
-          {allowSearch && (
-            <SearchInput
-              value={searchText}
-              onChange={(e) => setSearchText(e.target.value)}
-              onClear={() => setSearchText('')}
-              size={size}
-              placeholder={staticLabels?.SEARCH_PLACEHOLDER ?? 'Search...'}
-            />
-          )}
-          <RenderOption {...props} searchText={searchText} />
-          {hasFooter && (
-            <div className={classify(css.menuFooter, classNames?.footer)}>
-              {footer}
-            </div>
-          )}
-        </div>
-      );
-    },
-  );

package/lib/components/Menu/MenuOptionButton.d.ts

@@ -1,199 +0,0 @@
-import * as React from 'react';
-import {classify} from '../../utils/classify';
-import {UnstyledButton} from '../Button';
-import {Checkbox} from '../Checkbox';
-import {Icon} from '../Icon';
-import {RadioButton} from '../RadioButton';
-import {Truncate} from '../Truncate';
-import {TruncatedTextWithTooltip} from '../TruncatedTextWithTooltip';
-import type {BaseMenuProps, MenuOption} from './Menu';
-import css from './Menu.module.css';
-export type MenuOptionProps = BaseMenuProps & {
-  option: MenuOption;
-  isLastItem?: boolean;
-  style?: unknown;
-};
-export const MenuOptionButton = (props: MenuOptionProps): React.ReactNode => {
-  const lastMenuItemRef: {
-    current: HTMLButtonElement | null;
-  } = React.useRef(null);
-  const {
-    option,
-    size = 'medium',
-    onSelect,
-    selectedOption,
-    menuDisabled,
-    classNames,
-    optionsVariant = 'normal',
-    selectedKeys,
-    isLastItem,
-    onTabOut,
-    resolveLabel,
-    resolveSecondaryLabel,
-    style,
-    showLabelTooltip,
-    allowWrap = false,
-  } = props;
-  const {
-    key,
-    label,
-    secondaryLabel,
-    customComponent,
-    iconLeft,
-    iconLeftType,
-    classNames: optionClassNames,
-    iconRight,
-    iconRightType,
-    disabled,
-    optionSize,
-    optionVariant = optionsVariant,
-    indeterminate = false,
-  } = option;
-  const [buttonSize, setButtonSize] = React.useState(optionSize || size);
-  const resolvedLabel = resolveLabel ? resolveLabel(option) : label;
-  const resolvedSecondaryLabel = resolveSecondaryLabel
-    ? resolveSecondaryLabel(option)
-    : secondaryLabel;
-
-  const isSelected = () => {
-    if (!selectedKeys || !Array.isArray(selectedKeys) || !selectedKeys.length) {
-      return false;
-    }
-
-    return selectedKeys.includes(option.key);
-  };
-
-  React.useEffect(() => {
-    setButtonSize(optionSize || size);
-  }, [optionSize, size]);
-  React.useEffect(() => {
-    const handleKeyDown = (event: KeyboardEvent) => {
-      if (event.key === 'Tab' && !event.shiftKey) {
-        // Tab pressed without shift key, calling tab out callback
-        onTabOut?.();
-      }
-    };
-
-    lastMenuItemRef.current?.addEventListener('keydown', handleKeyDown);
-    return () => {
-      lastMenuItemRef.current?.removeEventListener('keydown', handleKeyDown);
-    };
-  }, [isLastItem]);
-  return (
-    <UnstyledButton
-      className={classify(
-        css.option,
-        {
-          [css.selected]: isSelected() || key === selectedOption?.key,
-          [css.optionSmall]: buttonSize === 'small',
-          [css.optionMedium]: buttonSize === 'medium',
-          [css.disabled]: menuDisabled || disabled,
-          [css.withIconLeft]: !!iconLeft,
-          [css.withIconRight]: !!iconRight,
-        },
-        classNames?.option,
-        optionClassNames?.wrapper,
-      )}
-      style={style}
-      disabled={menuDisabled || disabled}
-      onClick={(e) => onSelect && onSelect(option, e)}
-      autoFocus={selectedOption?.key === key}
-      {...(isLastItem
-        ? {
-            ref: lastMenuItemRef,
-          }
-        : {})}
-    >
-      {optionVariant === 'checkbox' && (
-        <Checkbox
-          tabIndex={-1}
-          disabled={menuDisabled || disabled}
-          checked={isSelected()}
-          indeterminate={indeterminate}
-        />
-      )}
-      {optionVariant === 'radio' && (
-        <RadioButton
-          disabled={menuDisabled || disabled}
-          value={option.key}
-          selectedValue={selectedKeys?.[0]}
-          tabIndex={-1}
-        />
-      )}
-      {!!iconLeft && (
-        <Icon
-          name={iconLeft}
-          type={iconLeftType}
-          size="small"
-          className={css.icon}
-        />
-      )}
-      <div
-        className={classify(
-          css.optionTextContainer,
-          classNames?.optionTextContainer,
-        )}
-      >
-        {React.isValidElement(customComponent) ? (
-          customComponent
-        ) : (
-          <div
-            className={classify(
-              css.optionTextLabel,
-              classNames?.optionTextLabel,
-            )}
-          >
-            {renderLabel(resolvedLabel, allowWrap, showLabelTooltip)}
-          </div>
-        )}
-
-        {!!secondaryLabel && (
-          <div className={css.optionTextSecondaryLabel}>
-            <Truncate>{resolvedSecondaryLabel}</Truncate>
-          </div>
-        )}
-      </div>
-
-      {!!iconRight && (
-        <Icon
-          name={iconRight}
-          type={iconRightType}
-          size="small"
-          className={classify(css.icon, css.rightIcon)}
-        />
-      )}
-    </UnstyledButton>
-  );
-};
-
-const renderLabel = (label, allowWrap, showLabelTooltip) => {
-  if (showLabelTooltip) {
-    return (
-      <TruncatedTextWithTooltip
-        tooltip={{
-          bodyMaxLines: showLabelTooltip.maxLines ?? 10,
-          delayMotionDuration: 'normal',
-        }}
-        line={3}
-      >
-        {label}
-      </TruncatedTextWithTooltip>
-    );
-  }
-
-  if (allowWrap) {
-    return (
-      <TruncatedTextWithTooltip
-        tooltip={{
-          bodyMaxLines: 10,
-          delayMotionDuration: 'normal',
-        }}
-        line={3}
-      >
-        {label}
-      </TruncatedTextWithTooltip>
-    );
-  }
-
-  return <Truncate>{label}</Truncate>;
-};

package/lib/components/Menu/index.d.ts

@@ -1,2 +0,0 @@
-export * from './Menu';
-export * from './MenuOptionButton';