Skip to content
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

refactor(Notification): set notification portal from the components lifecycle: connectedCallback() #1236

Merged
merged 1 commit into from
Aug 29, 2024
Merged

refactor(Notification): set notification portal from the components lifecycle: connectedCallback() #1236

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
49 changes: 33 additions & 16 deletions packages/beeq/src/components/notification/bq-notification.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Component, Element, Event, EventEmitter, h, Host, Listen, Method, Prop,
import { NOTIFICATION_TYPE, TNotificationBorderRadius, TNotificationType } from './bq-notification.types';
import { debounce, enter, hasSlotContent, leave, TDebounce, validatePropValue } from '../../shared/utils';

const notificationPortal = Object.assign(document.createElement('div'), { className: 'bq-notification-portal' });
const NOTIFICATION_PORTAL_SELECTOR = 'bq-notification-portal';

/**
* @part base - The `<div>` container of the predefined bq-icon component.
Expand All @@ -17,6 +17,12 @@ const notificationPortal = Object.assign(document.createElement('div'), { classN
* @part svg - The `<svg>` element of the predefined bq-icon component.
* @part title - The container `<div>` that wraps the notification title content
* @part wrapper - The wrapper container `<div>` of the element inside the shadow DOM
*
* @slot - The notification title content
* @slot body - The notification description content
* @slot footer - The notification footer content
* @slot icon - The icon to be displayed in the notification
* @slot btn-close - The close button of the notification
*/

@Component({
Expand Down Expand Up @@ -44,6 +50,7 @@ export class BqNotification {

@State() private hasContent = false;
@State() private hasFooter = false;
@State() private notificationPortal = document.querySelector(`.${NOTIFICATION_PORTAL_SELECTOR}`);

// Public Property API
// ========================
Expand Down Expand Up @@ -117,6 +124,15 @@ export class BqNotification {
// Ordered by their natural call order
// =====================================

connectedCallback() {
const { notificationPortal } = this;
if (!notificationPortal) {
this.notificationPortal = Object.assign(document.createElement('div'), {
className: NOTIFICATION_PORTAL_SELECTOR,
});
}
}

componentWillLoad() {
this.checkPropValues();
this.handleTimeout();
Expand All @@ -128,9 +144,10 @@ export class BqNotification {
@Listen('bqAfterClose')
afterNotificationClose() {
try {
const { notificationPortal } = this;
notificationPortal.removeChild(this.el);
// Remove the notification portal from the DOM when there are no more notifications
if (notificationPortal.querySelector('bq-notification') === null) {
if (notificationPortal.querySelector(this.el.tagName.toLowerCase()) === null) {
notificationPortal.remove();
}
} catch (error) {
Expand Down Expand Up @@ -165,11 +182,12 @@ export class BqNotification {
/** This method can be used to display notifications in a fixed-position element that allows for stacking multiple notifications vertically */
@Method()
async toast() {
if (notificationPortal.parentElement === null) {
const { notificationPortal } = this;
if (notificationPortal?.parentElement === null) {
document.body.append(notificationPortal);
}

notificationPortal.appendChild(this.el);
notificationPortal?.appendChild(this.el);
requestAnimationFrame(() => {
this.show();
});
Expand Down Expand Up @@ -216,16 +234,13 @@ export class BqNotification {
};

private get iconName(): string {
switch (this.type) {
case 'error':
return 'x-circle';
case 'success':
return 'check-circle';
case 'warning':
return 'warning-circle';
default:
return 'info';
}
const typeMap = {
error: 'x-circle',
success: 'check-circle',
warning: 'warning-circle',
};

return typeMap[this.type] || 'info';
}

// render() function
Expand Down Expand Up @@ -259,13 +274,15 @@ export class BqNotification {
{/* CLOSE BUTTON */}
{!this.disableClose && (
<bq-button
class="notification--close absolute inset-ie-5"
class="notification--close absolute inset-ie-5 [&::part(label)]:inline-flex"
appearance="text"
size="small"
onClick={() => this.hide()}
part="btn-close"
>
<bq-icon name="x" />
<slot name="btn-close">
<bq-icon name="x" />
</slot>
</bq-button>
)}
{/* ICON */}
Expand Down
11 changes: 11 additions & 0 deletions packages/beeq/src/components/notification/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,17 @@ Type: `Promise<void>`



## Slots

| Slot | Description |
| ------------- | -------------------------------------------- |
| | The notification title content |
| `"body"` | The notification description content |
| `"btn-close"` | The close button of the notification |
| `"footer"` | The notification footer content |
| `"icon"` | The icon to be displayed in the notification |


## Shadow Parts

| Part | Description |
Expand Down