@lumx/react 3.21.1 → 3.21.2-alpha.0

package/src/components/progress/ProgressLinear.tsx

@@ -1,52 +0,0 @@
-import React from 'react';
-
-import classNames from 'classnames';
-
-import { Theme } from '@lumx/react';
-import { GenericProps, HasTheme } from '@lumx/react/utils/type';
-import { getRootClassName, handleBasicClasses } from '@lumx/core/js/utils/className';
-import { useTheme } from '@lumx/react/utils/theme/ThemeContext';
-import { forwardRef } from '@lumx/react/utils/react/forwardRef';
-
-export interface ProgressLinearProps extends GenericProps, HasTheme {}
-
-/**
- * Component display name.
- */
-const COMPONENT_NAME = 'ProgressLinear';
-
-/**
- * Component default class name and class prefix.
- */
-const CLASSNAME = getRootClassName(COMPONENT_NAME);
-
-/**
- * Component default props.
- */
-const DEFAULT_PROPS: Partial<ProgressLinearProps> = {};
-
-/**
- * ProgressLinear component.
- *
- * @param  props Component props.
- * @param  ref   Component ref.
- * @return React element.
- */
-export const ProgressLinear = forwardRef<ProgressLinearProps, HTMLDivElement>((props, ref) => {
-    const defaultTheme = useTheme() || Theme.light;
-    const { className, theme = defaultTheme, ...forwardedProps } = props;
-
-    return (
-        <div
-            ref={ref}
-            {...forwardedProps}
-            className={classNames(className, handleBasicClasses({ prefix: CLASSNAME, theme }))}
-        >
-            <div className="lumx-progress-linear__line1" />
-            <div className="lumx-progress-linear__line2" />
-        </div>
-    );
-});
-ProgressLinear.displayName = COMPONENT_NAME;
-ProgressLinear.className = CLASSNAME;
-ProgressLinear.defaultProps = DEFAULT_PROPS;

package/src/components/progress/index.ts

@@ -1,3 +0,0 @@
-export * from './Progress';
-export * from './ProgressCircular';
-export * from './ProgressLinear';

package/src/components/progress-tracker/ProgressTracker.stories.tsx

