Skip to content

typed: stop the subtitle animation before the page is replaced #626

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
theman6660 wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

typed: stop the subtitle animation before the page is replaced #626

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
18 changes: 16 additions & 2 deletions source/js/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,17 @@ let globalsInitialized = false;
let didInitRefreshEvent = false;
let appController = null;
let pageController = null;
let typedModule = null;

const loadTypedModule = () => {
const pending = import("./plugins/typed.js");
pending
.then((module) => {
typedModule = module;
})
.catch(() => {});
return pending;
};

const getAppSignal = () => {
if (!appController) {
Expand Down Expand Up @@ -253,7 +264,7 @@ const initPage = () => {
lazyRun(
"typed",
pageSignal,
() => import("./plugins/typed.js"),
loadTypedModule,
({ default: initTyped }) => {
initTyped("subtitle");
},
Expand Down Expand Up @@ -343,7 +354,10 @@ const swup = window.swup;

if (swup?.hooks) {
swup.hooks.on("page:view", initPage);
swup.hooks.before("content:replace", abortPageScope);
swup.hooks.before("content:replace", () => {
typedModule?.destroyTyped("subtitle");
abortPageScope();
});
swup.hooks.on("visit:start", () => {
navbarShrink.setNavigating(true);
});
Expand Down
32 changes: 30 additions & 2 deletions source/js/plugins/typed.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,30 @@ const normalizeSubtitleText = (subtitleText) => {
return [];
};

const removeCursorSiblings = (element) => {
if (!element?.parentNode) {
return;
}

let sibling = element.nextSibling;
while (sibling?.classList?.contains("typed-cursor")) {
const next = sibling.nextSibling;
sibling.remove();
sibling = next;
}
};

const destroyInstance = (id) => {
const instance = instances.get(id);
if (instance && typeof instance.destroy === "function") {
try {
if (instance.timeout) {
clearTimeout(instance.timeout);
}
instance.destroy();
if (instance.timeout) {
clearTimeout(instance.timeout);
}
} catch (error) {
console.error("Failed to destroy Typed instance:", error);
}
Expand All @@ -32,20 +51,28 @@ const destroyInstance = (id) => {
const element = document.getElementById(id);
if (element) {
element.innerHTML = "";
removeCursorSiblings(element);
}
};

// Bump the token first so a hitokoto response still in flight cannot
// start another Typed after the page has gone away.
export function destroyTyped(id) {
initTokens.set(id, (initTokens.get(id) || 0) + 1);
destroyInstance(id);
}

const createTyped = (id, strings, options, callbacks = {}) => {
if (typeof window.Typed === "undefined") {
return;
}

destroyInstance(id);

if (!document.getElementById(id)) {
return;
}

destroyInstance(id);

const instance = new window.Typed(`#${id}`, {
strings,
typeSpeed: options.typeSpeed,
Expand Down Expand Up @@ -109,6 +136,7 @@ export const config = {
export default function initTyped(id) {
const currentToken = (initTokens.get(id) || 0) + 1;
initTokens.set(id, currentToken);
destroyInstance(id);

const {
usrTypeSpeed,
Expand Down