IdoLeshkowitz

IdoLeshkowitz

Restoring sticky live view scroll position during live redirects

Hey everyone :waving_hand:
Im using sticky live view to render a navbar across my app. The issue is the navbar scroll position resets whenever a live redirect happens within the app. How would you recommend approaching this?

First Post!

codeanpeace

codeanpeace

Welcome!

Hmm, that’s odd – LiveView’s definitely gotten better at restoring scroll position out of the box in more recent versions, but it sounds like sticky/nested LiveViews might still be a problem.

Anyways, I’d probably stash scroll position on the client and restore it via a phx-hook on mounted rather than tracking it from the server since it’s a UI concern.

# pseudocode
Hooks.StickyNav = {
  mounted(){
    // stash scroll top
    this.el.addEventListener("scroll", e => {
      // consider debouncing
      sessionStorage.setItem("stickyNavScrollTop", this.el.scrollTop)
    })

   // restore scroll top
   scrollTop = sessionStorage.getItem("stickyNavScrollTop")
   if (scrollTop) { this.el.scrollTop = scrollTop }
  }
}

note: session storage is tied to an individual tab so local storage may be the way to go if you want to handle new tabs as well

And just a heads up, live_redirect has been deprecated for a good while now so it may be worth updating soon – especially with 1.0 around the corner!

Last Post!

bu6n

bu6n

Seems like this is working for my use-case:

function debounce(func, timeout = 100) {
  let timer;
  return (...args) => {
    clearTimeout(timer);
    timer = setTimeout(() => {
      func.apply(this, args);
    }, timeout);
  };
}

/**
 * A hook used to keep the scroll position of elements
 * inside a sticky liveview after a live navigation.
 */

/**
 * Session storage key for restoring panel size.
 */
const SCROLL_POSITION_STORAGE_KEY = "scroll-position";

const KeepScrollPosition = {
  restoreScrollPosition(_info) {
    scrollTop = sessionStorage.getItem(`${this.el.id}-${SCROLL_POSITION_STORAGE_KEY}`);
    if (scrollTop) {
      this.el.scrollTop = scrollTop;
    }
  },

  mounted() {
    const save = debounce(() => {
      sessionStorage.setItem(`${this.el.id}-${SCROLL_POSITION_STORAGE_KEY}`, this.el.scrollTop);
    });

    this._restoreScrollPosition = this.restoreScrollPosition.bind(this);
    this.el.addEventListener("scroll", save);
    window.addEventListener("phx:page-loading-stop", this._restoreScrollPosition);
  },

  destroyed() {
    window.removeEventListener("phx:page-loading-stop", this._restoreScrollPosition);
  },
};

export { KeepScrollPosition };

Where Next?

Popular in Questions Top

nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
New
JeremM34
Hello, how can I check the Phoenix version ? Thanks !
New
lessless
I believe there are people here who are dealing with CSV files import on the daily basis, and since Excel is a really popular tool there ...
New
Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
albydarned
Hello all! I am typing this post from my new MacBook Pro with the M1 chip. I’m loving it so far, and will probably use it as my daily dr...
New
Harrisonl
We have an ECS cluster with 4 services, where each task joins a single cluster, via discovery ECS discovery service. Currently when I de...
New

Other popular topics Top

JakeBecker
TL;DR: I’ve just released an implementation of Microsoft’s IDE-independent Language Server Protocol for Elixir. It adds language support ...
1144 54921 245
New
lanycrost
Hi everyone! I need implement if…else if…else condition from my elixir code, and anymore of this control flow structures not work proper...
New
axelson
This post is a wiki (feel free to hit the edit button near the bottom right of this post to add your own changes!) This post collects co...
239 49084 226
New
Patoshizzle
After calling mix ecto.create I get this error: 17:00:32.162 [error] GenServer #PID<0.412.0> terminating ** (Postgrex.Error) FATAL...
New
jason.o
In the code below, if the create action is not set to accept “extra_key” as an input, it errors out with a message shown above. Is there ...
New
AstonJ
Posting this to see if we can make things easier for people to get into Neovim. If you use Neovim and have a favourite distro please let ...
New

We're in Beta

About us Mission Statement