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

Add a basic oEmbedProvider for LottieFiles animations #12151

Merged

Conversation

marcemarc
Copy link
Contributor

@marcemarc marcemarc commented Mar 18, 2022

Prerequisites

  • I have added steps to test this contribution in the description below

If there's an existing issue for this PR then this fixes

Description

LottieFiles (https://lottiefiles.com/) - The popular opensource JSON-based animation file format that enables designers to ship animations on any platform, has just started supporting OEmbed, from their gallery of community animations, which makes it a lovely candidate for adding an OEmbedProvider to Umbraco's Embed functionality for LottieFiles.

I was going to create a package for this but then it would be called Our.Umbraco.Lottie and I think that would be confusing for people, as they consider Our Umbraco Lottie to be @LottePitcher ... so I think therefore it MUST go in the core.

How to test?

Visit the LottieFiles gallery of 'free animations'

https://lottiefiles.com/featured

picklottiefile

search and find the animation you want to embed, on the right hand side there is a panel of information about the animation, and one of the options is to copy the oEmbedUrl

grab that

Go back into Umbraco, and then inside a grid cell or Rich Text Area, click on the Embed option.

paste in the Oembed Url

Delight at seeing an animation in the embed panel

update your width and height as needs be...

Select and publish your page - your animation will appear!

lottiefilespigeon

There is really lots more you can do with LottieFiles, and I'm sure someone will build a package to take advantage of the options, and allow you to upload the JSON into the media section etc, but for the timebeing, adding the oEmbedProvider might help spread the word about it's existence...

This PR just adds a new LottieFiles OEmbedProvider, and adds it to the stack of providers in the Umbraco Builder.

While these are guidelines and not strict requirements, they really help us evaluate your PR quicker.

Thanks for considering this contributing to Umbraco CMS!

@umbrabot
Copy link

umbrabot commented Mar 18, 2022

Hi there @marcemarc, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

  • It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
  • The automated tests all pass (see "Checks" tab on this PR)
  • The level of security for this contribution is the same or improved
  • The level of performance for this contribution is the same or improved
  • Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
  • If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
  • 💡 The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

@mikecp mikecp self-requested a review March 18, 2022 22:24
@mikecp
Copy link
Contributor

mikecp commented Mar 19, 2022

Hey @marcemarc ,
Thanks a lot for this nice addition of a new oEmbed support 👍🎉
Maybe it can be enhanced to more options as you mentioned, but I think it is certainly a nice first step then😉
And I think that setting the width and height to 100% - when not specified otherwize - is a good compromise, this avoids using the provided height and width on which we have no control (imagine they start to return width of 1024 instead of 300😅 )

So we're all set to merge!

@mikecp mikecp merged commit defe9d4 into umbraco:v9/contrib Mar 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants