adaptlearning / adapt-contrib-narrative

A component that displays an image gallery with accompanying text
GNU General Public License v3.0
5 stars 39 forks source link

Simplify plugin #279

Open guywillis opened 9 months ago

guywillis commented 9 months ago

Subject of the issue

We should look into simplifying the configuration options that exist as part of this plugin to reduce maintenance overhead and reduce configuration complexity.

Your environment

kirsty-hames commented 8 months ago

I find _isMobileTextBelowImage preferable but often use the default because course authors aren't aware of this option. The default mobile layout is also a reason why some designers choose to avoid Narrative altogether. I'd be happy to remove the strapline functionality and replace with _isMobileTextBelowImage.

I've not used _hasNavigationInTextArea so I wouldn't miss this as a config option either.

kirsty-hames commented 6 months ago

I find _isMobileTextBelowImage preferable but often use the default because course authors aren't aware of this option. The default mobile layout is also a reason why some designers choose to avoid Narrative altogether. I'd be happy to remove the strapline functionality and replace with _isMobileTextBelowImage.

If, for whatever reason we can't/or choose not to remove the default strapline functionality, could we set _isMobileTextBelowImage as the default mobile view? Doing so shouldn't incur any issues for courses already using the default strapline functionality. The instruction text will just use the existing desktop instruction (instead of mobileInstruction).

I've not used _hasNavigationInTextArea so I wouldn't miss this as a config option either.

Since this, I have used _hasNavigationInTextArea in a couple of projects. I'm not sure what's preferable when it comes to flexibility of display or simple code/config.

swashbuck commented 1 month ago

We almost always use _isStackedOnMobile for mobile views.



I have also used _hasNavigationInTextArea a few times recently, so I think it's still useful.



I would be in favor of removing the strapline layout altogether.

kirsty-hames commented 1 month ago

I would be in favor of removing the strapline layout altogether.

We haven't had any objections to this so far. I suppose the next step is to confirm what the default layout for mobile should be, _isMobileTextBelowImage vs _isStackedOnMobile. Thoughts? I'd happily go with the majority on this.

oliverfoster commented 1 month ago

Opinion

_isMobileTextBelowImage is still quite interactive and a nice way of shortening a long page. It focuses a subject/story/narrative in one sideways section.

_isStackedOnMobile, whilst easy, provides nothing extra to some stacked text + graphics

I'm not sure what the downsides are of either in practice.

swashbuck commented 1 month ago

The downside to the _isMobileTextBelowImage option is that it can sometimes require up and down scrolling, depending on the aspect ratio of the images, the amount of text for each stage, and the device's screen size.