Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MediaElement.js upgrade #298

Open
swashbuck opened this issue Jul 18, 2024 · 7 comments · May be fixed by #299
Open

MediaElement.js upgrade #298

swashbuck opened this issue Jul 18, 2024 · 7 comments · May be fixed by #299

Comments

@swashbuck
Copy link
Contributor

swashbuck commented Jul 18, 2024

Subject of the enhancement

Explore updating the MediaElement.js library. This may also require MediaElement.js plugins as that repo contains features like Speed.

The primary goal is to fix some existing a11y issues like #297 and #232. It is unclear if updating the library will fix those. New features should not be considered as part of this analysis.

MediaElement.js Migration Guide

Your environment

  • Media 6.7.0
@swashbuck
Copy link
Contributor Author

swashbuck commented Aug 21, 2024

From MediaElement.js version 3.x and later, the namespace has changed from mejs- to mejs__. The classPrefix option allows us to use the legacy namespace. However, the Vanilla styles would still need to be updated to support the new version. This means that users who update the Vanilla theme will be forced to also update the Media plugin in their courses.

If we switch to using the new namespace, we can leave legacy styles in the Vanilla theme. So, older versions of the Media component would be still supported by the Vanilla theme. The downside is that custom plugins that extend the Media plugin may break due to the namespace change. However, I think this is the better option.

Thoughts?

@oliverfoster
Copy link
Member

How far have you been down either option?

@swashbuck
Copy link
Contributor Author

How far have you been down either option?

I've been using the new namespaces mejs__. However, it wouldn't be too much work to back out of it. Mostly a find and replace chore.

@oliverfoster
Copy link
Member

I think carrying on with the new mejs__ is probably the sensible option. we'll have to do it at some point. Now seems good.

Are the styles very similar? Do you have any sense of the work required to update the library and keep the legacy css namespace?

@swashbuck
Copy link
Contributor Author

Yeah, that's what I was thinking. They may eventually remove the classPrefix option entirely, so might as well transition now.

I'll be looking into the theme styles currently. Just resolved an issue that was blocking me.

@swashbuck
Copy link
Contributor Author

Should we remove Vimeo support since there is a dedicated plugin for Vimeo? This would remove some complexity since froogaloop.js is used solely for Vimeo afaik.

@oliverfoster
Copy link
Member

And anything YouTube related for the same reason.

@swashbuck swashbuck changed the title MediaElement.js upgrade analysis MediaElement.js upgrade Sep 26, 2024
@swashbuck swashbuck moved this from Assigned to Needs Reviewing in adapt_framework: The TODO Board Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Needs Reviewing
Development

Successfully merging a pull request may close this issue.

2 participants