@@ -1,145 +0,0 @@
-import {
-    Button,
-    ColorPalette,
-    FlexBox,
-    Orientation,
-    ProgressTracker,
-    ProgressTrackerProvider,
-    ProgressTrackerStep,
-    ProgressTrackerStepPanel,
-} from '@lumx/react';
-import cloneDeep from 'lodash/cloneDeep';
-import set from 'lodash/set';
-import React, { useState } from 'react';
-
-export default { title: 'LumX components/progress-tracker/Progress Tracker' };
-
-export const Controlled = () => {
-    const [activeStep, setActiveStep] = useState(1);
-
-    const [steps, setSteps] = useState([
-        {
-            label: 'First',
-            isDisabled: false,
-            isComplete: true,
-            hasError: false,
-        },
-        {
-            label: 'Second',
-            isDisabled: false,
-            isComplete: false,
-            hasError: false,
-        },
-        {
-            label: 'Third',
-            isDisabled: true,
-            isComplete: false,
-            hasError: false,
-        },
-        {
-            label: 'Fourth',
-            isDisabled: true,
-            isComplete: false,
-            hasError: false,
-        },
-        {
-            label: 'Fifth',
-            helper: 'Almost done',
-            isDisabled: true,
-            isComplete: false,
-            hasError: false,
-        },
-    ]);
-
-    const toggleError = (index: number) => () => {
-        const clonedSteps = cloneDeep(steps);
-        set(clonedSteps, [index, 'hasError'], !steps[index].hasError);
-        set(clonedSteps, [index, 'isComplete'], false);
-        setSteps(clonedSteps);
-    };
-
-    const previous = (index: number) => () => setActiveStep(index - 1);
-
-    const next = (index: number) => () => {
-        const isLast = index === steps.length - 1;
-        const clonedSteps = cloneDeep(steps);
-        set(clonedSteps, [index, 'isComplete'], true);
-        set(clonedSteps, [index, 'hasError'], false);
-        if (!isLast) {
-            set(clonedSteps, [index + 1, 'isDisabled'], false);
-            setActiveStep(index + 1);
-        }
-        setSteps(clonedSteps);
-    };
-
-    return (
-        <ProgressTrackerProvider activeStepIndex={activeStep} onChange={setActiveStep}>
-            <ProgressTracker aria-label="Steps with a linear progression">
-                {steps.map((step) => (
-                    <ProgressTrackerStep key={step.label} {...step} />
-                ))}
-            </ProgressTracker>
-            {steps.map((step, index) => (
-                <ProgressTrackerStepPanel key={`${step.label}-panel`}>
-                    <FlexBox orientation={Orientation.horizontal}>
-                        <FlexBox fillSpace />
-                        <FlexBox
-                            orientation={Orientation.vertical}
-                            style={{ width: '700px' }}
-                            className="lumx-spacing-margin-top-huge"
-                        >
-                            <p style={{ textAlign: 'justify' }}>
-                                Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam semper aliquet purus, a
-                                viverra odio pharetra vitae. Morbi condimentum et dui luctus tristique. Etiam turpis
-                                turpis, tristique eu lobortis vel, vulputate at mi. Ut commodo metus non fringilla
-                                semper. Aenean eu dignissim ante. Cras libero ligula, luctus quis mauris eget,
-                                vestibulum mattis ante. Donec elementum mi nisl, quis dictum lorem scelerisque sit amet.
-                                Nullam blandit tellus et tortor ornare efficitur. Vivamus blandit mauris in elementum
-                                lobortis. Nam molestie aliquet vehicula. Maecenas lacinia sodales nunc. Nam orci nisl,
-                                pellentesque sed hendrerit eget, tincidunt id lacus. Donec malesuada ex elit, eget
-                                sagittis nisl aliquam vitae. Aliquam efficitur tellus non enim efficitur suscipit a sit
-                                amet eros. Donec non lorem ullamcorper, varius ligula vitae, efficitur risus. Cras
-                                porttitor libero justo, nec porta enim eleifend vel.
-                            </p>
-                            <FlexBox orientation={Orientation.horizontal} className="lumx-spacing-margin-top-huge">
-                                <FlexBox fillSpace>
-                                    {index === 0 ? undefined : (
-                                        <Button onClick={previous(index)} color={ColorPalette.secondary}>
-                                            Previous
-                                        </Button>
-                                    )}
-                                </FlexBox>
-                                <Button
-                                    onClick={toggleError(index)}
-                                    color={ColorPalette.red}
-                                    className="lumx-spacing-margin-right-regular"
-                                >
-                                    Toggle error
-                                </Button>
-                                <Button
-                                    onClick={next(index)}
-                                    color={ColorPalette.primary}
-                                    isDisabled={index === steps.length - 1 && step.isComplete}
-                                >
-                                    {index === steps.length - 1 ? 'Complete' : 'Next with success'}
-                                </Button>
-                            </FlexBox>
-                        </FlexBox>
-                        <FlexBox fillSpace />
-                    </FlexBox>
-                </ProgressTrackerStepPanel>
-            ))}
-        </ProgressTrackerProvider>
-    );
-};
-
-export const NotControlled = () => (
-    <ProgressTrackerProvider onChange={console.log}>
-        <ProgressTracker aria-label="Steps with a linear progression">
-            <ProgressTrackerStep label="Step 1" />
-            <ProgressTrackerStep label="Step 2" />
-        </ProgressTracker>
-        <ProgressTrackerStepPanel className="lumx-spacing-padding">Step 1 panel</ProgressTrackerStepPanel>
-        <ProgressTrackerStepPanel className="lumx-spacing-padding">Step 2 panel</ProgressTrackerStepPanel>
-    </ProgressTrackerProvider>
-);

package/src/components/progress-tracker/ProgressTracker.test.tsx

