Skip to content

Preserve original font for private-use glyphs #90

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

Open
TundTT wants to merge 1 commit into
base: main
Choose a base branch
from
+192 −0
Open

Preserve original font for private-use glyphs #90

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
80 changes: 80 additions & 0 deletions app/assets/styles/core/opendyslexic.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ body.opendyslexic-font-regular
:where(
svg,
svg *,
.opendyslexic-preserve-font,
.opendyslexic-preserve-font *,
[aria-hidden='true'],
[aria-hidden='true'] *,
[role='img'],
[role='img'] *,
[data-icon],
[data-icon] *,
[class*='fui-'],[class*='fa-'],
[class*='fa-'] *,
[class~='fa'],
Expand Down Expand Up @@ -102,6 +110,14 @@ body.opendyslexic-font-italic
:where(
svg,
svg *,
.opendyslexic-preserve-font,
.opendyslexic-preserve-font *,
[aria-hidden='true'],
[aria-hidden='true'] *,
[role='img'],
[role='img'] *,
[data-icon],
[data-icon] *,
[class*='fui-'],[class*='fa-'],
[class*='fa-'] *,
[class~='fa'],
Expand Down Expand Up @@ -149,6 +165,14 @@ body.opendyslexic-font-bold
:where(
svg,
svg *,
.opendyslexic-preserve-font,
.opendyslexic-preserve-font *,
[aria-hidden='true'],
[aria-hidden='true'] *,
[role='img'],
[role='img'] *,
[data-icon],
[data-icon] *,
[class*='fui-'],[class*='fa-'],
[class*='fa-'] *,
[class~='fa'],
Expand Down Expand Up @@ -299,6 +323,14 @@ body.helperbird-reading-lora-regular
:where(
svg,
svg *,
.opendyslexic-preserve-font,
.opendyslexic-preserve-font *,
[aria-hidden='true'],
[aria-hidden='true'] *,
[role='img'],
[role='img'] *,
[data-icon],
[data-icon] *,
[class*='fui-'],[class*='fa-'],
[class*='fa-'] *,
[class~='fa'],
Expand Down Expand Up @@ -340,6 +372,14 @@ body.helperbird-reading-lora
:where(
svg,
svg *,
.opendyslexic-preserve-font,
.opendyslexic-preserve-font *,
[aria-hidden='true'],
[aria-hidden='true'] *,
[role='img'],
[role='img'] *,
[data-icon],
[data-icon] *,
[class*='fui-'],[class*='fa-'],
[class*='fa-'] *,
[class~='fa'],
Expand Down Expand Up @@ -386,6 +426,14 @@ body.helperbird-reading-lora-italic
:where(
svg,
svg *,
.opendyslexic-preserve-font,
.opendyslexic-preserve-font *,
[aria-hidden='true'],
[aria-hidden='true'] *,
[role='img'],
[role='img'] *,
[data-icon],
[data-icon] *,
[class*='fui-'],[class*='fa-'],
[class*='fa-'] *,
[class~='fa'],
Expand Down Expand Up @@ -432,6 +480,14 @@ body.helperbird-reading-lora-bold
:where(
svg,
svg *,
.opendyslexic-preserve-font,
.opendyslexic-preserve-font *,
[aria-hidden='true'],
[aria-hidden='true'] *,
[role='img'],
[role='img'] *,
[data-icon],
[data-icon] *,
[class*='fui-'],[class*='fa-'],
[class*='fa-'] *,
[class~='fa'],
Expand Down Expand Up @@ -478,6 +534,14 @@ body.helperbird-reading-opendyslexic
:where(
svg,
svg *,
.opendyslexic-preserve-font,
.opendyslexic-preserve-font *,
[aria-hidden='true'],
[aria-hidden='true'] *,
[role='img'],
[role='img'] *,
[data-icon],
[data-icon] *,
[class*='fui-'],[class*='fa-'],
[class*='fa-'] *,
[class~='fa'],
Expand Down Expand Up @@ -525,6 +589,14 @@ body.helperbird-reading-opendyslexic-italic
:where(
svg,
svg *,
.opendyslexic-preserve-font,
.opendyslexic-preserve-font *,
[aria-hidden='true'],
[aria-hidden='true'] *,
[role='img'],
[role='img'] *,
[data-icon],
[data-icon] *,
[class*='fui-'],[class*='fa-'],
[class*='fa-'] *,
[class~='fa'],
Expand Down Expand Up @@ -571,6 +643,14 @@ body.helperbird-reading-opendyslexic-bold
:where(
svg,
svg *,
.opendyslexic-preserve-font,
.opendyslexic-preserve-font *,
[aria-hidden='true'],
[aria-hidden='true'] *,
[role='img'],
[role='img'] *,
[data-icon],
[data-icon] *,
[class*='fui-'],[class*='fa-'],
[class*='fa-'] *,
[class~='fa'],
Expand Down
63 changes: 63 additions & 0 deletions app/scripts/content/engine.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ let currentFont = 'regular';

const FONT_ID = 'opendyslexic-font-styles';
const BODY_CLASS_PREFIX = 'opendyslexic-font-';
const PRESERVE_FONT_CLASS = 'opendyslexic-preserve-font';
const PRIVATE_USE_TEXT = /[\uE000-\uF8FF\u{F0000}-\u{FFFFD}\u{100000}-\u{10FFFD}]/u;

let preserveFontObserver = null;

function injectCssInline(id, cssString) {
let styleTag = document.getElementById(id);
Expand All @@ -29,6 +33,57 @@ function removeBodyClasses() {
.forEach((className) => document.body.classList.remove(className));
}

function markPrivateUseText(root = document.body) {
const nodeFilter = document.defaultView?.NodeFilter || NodeFilter;
const treeWalker = document.createTreeWalker(root, nodeFilter.SHOW_TEXT);

while (treeWalker.nextNode()) {
const parent = treeWalker.currentNode.parentElement;
if (parent && PRIVATE_USE_TEXT.test(treeWalker.currentNode.nodeValue)) {
parent.classList.add(PRESERVE_FONT_CLASS);
}
}
}

function observePrivateUseText() {
if (preserveFontObserver || typeof MutationObserver === 'undefined') return;

preserveFontObserver = new MutationObserver((mutations) => {
mutations.forEach((mutation) => {
if (mutation.type === 'characterData') {
const parent = mutation.target.parentElement;
if (parent && PRIVATE_USE_TEXT.test(mutation.target.nodeValue)) {
parent.classList.add(PRESERVE_FONT_CLASS);
}
return;
}

mutation.addedNodes.forEach((node) => {
if (node.nodeType === Node.TEXT_NODE) {
const parent = node.parentElement;
if (parent && PRIVATE_USE_TEXT.test(node.nodeValue)) {
parent.classList.add(PRESERVE_FONT_CLASS);
}
} else if (node.nodeType === Node.ELEMENT_NODE) {
markPrivateUseText(node);
}
});
});
});

preserveFontObserver.observe(document.body, {
childList: true,
characterData: true,
subtree: true
});
}

function removePreservedFontClasses() {
document
.querySelectorAll(`.${PRESERVE_FONT_CLASS}`)
.forEach((element) => element.classList.remove(PRESERVE_FONT_CLASS));
}

function applyFont(fontName) {
removeStyleTag(FONT_ID);

Expand All @@ -42,11 +97,19 @@ function applyFont(fontName) {

const className = BODY_CLASS_PREFIX + fontName.toLowerCase();
document.body.classList.add(className);
markPrivateUseText();
observePrivateUseText();
}

function removeFont() {
removeStyleTag(FONT_ID);
removeBodyClasses();
removePreservedFontClasses();

if (preserveFontObserver) {
preserveFontObserver.disconnect();
preserveFontObserver = null;
}
}

function updateFontMode(mode, font) {
Expand Down
49 changes: 49 additions & 0 deletions tests/content/engine.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,55 @@ describe('font application via messages', () => {

expect(document.getElementById(FONT_ID)).toBeNull();
});

it('preserves the original font for private-use glyphs', () => {
const icon = document.createElement('span');
icon.textContent = '\uE000';
document.body.appendChild(icon);

messageListener({
type: 'updateFont',
enabled: true,
font: 'regular'
});

expect(icon.classList.contains('opendyslexic-preserve-font')).toBe(true);
});

it('preserves private-use glyphs added after the font is enabled', async () => {
messageListener({
type: 'updateFont',
enabled: true,
font: 'regular'
});

const icon = document.createElement('span');
icon.textContent = '\uE000';
document.body.appendChild(icon);

await Promise.resolve();

expect(icon.classList.contains('opendyslexic-preserve-font')).toBe(true);
});

it('removes preserved font markers when disabled', () => {
const icon = document.createElement('span');
icon.textContent = '\uE000';
document.body.appendChild(icon);

messageListener({
type: 'updateFont',
enabled: true,
font: 'regular'
});
messageListener({
type: 'updateFont',
enabled: false,
font: 'regular'
});

expect(icon.classList.contains('opendyslexic-preserve-font')).toBe(false);
});
});

describe('style tag management', () => {
Expand Down