Bug in documentation upon loading the button fast in animated terminals

[phalberg]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the documentation, with the integrated search.
• I already searched in Google "How to X" and didn't find any information.
• I already read and followed all the tutorials in the docs and didn't find an answer.

Example Code

No relevant example code.

Description

Problem

There seems to be an issue with the button fast upon reloading pages, or loading them (in some cases). The button seems to have two main issues:

• It is present to the top left, hiding amongst other code. This makes it hard to identify, and know that it even is a clearly button.
• It has an icon besides it that looks as if it will open up a new page, which might discourage users (since they don't wish to have a new tab..) or just confuse them.

Some pictures to get a clear image of what I am talking about:

(from https://typer.tiangolo.com/tutorial/commands/one-or-multiple/)

Upon hitting the restart button one sees the more intended behavior and look:

(top right, and no extra icon showcasing that it will upon up a new page).

Note about scope

I have seen that this problem occurs also in the official FastAPI documentation, for example: fastapi-cli/, and SQLModel too, for example #read-the-first-row - I have not tested so much more than that.

Reproducibility

For reproducibility this seems to be an issue upon loading the terminal box at first time or so, or even just realoading the page this seems to happen every time (at least in some cases):

For Typer docs - try realoding this page and see behavior appear: https://typer.tiangolo.com/tutorial/commands/one-or-multiple/
For FastAPI docs - try reloading this page and see behavior appear: https://fastapi.tiangolo.com/fastapi-cli/
For SQLModel docs - https://sqlmodel.tiangolo.com/tutorial/one/#read-the-first-row

When the animations are finished, and clicking restart one sees the more intended behavior, where the fast button appears on the top right with no extra icon.

Hint to a solution

I suspect that this has to do with some race condition upon loading the page, then it fails and this is some fallback perhaps - altough I must say have not looked too hard into this for now - but I surely can if this makes it further and a PR is wanted by a maintainer!

Operating System

Windows

Operating System Details

More info can be added if needed.

Project Version

0.27.0

Python Version

Dont see this as relevant here.

Additional Context

No response

[svlandeg]

Whoa, this is weird, and I've never seen this before. Wonder whether something changed somehow for this to have started happening 🤔

[phalberg]

I agree with you. I can check whether #1904 altered this somehow as this was the most recent change closely relevant to this (I think), check if the same behavior is present before that PR just to make sure, and come back to you!

[phalberg]

Okay, I tested this a bit more. It looks like the change in #1904 causes this error; when I change it back to # (from 'javascript:void(0)' ), the issue no longer occurs.

That said, I believe the change introduced in #1904 was important, so simply reverting it probably is not the right solution (please correct if you think otherwise!). I’m happy to investigate further over the next few days and look for a cleaner fix.

Would you prefer that I work toward a PR directly, or first document what I find so we can discuss the best approach? This may affect multiple repositories, so it could be worth agreeing on the intended solution before implementing it, I guess this could also be a discussion in the potential PR...

[svlandeg]

Hi @phalberg! Happy for you to work towards a PR directly, you can open one in draft which will allow you to inspect the docs before and after the commits from the PR, which should hopefully help you with the digging. Let's do it here on Typer first, and review/discuss that in detail before touching the other repos. Thanks! 🙏

[phalberg]

Sounds good @svlandeg!
I will link up the PR to this discussion and you will hear from me soon then.
Thank you!

[phalberg]

Fix in #1912