Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/react-core/src/components/Wizard/WizardNavItem.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import styles from '@patternfly/react-styles/css/components/Wizard/wizard';
import AngleRightIcon from '@patternfly/react-icons/dist/esm/icons/angle-right-icon';
import ExclamationCircleIcon from '@patternfly/react-icons/dist/esm/icons/exclamation-circle-icon';
import CheckCircleIcon from '@patternfly/react-icons/dist/esm/icons/check-circle-icon';
import ExclamationTriangleIcon from '@patternfly/react-icons/dist/esm/icons/exclamation-triangle-icon';

import { OUIAProps, useOUIAProps } from '../../helpers';
import { WizardNavItemStatus } from './types';
Expand Down Expand Up @@ -38,7 +39,7 @@ export interface WizardNavItemProps
/** The id for the navigation item */
id?: string | number;
/** Used to determine the icon displayed next to content. Default has no icon. */
status?: 'default' | 'error' | 'success';
status?: 'default' | 'error' | 'success' | 'warning';
}

export const WizardNavItem = ({
Expand Down Expand Up @@ -97,7 +98,8 @@ export const WizardNavItem = ({
isCurrent && styles.modifiers.current,
isDisabled && styles.modifiers.disabled,
status === WizardNavItemStatus.Error && styles.modifiers.danger,
status === WizardNavItemStatus.Success && styles.modifiers.success
status === WizardNavItemStatus.Success && styles.modifiers.success,
status === WizardNavItemStatus.Warning && styles.modifiers.warning
)}
aria-disabled={isDisabled ? true : null}
aria-current={isCurrent && !children ? 'step' : false}
Expand All @@ -110,6 +112,7 @@ export const WizardNavItem = ({
<span className={css(styles.wizardNavLinkStatusIcon)}>
{status === WizardNavItemStatus.Error && <ExclamationCircleIcon />}
{status === WizardNavItemStatus.Success && <CheckCircleIcon />}
{status === WizardNavItemStatus.Warning && <ExclamationTriangleIcon />}
</span>
</>
)}
Expand Down
2 changes: 1 addition & 1 deletion packages/react-core/src/components/Wizard/WizardStep.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface WizardStepProps {
/** Replaces the step's footer. The step's footer takes precedence over the wizard's footer. */
footer?: React.ReactElement<any> | Partial<WizardFooterProps>;
/** Used to determine icon next to the step's navigation item */
status?: 'default' | 'error' | 'success';
status?: 'default' | 'error' | 'success' | 'warning';
/** Flag to determine whether parent steps can expand or not. Defaults to false. */
isExpandable?: boolean;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,9 @@ test(`Renders screen reader text and success icon when status is success`, () =>
expect(screen.getByRole('button')).toHaveClass(styles.modifiers.success);
expect(screen.getByText(', success')).toBeInTheDocument();
});

test(`Renders screen reader text and warning icon when status is warning`, () => {
render(<WizardNavItem status="warning" />);
expect(screen.getByRole('button')).toHaveClass(styles.modifiers.warning);
expect(screen.getByText(', warning')).toBeInTheDocument();
});
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,6 @@ test('updates "status" in context when the value changes', () => {
expect(setStep).toHaveBeenCalledWith({ ...testStepProps, status: 'error', isVisited: true });
render(<WizardStep {...testStep} status="success" />);
expect(setStep).toHaveBeenCalledWith({ ...testStepProps, status: 'success', isVisited: true });
render(<WizardStep {...testStep} status="warning" />);
expect(setStep).toHaveBeenCalledWith({ ...testStepProps, status: 'warning', isVisited: true });
});
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ interface SomeContextProps {
setErrorMessage(error: string | undefined): void;
successMessage: string | undefined;
setSuccessMessage(error: string | undefined): void;
warningMessage: string | undefined;
setWarningMessage(error: string | undefined): void;
}
type SomeContextRenderProps = Pick<SomeContextProps, 'successMessage', 'errorMessage'>;
type SomeContextRenderProps = Pick<SomeContextProps, 'successMessage', 'errorMessage', 'warningMessage'>;
interface SomeContextProviderProps {
children: (context: SomeContextRenderProps) => React.ReactElement<any>;
}
Expand All @@ -17,16 +19,20 @@ const SomeContext: React.Context<SomeContextProps> = createContext({} as SomeCon
const SomeContextProvider = ({ children }: SomeContextProviderProps) => {
const [errorMessage, setErrorMessage] = useState<string>();
const [successMessage, setSuccessMessage] = useState<string>();
const [warningMessage, setWarningMessage] = useState<string>();

return (
<SomeContext.Provider value={{ errorMessage, setErrorMessage, successMessage, setSuccessMessage }}>
{children({ errorMessage, successMessage })}
<SomeContext.Provider
value={{ errorMessage, setErrorMessage, successMessage, setSuccessMessage, warningMessage, setWarningMessage }}
>
{children({ errorMessage, successMessage, warningMessage })}
</SomeContext.Provider>
);
};

const StepContentWithAction = () => {
const { errorMessage, setErrorMessage, successMessage, setSuccessMessage } = useContext(SomeContext);
const { errorMessage, setErrorMessage, successMessage, setSuccessMessage, warningMessage, setWarningMessage } =
useContext(SomeContext);

return (
<>
Expand All @@ -35,7 +41,8 @@ const StepContentWithAction = () => {
isChecked={!!errorMessage}
onChange={(_event, checked) => {
setErrorMessage(checked ? 'Some error message' : undefined);
setSuccessMessage(!checked ? 'Some error message' : undefined);
setSuccessMessage(checked ? undefined : successMessage);
setWarningMessage(checked ? undefined : warningMessage);
}}
id="toggle-error-checkbox"
name="Toggle Status"
Expand All @@ -45,23 +52,37 @@ const StepContentWithAction = () => {
isChecked={!!successMessage}
onChange={(_event, checked) => {
setSuccessMessage(checked ? 'Some success message' : undefined);
setErrorMessage(!checked ? 'Some success message' : undefined);
setErrorMessage(checked ? undefined : errorMessage);
setWarningMessage(checked ? undefined : warningMessage);
}}
id="toggle-success-checkbox"
name="Toggle Status"
/>
<Radio
label="Give step 1 a warning status"
isChecked={!!warningMessage}
onChange={(_event, checked) => {
setWarningMessage(checked ? 'Some warning message' : undefined);
setErrorMessage(checked ? undefined : errorMessage);
setSuccessMessage(checked ? undefined : successMessage);
}}
id="toggle-warning-checkbox"
name="Toggle Status"
/>
</>
);
};

export const WizardStepStatus: React.FunctionComponent = () => (
<SomeContextProvider>
{({ errorMessage, successMessage }) => {
{({ errorMessage, successMessage, warningMessage }) => {
let status = 'default';
if (errorMessage) {
status = 'error';
} else if (successMessage) {
status = 'success';
} else if (warningMessage) {
status = 'warning';
}
return (
<Wizard height={400} title="Step status wizard">
Expand Down
5 changes: 3 additions & 2 deletions packages/react-core/src/components/Wizard/types.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ export interface WizardBasicStep {
/** Replaces the step's footer. The step's footer takes precedence over the wizard's footer. */
footer?: React.ReactElement<any> | Partial<WizardFooterProps>;
/** Used to determine icon next to the step's navItem */
status?: 'default' | 'error' | 'success';
status?: 'default' | 'error' | 'success' | 'warning';
}

export enum WizardNavItemStatus {
Default = 'default',
Error = 'error',
Success = 'success'
Success = 'success',
Warning = 'warning'
}

/** Type for customizing a button (next, back or cancel) in a Wizard footer. It omits some props which either have a default value or are passed directly via WizardFooterProps. */
Expand Down
Loading