GEOLYTIX / xyz

An open source javascript framework for spatial data and application interfaces.
MIT License
86 stars 25 forks source link

helpModal user config #1256

Closed dbauszus-glx closed 3 weeks ago

dbauszus-glx commented 1 month ago

A user should be able to control and save whether the helpModal will be shown to them.

The helpModal probably shouldn't be shown on mobile.

simon-leech commented 1 month ago

Question - should this be a blanket helpModal on or off? Or should helpModals hold an identifier too to be able to turned off independently ? For instance, if we expand helpModals to be on lots of elements. Lets say I want to turn it off for drawing interactions, but keep it on for a plugin with custom functionality?

RobAndrewHurst commented 1 month ago

Can we embed images into the modal?

And maybe even support markdown?

dbauszus-glx commented 1 month ago

@simon-leech The data_id provided as param to the helpModal will passed on to the modal. This allows for a querySelect via the data_id.

dbauszus-glx commented 1 month ago

@RobAndrewHurst The content is provided as html element. This can include images.

It would be great to support markdown. I will create a different PR for this. We would need a parser which turns markdown into a html element. https://github.com/GEOLYTIX/xyz/issues/1258

dbauszus-glx commented 3 weeks ago

image

A dialog will be shown with instructions for the drawing interactions.