Skip to content

feat(circuit-ui): InlineNotification promo variant #3649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
matoous wants to merge 1 commit into from
Closed

feat(circuit-ui): InlineNotification promo variant #3649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/true-spiders-hug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@sumup-oss/circuit-ui": minor
---

Added `promo` variant for `InlineNotification`.
9 changes: 8 additions & 1 deletion packages/circuit-ui/components/Notification/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,16 @@ import {
Confirm,
Info,
Notify,
Sparkles,
type IconComponentType,
} from '@sumup-oss/icons';

export type NotificationVariant = 'info' | 'success' | 'warning' | 'danger';
export type NotificationVariant =
| 'info'
| 'success'
| 'warning'
| 'danger'
| 'promo';

export const NOTIFICATION_ICONS: Record<
NotificationVariant,
Expand All @@ -31,6 +37,7 @@ export const NOTIFICATION_ICONS: Record<
success: Confirm,
warning: Notify,
danger: Alert,
promo: Sparkles,
};

export const TRANSITION_DURATION = 200;
Expand Down
1 change: 1 addition & 0 deletions packages/circuit-ui/components/NotificationInline/NotificationInline.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The `NotificationInline` component renders an inline notification within the con
- Use the 'success' variant the successful messages.
- Use the 'warning' variant for warning messages, and other information a user should be aware of.
- Use the 'danger' variant for error messages. Be descriptive and give users clear next steps.
- Use the 'promo' variant for promotional messages or recommendations.

### Dismissable notifications

Expand Down
8 changes: 8 additions & 0 deletions packages/circuit-ui/components/NotificationInline/NotificationInline.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,14 @@
color: var(--cui-fg-danger);
}

.promo {
background-color: var(--cui-bg-promo);
}

.promo .icon {
color: var(--cui-fg-promo);
}

.content {
display: flex;
flex-direction: column;
Expand Down
17 changes: 17 additions & 0 deletions packages/circuit-ui/components/NotificationInline/NotificationInline.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,23 @@ describe('NotificationInline', () => {
});
});

it.each([
'info',
'success',
'warning',
'danger',
'promo',
] as const)('should render the %s variant', async (variant) => {
renderNotificationInline({
...baseProps,
variant,
});

await waitFor(() => {
expect(screen.getByText(baseProps.body)).toBeVisible();
});
});

it('should render notification inline with headline', () => {
renderNotificationInline({
...baseProps,
Expand Down
2 changes: 1 addition & 1 deletion packages/circuit-ui/components/NotificationInline/NotificationInline.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export default {
tags: ['status:stable'],
};

const variants = ['info', 'success', 'warning', 'danger'] as const;
const variants = ['info', 'success', 'warning', 'danger', 'promo'] as const;

export const Base = (args: NotificationInlineProps) => (
<NotificationInline {...args} isVisible={true} />
Expand Down
8 changes: 8 additions & 0 deletions packages/circuit-ui/components/NotificationToast/NotificationToast.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,14 @@
color: var(--cui-fg-danger);
}

.promo {
background-color: var(--cui-bg-promo);
}

.promo .icon {
color: var(--cui-fg-promo);
}

.content {
display: flex;
flex-direction: column;
Expand Down
1 change: 1 addition & 0 deletions skills/circuit-ui/references/components/NotificationInline.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The `NotificationInline` component renders an inline notification within the con
- Use the 'success' variant the successful messages.
- Use the 'warning' variant for warning messages, and other information a user should be aware of.
- Use the 'danger' variant for error messages. Be descriptive and give users clear next steps.
- Use the 'promo' variant for promotional messages or recommendations.

### Dismissable notifications

Expand Down
Loading