@@ -1,44 +0,0 @@
-import React from 'react';
-
-import { ProgressTrackerStep } from '@lumx/react';
-import { render, within } from '@testing-library/react';
-import { getByClassName } from '@lumx/react/testing/utils/queries';
-import { commonTestsSuiteRTL } from '@lumx/react/testing/utils';
-
-import { ProgressTracker, ProgressTrackerProps } from './ProgressTracker';
-
-const CLASSNAME = ProgressTracker.className as string;
-
-type SetupProps = Partial<ProgressTrackerProps>;
-
-/**
- * Mounts the component and returns common DOM elements / data needed in multiple tests further down.
- */
-const setup = (propsOverride: SetupProps = {}) => {
-    const steps = [<ProgressTrackerStep key={0} label="Step 0" />, <ProgressTrackerStep key={1} label="Step 1" />];
-    const props = {
-        children: steps,
-        'aria-label': 'Steps',
-        ...propsOverride,
-    };
-    render(<ProgressTracker {...props} />);
-    const progressTracker = getByClassName(document.body, CLASSNAME);
-
-    return { props, progressTracker };
-};
-
-describe(`<${ProgressTracker.displayName}>`, () => {
-    it('should render default', () => {
-        const label = 'Steps';
-        const { progressTracker } = setup({ 'aria-label': label });
-        expect(within(progressTracker).queryByRole('tablist', { name: label })).toBeInTheDocument();
-    });
-
-    // Common tests suite.
-    commonTestsSuiteRTL(setup, {
-        baseClassName: CLASSNAME,
-        forwardClassName: 'progressTracker',
-        forwardAttributes: 'progressTracker',
-        forwardRef: 'progressTracker',
-    });
-});

package/src/components/progress-tracker/ProgressTracker.tsx

@@ -1,87 +0,0 @@
-import React, { ReactNode } from 'react';
-
-import classNames from 'classnames';
-
-import { GenericProps } from '@lumx/react/utils/type';
-import { getRootClassName } from '@lumx/core/js/utils/className';
-import { mergeRefs } from '@lumx/react/utils/react/mergeRefs';
-import { forwardRef } from '@lumx/react/utils/react/forwardRef';
-
-import { useRovingTabIndex } from '../../hooks/useRovingTabIndex';
-import { useTabProviderContextState } from '../tabs/state';
-
-/**
- * Defines the props of the component.
- */
-export interface ProgressTrackerProps extends GenericProps {
-    /** ARIA label (purpose of the set of steps). */
-    ['aria-label']: string;
-    /** Step list. */
-    children: ReactNode;
-}
-
-/**
- * Component display name.
- */
-const COMPONENT_NAME = 'ProgressTracker';
-
-/**
- * Component default class name and class prefix.
- */
-const CLASSNAME = getRootClassName(COMPONENT_NAME);
-
-/**
- * Component default props.
- */
-const DEFAULT_PROPS: Partial<ProgressTrackerProps> = {};
-
-/**
- * ProgressTracker component.
- *
- * Implements WAI-ARIA `tablist` role {@see https://www.w3.org/TR/wai-aria-practices-1.1/examples/tabs/tabs-1/tabs.html#rps_label}
- *
- * @param  props Component props.
- * @param  ref   Component ref.
- * @return React element.
- */
-export const ProgressTracker = forwardRef<ProgressTrackerProps, HTMLDivElement>((props, ref) => {
-    const { 'aria-label': ariaLabel, children, className, ...forwardedProps } = props;
-    const stepListRef = React.useRef(null);
-    useRovingTabIndex({
-        parentRef: stepListRef,
-        elementSelector: '[role="tab"]',
-        keepTabIndex: false,
-        extraDependencies: [children],
-    });
-
-    const state = useTabProviderContextState();
-    const numberOfSteps = state?.ids?.tab?.length || 0;
-    const backgroundPosition: number = numberOfSteps > 0 ? 100 / (numberOfSteps * 2) : 0;
-    const trackPosition: number =
-        numberOfSteps > 0 ? ((100 / (numberOfSteps - 1)) * (state?.activeTabIndex || 0)) / 100 : 0;
-
-    return (
-        <div ref={mergeRefs(ref, stepListRef)} {...forwardedProps} className={classNames(className, CLASSNAME)}>
-            <div className={`${CLASSNAME}__steps`} role="tablist" aria-label={ariaLabel}>
-                {children}
-            </div>
-
-            <div
-                className={`${CLASSNAME}__background-bar`}
-                style={{ left: `${backgroundPosition}%`, right: `${backgroundPosition}%` }}
-            />
-
-            <div
-                className={`${CLASSNAME}__foreground-bar`}
-                style={{
-                    left: `${backgroundPosition}%`,
-                    right: `${backgroundPosition}%`,
-                    transform: `scaleX(${trackPosition})`,
-                }}
-            />
-        </div>
-    );
-});
-ProgressTracker.displayName = COMPONENT_NAME;
-ProgressTracker.className = CLASSNAME;
-ProgressTracker.defaultProps = DEFAULT_PROPS;

