mountain_view icon indicating copy to clipboard operation
mountain_view copied to clipboard

Further UX changes for consideration

Open ChristineP2 opened this issue 7 years ago • 7 comments

  • Determine whether the example code should use HAML or ERB, and display the example in whichever the component was written in
  • Allow HTML in the meta and in the mv_description
  • Toggle Sidebar so that it can be removed from the interface to better view the responsive elements
  • Toggle Usage details so they take up less space on initial display

ChristineP2 avatar Oct 11 '18 14:10 ChristineP2

Determine whether the example code should use HAML or ERB, and display the example in whichever the component was written in

This would be interesting! We can let the user tell us that via a configuration option, like template_engine and could be set to erb (default) or haml, and leave it open so we can extend to slim, mote and others.

Allow HTML in the meta and in the mv_description

👍

Toggle Sidebar so that it can be removed from the interface to better view the responsive elements

👍

Toggle Usage details so they take up less space on initial display

👍

I like the idea of being able to toggle both certain UI areas to allow more space for components. It would be ideal to accomplish that with CSS only (no JS) but not sure if possible.

kitop avatar Oct 17 '18 10:10 kitop

As far as toggling the UI goes, we might be able to do it with CSS only, but it is a little clunky. It's easier to use JS, but here is a CSS only fiddle. http://jsfiddle.net/ChristineP2/nLtfewvz/1/

The most annoying remaining issue is the expansion indicator displaying after a link is clicked, until the page reloads.

ChristineP2 avatar Oct 21 '18 00:10 ChristineP2

Thanks for researching! Yeah, lets go with JS. Definitively easier and more flexible.

For some reason I though we were not including any JS, that's why I suggested CSS-only approach—but I was completely off, sorry!!

kitop avatar Oct 21 '18 08:10 kitop

Sorry I didn't get updates this week, Halloween ate all my spare time. Hoping to be able to circle back next Friday.

ChristineP2 avatar Nov 02 '18 22:11 ChristineP2

Absolutely no problems! Thanks for the heads up. There's no pressure at all to get this released, so take your time :)

kitop avatar Nov 03 '18 09:11 kitop

Might want to use markdown instead of HTML for descriptions and such... but that creates other dependencies, so need to think about that 🤔

ghost avatar Dec 12 '18 19:12 ghost

I'm a huge fan of markdown, but as you said, I wouldn't like to introduce another dependency. And given the audience and platform this is going to be running, I think HTML is a reasonable choice and even more flexible.

kitop avatar Dec 12 '18 21:12 kitop