1
0
mirror of https://github.com/bitwarden/browser synced 2026-02-26 09:33:22 +00:00

refactor at-risk notification components

This commit is contained in:
Jonathan Prusik
2025-05-16 17:57:56 -04:00
parent 6d1183a482
commit 95ba8fda07
10 changed files with 107 additions and 119 deletions

View File

@@ -2,7 +2,6 @@ import { Meta, StoryObj } from "@storybook/web-components";
import { ThemeTypes } from "@bitwarden/common/platform/enums";
import { NotificationTypes } from "../../../../../notification/abstractions/notification-bar";
import {
AtRiskNotification,
AtRiskNotificationProps,
@@ -10,19 +9,15 @@ import {
import { mockI18n, mockBrowserI18nGetMessage } from "../../mock-data";
export default {
title: "Components/Notifications/AtRiskNotification",
title: "Components/Notifications/At-Risk Notification",
argTypes: {
error: { control: "text" },
theme: { control: "select", options: [...Object.values(ThemeTypes)] },
type: { control: "select", options: [NotificationTypes.AtRiskPassword] },
},
args: {
error: "",
type: NotificationTypes.AtRiskPassword,
theme: ThemeTypes.Light,
handleCloseNotification: () => alert("Close notification action triggered"),
params: {
passwordChangeUri: "https://webtests.dev", // Remove to see "navigate" version of notification
passwordChangeUri: "webtests.dev", // Remove to see "navigate" version of notification
organizationName: "Acme Co.",
},
i18n: mockI18n,

View File

@@ -1,40 +1,49 @@
import createEmotion from "@emotion/css/create-instance";
import { html, nothing } from "lit";
import { Theme } from "@bitwarden/common/platform/enums";
import { spacing, themes } from "../../constants/styles";
import { Warning } from "../../illustrations";
import { iconContainerStyles, notificationConfirmationBodyStyles } from "../confirmation/body";
import { AtRiskNotificationMessage } from "./message";
export const componentClassPrefix = "notification-confirmation-body";
export const componentClassPrefix = "at-risk-notification-body";
const { css } = createEmotion({
key: componentClassPrefix,
});
export type AtRiskNotificationBodyProps = {
confirmationMessage: string;
messageDetails?: string;
riskMessage: string;
theme: Theme;
handleOpenVault: (e: Event) => void;
};
export function AtRiskNotificationBody({
confirmationMessage,
messageDetails,
theme,
handleOpenVault,
}: AtRiskNotificationBodyProps) {
const showConfirmationMessage = confirmationMessage || messageDetails;
export function AtRiskNotificationBody({ riskMessage, theme }: AtRiskNotificationBodyProps) {
return html`
<div class=${notificationConfirmationBodyStyles({ theme })}>
<div class=${iconContainerStyles(true)}>${Warning()}</div>
${showConfirmationMessage
<div class=${atRiskNotificationBodyStyles({ theme })}>
<div class=${iconContainerStyles}>${Warning()}</div>
${riskMessage
? AtRiskNotificationMessage({
message: confirmationMessage,
messageDetails,
message: riskMessage,
theme,
handleClick: handleOpenVault,
})
: nothing}
</div>
`;
}
const iconContainerStyles = css`
> svg {
width: 50px;
height: auto;
}
`;
const atRiskNotificationBodyStyles = ({ theme }: { theme: Theme }) => css`
gap: ${spacing[4]};
display: flex;
align-items: center;
justify-content: flex-start;
background-color: ${themes[theme].background.alt};
padding: 12px;
`;

View File

@@ -1,16 +1,15 @@
import { css } from "@emotion/css";
import { html, nothing } from "lit";
import { ThemeTypes } from "@bitwarden/common/platform/enums";
import { Theme, ThemeTypes } from "@bitwarden/common/platform/enums";
import {
AtRiskPasswordNotificationParams,
NotificationBarIframeInitData,
NotificationType,
NotificationTypes,
} from "../../../../notification/abstractions/notification-bar";
import { NotificationBarIframeInitData } from "../../../../notification/abstractions/notification-bar";
import { I18n } from "../../common-types";
import { notificationContainerStyles } from "../confirmation/container";
import { NotificationHeader } from "../header";
import { themes, spacing } from "../../constants/styles";
import {
NotificationHeader,
componentClassPrefix as notificationHeaderClassPrefix,
} from "../header";
import { AtRiskNotificationBody } from "./body";
import { AtRiskNotificationFooter } from "./footer";
@@ -18,37 +17,32 @@ import { AtRiskNotificationFooter } from "./footer";
export type AtRiskNotificationProps = NotificationBarIframeInitData & {
handleCloseNotification: (e: Event) => void;
} & {
error?: string;
i18n: I18n;
type: NotificationType;
params: AtRiskPasswordNotificationParams;
};
export function AtRiskNotification({
handleCloseNotification,
i18n,
theme = ThemeTypes.Light,
type,
params,
}: AtRiskNotificationProps) {
const headerMessage = getHeaderMessage(i18n, type);
const { passwordChangeUri, organizationName } = params;
const riskMessage = chrome.i18n.getMessage(
passwordChangeUri ? "atRiskChangePrompt" : "atRiskNavigatePrompt",
organizationName,
);
return html`
<div class=${notificationContainerStyles(theme)}>
<div class=${atRiskNotificationContainerStyles(theme)}>
${NotificationHeader({
handleCloseNotification,
i18n,
message: headerMessage,
message: i18n.atRiskPassword,
theme,
})}
${AtRiskNotificationBody({
theme,
handleOpenVault: () => {},
confirmationMessage: chrome.i18n.getMessage(
passwordChangeUri ? "atRiskChangePrompt" : "atRiskNavigatePrompt",
organizationName,
),
riskMessage,
})}
${passwordChangeUri
? AtRiskNotificationFooter({
@@ -61,6 +55,18 @@ export function AtRiskNotification({
`;
}
function getHeaderMessage(i18n: I18n, type?: NotificationType) {
return type === NotificationTypes.AtRiskPassword ? i18n.atRiskPassword : undefined;
}
const atRiskNotificationContainerStyles = (theme: Theme) => css`
position: absolute;
right: 20px;
border: 1px solid ${themes[theme].secondary["300"]};
border-radius: ${spacing["4"]};
box-shadow: -2px 4px 6px 0px #0000001a;
background-color: ${themes[theme].background.alt};
width: 400px;
overflow: hidden;
[class*="${notificationHeaderClassPrefix}-"] {
border-radius: ${spacing["4"]} ${spacing["4"]} 0 0;
border-bottom: 0.5px solid ${themes[theme].secondary["300"]};
}
`;

View File

@@ -1,3 +1,4 @@
import { css } from "@emotion/css";
import { html } from "lit";
import { Theme } from "@bitwarden/common/platform/enums";
@@ -5,8 +6,7 @@ import { Theme } from "@bitwarden/common/platform/enums";
import { ActionButton } from "../../buttons/action-button";
import { AdditionalTasksButtonContent } from "../../buttons/additional-tasks/button-content";
import { I18n } from "../../common-types";
// Utilizes default notification styles, not confirmation.
import { notificationFooterStyles } from "../footer";
import { spacing } from "../../constants/styles";
export type AtRiskNotificationFooterProps = {
i18n: I18n;
@@ -19,7 +19,7 @@ export function AtRiskNotificationFooter({
theme,
passwordChangeUri,
}: AtRiskNotificationFooterProps) {
return html`<div class=${notificationFooterStyles({ isChangeNotification: false })}>
return html`<div class=${atRiskNotificationFooterStyles}>
${passwordChangeUri &&
ActionButton({
handleClick: () => {
@@ -31,3 +31,12 @@ export function AtRiskNotificationFooter({
})}
</div>`;
}
const atRiskNotificationFooterStyles = css`
display: flex;
padding: ${spacing[2]} ${spacing[4]} ${spacing[4]} ${spacing[4]};
:last-child {
border-radius: 0 0 ${spacing["4"]} ${spacing["4"]};
}
`;

View File

@@ -1,68 +1,44 @@
import { css } from "@emotion/css";
import { html, nothing } from "lit";
import { Theme } from "@bitwarden/common/platform/enums";
import {
AdditionalMessageStyles,
notificationConfirmationButtonTextStyles,
notificationConfirmationMessageStyles,
} from "../confirmation/message";
import { themes } from "../../constants/styles";
export type AtRiskNotificationMessageProps = {
buttonAria?: string;
buttonText?: string;
itemName?: string;
message?: string;
messageDetails?: string;
handleClick: (e: Event) => void;
theme: Theme;
};
export function AtRiskNotificationMessage({
buttonAria,
buttonText,
message,
messageDetails,
handleClick,
theme,
}: AtRiskNotificationMessageProps) {
export function AtRiskNotificationMessage({ message, theme }: AtRiskNotificationMessageProps) {
return html`
<div>
${message || buttonText
${message
? html`
<span
title=${message || buttonText}
class=${notificationConfirmationMessageStyles(theme)}
>
${message || nothing}
${buttonText
? html`
<a
title=${buttonText}
class=${notificationConfirmationButtonTextStyles(theme)}
@click=${handleClick}
@keydown=${(e: KeyboardEvent) => handleButtonKeyDown(e, () => handleClick(e))}
aria-label=${buttonAria}
tabindex="0"
role="button"
>
${buttonText}
</a>
`
: nothing}
<span title=${message} class=${atRiskNotificationMessageStyles(theme)}>
${message}
</span>
`
: nothing}
${messageDetails
? html`<div class=${AdditionalMessageStyles({ theme })}>${messageDetails}</div>`
: nothing}
</div>
`;
}
function handleButtonKeyDown(event: KeyboardEvent, handleClick: () => void) {
if (event.key === "Enter" || event.key === " ") {
event.preventDefault();
handleClick();
}
}
const baseTextStyles = css`
overflow-x: hidden;
text-align: left;
text-overflow: ellipsis;
line-height: 24px;
font-family: Roboto, sans-serif;
font-size: 16px;
`;
const atRiskNotificationMessageStyles = (theme: Theme) => css`
${baseTextStyles}
color: ${themes[theme].text.main};
font-weight: 400;
white-space: normal;
word-break: break-word;
display: inline;
`;

View File

@@ -59,13 +59,13 @@ export function NotificationConfirmationBody({
`;
}
export const iconContainerStyles = (error?: string | boolean) => css`
const iconContainerStyles = (error?: string) => css`
> svg {
width: ${!error ? "50px" : "40px"};
height: auto;
}
`;
export const notificationConfirmationBodyStyles = ({ theme }: { theme: Theme }) => css`
const notificationConfirmationBodyStyles = ({ theme }: { theme: Theme }) => css`
gap: ${spacing[4]};
display: flex;
align-items: center;

View File

@@ -96,7 +96,7 @@ export function NotificationConfirmationContainer({
`;
}
export const notificationContainerStyles = (theme: Theme) => css`
const notificationContainerStyles = (theme: Theme) => css`
position: absolute;
right: 20px;
border: 1px solid ${themes[theme].secondary["300"]};

View File

@@ -22,7 +22,7 @@ export function NotificationConfirmationFooter({
const primaryButtonText = i18n.nextSecurityTaskAction;
return html`
<div class=${[maxWidthMinContent, notificationConfirmationFooterStyles({ theme })]}>
<div class=${notificationConfirmationFooterStyles({ theme })}>
${ActionButton({
handleClick: handleButtonClick,
buttonText: AdditionalTasksButtonContent({ buttonText: primaryButtonText, theme }),
@@ -32,13 +32,10 @@ export function NotificationConfirmationFooter({
`;
}
const maxWidthMinContent = css`
max-width: min-content;
`;
const notificationConfirmationFooterStyles = ({ theme }: { theme: Theme }) => css`
background-color: ${themes[theme].background.alt};
padding: 0 ${spacing[3]} ${spacing[3]} ${spacing[3]};
max-width: min-content;
:last-child {
border-radius: 0 0 ${spacing["4"]} ${spacing["4"]};

View File

@@ -88,7 +88,7 @@ const baseTextStyles = css`
font-size: 16px;
`;
export const notificationConfirmationMessageStyles = (theme: Theme) => css`
const notificationConfirmationMessageStyles = (theme: Theme) => css`
${baseTextStyles}
color: ${themes[theme].text.main};
@@ -111,7 +111,7 @@ const itemNameStyles = (theme: Theme) => css`
vertical-align: bottom;
`;
export const notificationConfirmationButtonTextStyles = (theme: Theme) => css`
const notificationConfirmationButtonTextStyles = (theme: Theme) => css`
${baseTextStyles}
color: ${themes[theme].primary[600]};
@@ -119,7 +119,7 @@ export const notificationConfirmationButtonTextStyles = (theme: Theme) => css`
cursor: pointer;
`;
export const AdditionalMessageStyles = ({ theme }: { theme: Theme }) => css`
const AdditionalMessageStyles = ({ theme }: { theme: Theme }) => css`
${typography.body2}
font-size: 14px;

View File

@@ -21,7 +21,6 @@ export type NotificationFooterProps = {
personalVaultIsAllowed: boolean;
theme: Theme;
handleSaveAction: (e: Event) => void;
passwordChangeUri?: string;
};
export function NotificationFooter({
@@ -44,7 +43,7 @@ export function NotificationFooter({
}
return html`
<div class=${[displayFlex, notificationFooterStyles({ isChangeNotification })]}>
<div class=${notificationFooterStyles({ isChangeNotification })}>
${!isChangeNotification
? NotificationButtonRow({
collections,
@@ -63,15 +62,12 @@ export function NotificationFooter({
`;
}
export const displayFlex = css`
display: flex;
`;
export const notificationFooterStyles = ({
const notificationFooterStyles = ({
isChangeNotification,
}: {
isChangeNotification: boolean;
}) => css`
display: flex;
padding: ${spacing[2]} ${spacing[4]} ${isChangeNotification ? spacing[1] : spacing[4]}
${spacing[4]};