package/src/components/progress-tracker/ProgressTrackerProvider.test.tsx

@@ -1,67 +0,0 @@
-import React from 'react';
-
-import {
-    ProgressTracker,
-    ProgressTrackerProvider,
-    ProgressTrackerProviderProps,
-    ProgressTrackerStep,
-    ProgressTrackerStepPanel,
-} from '@lumx/react';
-
-import { render } from '@testing-library/react';
-import { checkTabActive, query } from '../tabs/test-utils';
-
-const setup = (props: Partial<ProgressTrackerProviderProps> = {}) =>
-    render(
-        <ProgressTrackerProvider {...props}>
-            <ProgressTracker aria-label="Progress tracker steps">
-                <ProgressTrackerStep label="Step 1" />
-                <ProgressTrackerStep label="Step 2" />
-            </ProgressTracker>
-
-            <ProgressTrackerStepPanel>Progress tracker step 1 content</ProgressTrackerStepPanel>
-            <ProgressTrackerStepPanel>Progress tracker step 2 content</ProgressTrackerStepPanel>
-        </ProgressTrackerProvider>,
-    );
-
-describe(`<${ProgressTrackerProvider.displayName}>`, () => {
-    describe('default config', () => {
-        it('should render aria tab pattern', () => {
-            setup();
-
-            // Step list
-            const tabList = query.tabList('Progress tracker steps');
-            expect(tabList).toBeInTheDocument();
-            expect(query.tabs(tabList).length).toBe(2);
-
-            // Step 1
-            const tab1 = query.tab('Step 1', tabList);
-            expect(tab1).toBeInTheDocument();
-
-            // Step 2
-            const tab2 = query.tab('Step 2', tabList);
-            expect(tab2).toBeInTheDocument();
-
-            // Step panel 1
-            const tabPanel1 = query.tabPanel('Step 1');
-            expect(tabPanel1).toBeInTheDocument();
-            expect(tab1).toHaveAttribute('aria-controls', tabPanel1?.id);
-
-            // Step panel 2
-            const tabPanel2 = query.tabPanel('Step 2');
-            expect(tabPanel2).toBeInTheDocument();
-            expect(tab2).toHaveAttribute('aria-controls', tabPanel2?.id);
-
-            // First step is active
-            checkTabActive('Step 1');
-        });
-    });
-
-    describe('not lazy', () => {
-        it('should render panel content', () => {
-            setup({ isLazy: false });
-
-            checkTabActive('Step 1', { isLazy: false });
-        });
-    });
-});

package/src/components/progress-tracker/ProgressTrackerProvider.tsx

