ept / avrodoc

Documentation tool for Avro schemas
Apache License 2.0
148 stars 82 forks source link

Popovers containing a complex type cause a "flickering effect" in Firefox #3

Open mphuff opened 11 years ago

mphuff commented 11 years ago

In Firefox version 18, I've noticed that when you hover over a known complex type on a protocol page, if that type contains as a property another known complex type, the popover dialog flickers and is impossible to read.

I can't easily get a screenshot of this behavior but I'm using Firefox 18 on Ubuntu 10.4. I've tried at least FF 18 on Windows 7 and the issue doesn't appear there.

This is not a huge deal but something that could possibly be fixed for a future version.

Thanks, Micah

ept commented 11 years ago

We're currently using the popover library from Twitter Bootstrap, and that library seems to be pretty bad. I've also had sporadic problems with popovers appearing in random places and getting stuck (still visible even when you move the mouse away).

I suggest we keep the Bootstrap styling, but throw out the JS library and replace it with something better. I like hoverIntent for detecting hover state, but that doesn't help with calculating popover positioning. Suggestions for better libraries welcome, or we can just write something ourselves.

Even better if the new library would allow us to get rid of renderPopovers() (in public/js/avrodoc.js) by letting us generate the popover contents asynchronously on demand.

mphuff commented 11 years ago

I found this tool that may be nice to use: http://www.opentip.org/ This looks like exactly what we would want.