Skip to content

Enhancement: notification cookie support #828

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

Merged
merged 1 commit into from
Apr 3, 2020
Merged

Enhancement: notification cookie support #828

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
1 change: 1 addition & 0 deletions components/embl-notifications/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## 1.0.0-alpha.2

* Improved formatting support and conditional logic https://github.com/visual-framework/vf-core/pull/817
* Notification cookies and memory options

## 1.0.0-alpha.1 (2020-03-20)

Expand Down
2 changes: 1 addition & 1 deletion components/embl-notifications/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Fetches notifications from the EMBL contentHub and will display them, if a match
## Possible features not currently planned:

- Only show if a wrapping element has `data-vf-js-embl-notifications`
- Also load messages from EBI's folder https://ebi.emblstatic.net/announcements.js
- Also load messages from EBI's existing announcement JS at https://ebi.emblstatic.net/announcements.js
- Use the vf-banner precompiled njk template to render output
- Test for better support on non-VF 2.0 sites

Expand Down
20 changes: 11 additions & 9 deletions components/embl-notifications/embl-notifications.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ import { vfBanner } from 'vf-banner/vf-banner';
function emblNotificationsInject(message) {
let output = document.createElement('div');

// @todo:
// - add support in contentHub for extra button text, link

// preperation
message.body = message.body.replace(/<[/]?[p>]+>/g, ' '); // no <p> tags allowed in inline messages, preserve a space to not colide words
// add vf-link to link
Expand All @@ -21,20 +24,22 @@ function emblNotificationsInject(message) {
}
// custom button text
message.field_notification_button_text = message.field_notification_button_text || 'Close notice';
// notification memory and cookie options
if (message.field_notification_cookie == "True") {
output.dataset.vfJsBannerCookieName = message.cookieName;
output.dataset.vfJsBannerCookieVersion = message.cookieVersion;
if (message.field_notification_auto_accept == "True") {
output.dataset.vfJsBannerAutoAccept = true;
}
}

// @todo:
// - cookie name, version
// - extra button text, link
if (message.field_notification_position == 'fixed') {
output.classList.add('vf-banner', 'vf-banner--fixed', 'vf-banner--bottom', 'vf-banner--notice');
output.dataset.vfJsBanner = true;
output.dataset.vfJsBannerState = message.field_notification_presentation;
output.dataset.vfJsBannerButtonText = message.field_notification_button_text;
// These features are not yet supported by the notification content type in the EMBL contentHub
// output.dataset.vfJsBannerCookieName = "CookieName";
// output.dataset.vfJsBannerCookieVersion = "CookieVersion";
// output.dataset.vfJsBannerExtraButton = "<a href='#'>Optional button</a><a target='_blank' href='#'>New tab button</a>";
// output.dataset.vfJsBannerAutoAccept = false;
output.innerHTML = `
<div class="vf-banner__content | vf-grid" data-vf-js-banner-text>
<p class="vf-text vf-text-body--2">${message.body}</p>
Expand Down Expand Up @@ -74,10 +79,7 @@ function emblNotificationsInject(message) {
output.dataset.vfJsBannerState = message.field_notification_presentation;
output.dataset.vfJsBannerButtonText = message.field_notification_button_text;
// These features are not yet supported by the notification content type in the EMBL contentHub
// output.dataset.vfJsBannerCookieName = "CookieName";
// output.dataset.vfJsBannerCookieVersion = "CookieVersion";
// output.dataset.vfJsBannerExtraButton = "<a href='#'>Optional button</a><a target='_blank' href='#'>New tab button</a>";
// output.dataset.vfJsBannerAutoAccept = false;
output.innerHTML = `
<div class="vf-banner__content" data-vf-js-banner-text>
<p class="vf-banner__text">${message.body}</p>
Expand Down