@@ -1,67 +0,0 @@
-import React, { ReactNode, useEffect, useReducer } from 'react';
-import { INIT_STATE, TabProviderContext, reducer } from '../tabs/state';
-
-export interface ProgressTrackerProviderProps {
-    /** Active step index. */
-    activeStepIndex?: number;
-    /** ProgressTrackerProvider children. */
-    children: ReactNode;
-    /** Step panel children should not render if the step panel is hidden. */
-    isLazy?: boolean;
-    /** Activate tabs on focus. */
-    shouldActivateOnFocus?: boolean;
-    /** Step change callback. */
-    onChange?(index: number): void;
-}
-
-const DEFAULT_PROPS: Partial<ProgressTrackerProviderProps> = {
-    isLazy: INIT_STATE.isLazy,
-    shouldActivateOnFocus: INIT_STATE.shouldActivateOnFocus,
-};
-
-/**
- * This component provides a context in which steps can be defined and linked to their step panel.
- *
- * It does not produce any markup so you can wrap it around any React elements and then split the ProgressTracker and ProgressTrackerPanel
- * components in the react tree.
- *
- * This works exactly as TabProvider so it uses TabProviderContext and tabs state.
- *
- * @param  props React component props.
- * @return React element.
- */
-export const ProgressTrackerProvider: React.FC<ProgressTrackerProviderProps> = (props) => {
-    const { children, onChange, ...propState } = props;
-    const [state, dispatch] = useReducer(reducer, INIT_STATE);
-
-    // On prop state change => dispatch update.
-    useEffect(
-        () => {
-            dispatch({
-                type: 'update',
-                payload: {
-                    ...DEFAULT_PROPS,
-                    ...propState,
-                    activeTabIndex: propState.activeStepIndex || INIT_STATE.activeTabIndex,
-                },
-            });
-        },
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-        [dispatch, ...Object.values(propState)],
-    );
-
-    // On active tab index state change => send update to the onChange.
-    useEffect(
-        () => {
-            if (state === INIT_STATE || !onChange || propState.activeStepIndex === state.activeTabIndex) {
-                return;
-            }
-            onChange(state.activeTabIndex);
-        },
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-        [onChange, state.activeTabIndex],
-    );
-
-    return <TabProviderContext.Provider value={[state, dispatch]}>{children}</TabProviderContext.Provider>;
-};
-ProgressTrackerProvider.defaultProps = DEFAULT_PROPS;

package/src/components/progress-tracker/ProgressTrackerStep.test.tsx

@@ -1,38 +0,0 @@
-import React from 'react';
-
-import { render, screen } from '@testing-library/react';
-import { getByClassName } from '@lumx/react/testing/utils/queries';
-import { commonTestsSuiteRTL } from '@lumx/react/testing/utils';
-
-import { ProgressTrackerStep, ProgressTrackerStepProps } from './ProgressTrackerStep';
-
-const CLASSNAME = ProgressTrackerStep.className as string;
-
-type SetupProps = Partial<ProgressTrackerStepProps>;
-
-/**
- * Mounts the component and returns common DOM elements / data needed in multiple tests further down.
- */
-const setup = (propsOverride: SetupProps = {}) => {
-    const props = { label: 'Test Step Label', ...propsOverride };
-    render(<ProgressTrackerStep {...props} />);
-    const progressTrackerStep = getByClassName(document.body, CLASSNAME);
-
-    return { props, progressTrackerStep };
-};
-
-describe(`<${ProgressTrackerStep.displayName}>`, () => {
-    it('should render default', () => {
-        const label = 'Step';
-        const { progressTrackerStep } = setup({ label });
-        expect(progressTrackerStep).toBe(screen.queryByRole('tab', { name: label }));
-    });
-
-    // Common tests suite.
-    commonTestsSuiteRTL(setup, {
-        baseClassName: CLASSNAME,
-        forwardClassName: 'progressTrackerStep',
-        forwardAttributes: 'progressTrackerStep',
-        forwardRef: 'progressTrackerStep',
-    });
-});

package/src/components/progress-tracker/ProgressTrackerStep.tsx

@@ -1,159 +0,0 @@
-import React, { FocusEventHandler, KeyboardEventHandler, useCallback } from 'react';
-
-import classNames from 'classnames';
-
-import { mdiAlertCircle, mdiCheckCircle, mdiRadioboxBlank, mdiRadioboxMarked } from '@lumx/icons';
-import { Icon, InputHelper, InputLabel, Kind, Size } from '@lumx/react';
-import { GenericProps } from '@lumx/react/utils/type';
-import { getRootClassName, handleBasicClasses } from '@lumx/core/js/utils/className';
-import { forwardRef } from '@lumx/react/utils/react/forwardRef';
-
-import { useDisableStateProps } from '@lumx/react/utils/disabled/useDisableStateProps';
-import { useTabProviderContext } from '../tabs/state';
-
-/**
- * Defines the props of the component.
- */
-export interface ProgressTrackerStepProps extends GenericProps {
-    /** Children are not supported. */
-    children?: never;
-    /** Whether the step should be in error state or not. */
-    hasError?: boolean;
-    /** Helper text. */
-    helper?: string | null;
-    /** Native id property. */
-    id?: string;
-    /** Whether the current step is active or not. */
-    isActive?: boolean;
-    /** Whether the current step is completed or not. */
-    isComplete?: boolean;
-    /** Whether the component is disabled or not. */
-    isDisabled?: boolean;
-    /** Label text. */
-    label?: string | null;
-}
-
-/**
- * Component display name.
- */
-const COMPONENT_NAME = 'ProgressTrackerStep';
-
-/**
- * Component default class name and class prefix.
- */
-const CLASSNAME = getRootClassName(COMPONENT_NAME);
-
-/**
- * Component default props.
- */
-const DEFAULT_PROPS: Partial<ProgressTrackerStepProps> = {};
-
-/**
- * ProgressTrackerStep component.
- *
- * Implements WAI-ARIA `tab` role {@see https://www.w3.org/TR/wai-aria-practices-1.1/examples/tabs/tabs-1/tabs.html#rps_label}
- *
- * @param  props Component props.
- * @param  ref   Component ref.
- * @return React element.
- */
-export const ProgressTrackerStep = forwardRef<ProgressTrackerStepProps, HTMLButtonElement>((props, ref) => {
-    const { isAnyDisabled, otherProps } = useDisableStateProps(props);
-    const {
-        className,
-        hasError,
-        helper,
-        id,
-        isActive: propIsActive,
-        isComplete,
-        label,
-        onFocus,
-        onKeyPress,
-        tabIndex = -1,
-        ...forwardedProps
-    } = otherProps;
-    const state = useTabProviderContext('tab', id);
-    const isActive = propIsActive || state?.isActive;
-
-    const changeToCurrentTab = useCallback(() => {
-        if (isAnyDisabled) {
-            return;
-        }
-        state?.changeToTab();
-    }, [isAnyDisabled, state]);
-
-    const handleFocus: FocusEventHandler = useCallback(
-        (event) => {
-            onFocus?.(event);
-            if (state?.shouldActivateOnFocus) {
-                changeToCurrentTab();
-            }
-        },
-        [changeToCurrentTab, onFocus, state?.shouldActivateOnFocus],
-    );
-
-    const handleKeyPress: KeyboardEventHandler = useCallback(
-        (event) => {
-            onKeyPress?.(event);
-            if (event.key !== 'Enter') {
-                return;
-            }
-            changeToCurrentTab();
-        },
-        [changeToCurrentTab, onKeyPress],
-    );
-
-    const getIcon = (): string => {
-        if (isComplete) {
-            return mdiCheckCircle;
-        }
-
-        if (isActive) {
-            return hasError ? mdiAlertCircle : mdiRadioboxMarked;
-        }
-
-        return mdiRadioboxBlank;
-    };
-
-    return (
-        <button
-            ref={ref}
-            {...forwardedProps}
-            type="button"
-            id={state?.tabId}
-            className={classNames(
-                className,
-                handleBasicClasses({
-                    prefix: CLASSNAME,
-                    hasError,
-                    isActive,
-                    isClickable: state && !isAnyDisabled,
-                    isComplete,
-                }),
-            )}
-            onClick={changeToCurrentTab}
-            onKeyPress={handleKeyPress}
-            onFocus={handleFocus}
-            role="tab"
-            tabIndex={isActive ? 0 : tabIndex}
-            aria-disabled={isAnyDisabled}
-            aria-selected={isActive}
-            aria-controls={state?.tabPanelId}
-        >
-            <Icon className={`${CLASSNAME}__state`} icon={getIcon()} size={Size.s} />
-
-            <InputLabel htmlFor={state?.tabId || ''} className={`${CLASSNAME}__label`}>
-                {label}
-            </InputLabel>
-
-            {helper && (
-                <InputHelper kind={hasError ? Kind.error : Kind.info} className={`${CLASSNAME}__helper`}>
-                    {helper}
-                </InputHelper>
-            )}
-        </button>
-    );
-});
-ProgressTrackerStep.displayName = COMPONENT_NAME;
-ProgressTrackerStep.className = CLASSNAME;
-ProgressTrackerStep.defaultProps = DEFAULT_PROPS;