{"id":18515309,"url":"https://github.com/jonnitto/jonnitto.prettyembedvimeo","last_synced_at":"2026-01-24T16:36:19.602Z","repository":{"id":57001267,"uuid":"170173986","full_name":"jonnitto/Jonnitto.PrettyEmbedVimeo","owner":"jonnitto","description":"Prettier embeds for your Vimeo videos in Neos CMS - with nice options like high-res preview images, lightbox feature and advanced customization of embed options.","archived":false,"fork":false,"pushed_at":"2023-03-16T13:58:34.000Z","size":122,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-15T09:04:18.786Z","etag":null,"topics":["hacktoberfest","neoscms","package","video","vimeo"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jonnitto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"jonnitto","custom":"https://www.paypal.me/Jonnitto/20eur"}},"created_at":"2019-02-11T17:48:13.000Z","updated_at":"2022-10-04T12:57:45.000Z","dependencies_parsed_at":"2024-11-06T15:53:29.269Z","dependency_job_id":null,"html_url":"https://github.com/jonnitto/Jonnitto.PrettyEmbedVimeo","commit_stats":{"total_commits":54,"total_committers":2,"mean_commits":27.0,"dds":0.07407407407407407,"last_synced_commit":"4fdaa21b67f5a7f488f5b9a2ab68cf59093e152f"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonnitto%2FJonnitto.PrettyEmbedVimeo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonnitto%2FJonnitto.PrettyEmbedVimeo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonnitto%2FJonnitto.PrettyEmbedVimeo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonnitto%2FJonnitto.PrettyEmbedVimeo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonnitto","download_url":"https://codeload.github.com/jonnitto/Jonnitto.PrettyEmbedVimeo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239231080,"owners_count":19603990,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","neoscms","package","video","vimeo"],"created_at":"2024-11-06T15:47:18.170Z","updated_at":"2025-10-31T21:30:22.040Z","avatar_url":"https://github.com/jonnitto.png","language":null,"funding_links":["https://github.com/sponsors/jonnitto","https://www.paypal.me/Jonnitto/20eur"],"categories":[],"sub_categories":[],"readme":"[![Latest stable version]][packagist] [![Total downloads]][packagist] [![License]][packagist] [![GitHub forks]][fork] [![Donate Paypal]][paypal] [![Wishlist amazon]][amazon] [![GitHub stars]][stargazers] [![GitHub watchers]][subscription] [![GitHub followers]][followers] [![Follow Jon on Twitter]][twitter]\n\n# Jonnitto.PrettyEmbedVimeo\n\n\u003e There is a successor of this package: [PrettyEmbedVideoPlatforms]\n\u003e It includes automatic detection of Vimeo or YouTube videos. To update, [follow these instructions].\n\nPrettier embeds for your Vimeo videos in [Neos CMS] - with nice options like high-res preview images, lightbox feature and advanced customization of embed options.\n\n![screenshot]\n\n| Version | Neos           | Maintained |\n| ------- | -------------- | :--------: |\n| 1.\\*    | 3.3.\\* + 4.\\*  |            |\n| 2.\\*    | ^4.2.\\* + 5.\\* |            |\n| 3.\\*    | ^4.2.\\* + \u003e= 5 |      ✓     |\n| 4.\\*    | \u003e= 5.3         |      ✓     |\n\n## Installation\n\nMost of the time, you have to make small adjustments to a package (e.g., configuration in `Settings.yaml`). Because of that, it is essential to add the corresponding package to the composer from your theme package. Mostly this is the site package located under `Packages/Sites/`. To install it correctly go to your theme package (e.g.`Packages/Sites/Foo.Bar`) and run following command:\n\n```bash\ncomposer require jonnitto/prettyembedvimeo --no-update\n```\n\nThe `--no-update` command prevent the automatic update of the dependencies. After the package was added to your theme `composer.json`, go back to the root of the Neos installation and run `composer update`. Et voilà! Your desired package is now installed correctly.\n\n## FAQ\n\n**What are the differences from the PrettyEmbed series to [Jonnitto.Plyr]?**\n\n|                                    | PrettyEmbed series |  Plyr  |\n| ---------------------------------- | :----------------: | :----: |\n| YouTube Video                      |         ✓          |   ✓    |\n| YouTube Playlist                   |         ✓          |        |\n| Vimeo                              |         ✓          |   ✓    |\n| Native Audio                       |         ✓          |   ✓    |\n| Native Video                       |         ✓          |   ✓    |\n| Advanced captions for native video |         ✓          |        |\n| Preview image                      |         ✓          |        |\n| Lightbox included                  |         ✓          |        |\n| Preview image (for videos)         |         ✓          |        |\n| Javascript API                     |                    |   ✓    |\n| Filesize (JS \u0026 CSS)                |      smaller       | bigger |\n\nAll packages from the PrettyEmbed series have the benefit of a better frontend performance since the player gets only loaded on request. So, no iframe/video gets loaded until the user wants to watch a video.\n\n## Customization\n\n### Configuration\n\n#### Global settings for the whole PrettyEmbed series\n\nSome settings will be set globally from the [PrettyEmbedHelper] package. These are the default settings:\n\n```yaml\nJonnitto:\n  PrettyEmbedHelper:\n    # If you want to use your own assets, set this to false (Backend.js and Backend.css will be always be included in the backend)\n    includeAssets:\n      css: true\n      js: true\n\n    # If you want to save the duration of YouTube videos and playlists into the\n    # property metadataDuration you have to add a API key from YouTube Data API v3\n    # You can create this key on https://console.cloud.google.com/\n    youtubeApiKey: null\n\n    # For Vimeo and Youtube you can enable here the option the show a confirm dialog\n    # that external content get loaded and the user may be tracked\n    enableGdprMessage: false\n\n    # This is the maximum width of a custom preview image\n    maximumWidth: 1920\n\n    # If this is set to a string, the element gets wrapped with a div and the class with the giving string.\n    # If set to true, the element gets wrapped with a div without any class.\n    # If set to false, the element get not wrapped at all\n    wrapper: 'jonnitto-prettyembed-wrapper'\n\n    # The buttons which get injected (file content) to the player.\n    button:\n      play: 'resource://Jonnitto.PrettyEmbedHelper/Public/Assets/PlayButton.svg'\n      pause: 'resource://Jonnitto.PrettyEmbedHelper/Public/Assets/PauseButton.svg'\n```\n\n#### Disable inclusion of the CSS and/or JS files\n\nThe Javascript and CSS files get loaded via [Sitegeist.Slipstream]:\n\nIf you want to load your own CSS, you can disable it like that:\n\n```yaml\nJonnitto:\n  PrettyEmbedHelper:\n    includeAssets:\n      css: false\n```\n\nIf you want to load your own Javascript, you can disable it like that:\n\n```yaml\nJonnitto:\n  PrettyEmbedHelper:\n    includeAssets:\n      js: false\n```\n\nIf you use SCCS in your build pipeline, you can adjust the look and feel of [`Main.scss`] with following variables:\n\n```scss\n// Buttons (play / pause)\n$prettyembed-button-play-size: 72px !default;\n$prettyembed-button-pause-size: round(\n  $prettyembed-button-play-size / 2\n) !default;\n$prettyembed-button-pause-margin: round(\n  $prettyembed-button-pause-size / 2\n) !default;\n$prettyembed-button-opacity: 0.9 !default;\n$prettyembed-button-scale: 0.8 !default;\n$prettyembed-button-scale-hover: 1 !default;\n$prettyembed-button-scale-active: 0.9 !default;\n$prettyembed-button-foreground-color: #fff !default;\n$prettyembed-button-background-color: #000 !default;\n$prettyembed-button-background-opactiy: 0.4 !default;\n\n// Lightbox\n$prettyembed-lightbox-include: true !default;\n$prettyembed-lightbox-overlay-color: #0b0b0b !default;\n$prettyembed-lightbox-overlay-opacity: 0.8 !default;\n$prettyembed-lightbox-padding: 15px !default;\n$prettyembed-lightbox-max-width: 900px !default;\n$prettyembed-lightbox-shadow: 0 0 8px rgba(#000, 0.6) !default;\n$prettyembed-lightbox-z-index: 5500 !default;\n$prettyembed-lightbox-close-size: 30px !default;\n$prettyembed-lightbox-close-opacity: 0.65 !default;\n$prettyembed-lightbox-close-opacity-hover: 1 !default;\n$prettyembed-lightbox-close-color: #fff !default;\n```\n\nBecause all variables have the `!default` flag, the variables don't get overwritten if you declare them before you import [`Main.scss`]. Like that, most of the frequent adjustments can be easily achieved.\n\n### NodeTypes and Mixins\n\nIf you want to customize the default settings, take a look at the [Settings.Jonnitto.yaml] file. If no node property is giving, these default values will be taken. If you, for example, don't want to let the editor choose if the video should open in a lightbox you can deactivate the mixin in your Configuration folder like this:\n\n```yaml\n'Jonnitto.PrettyEmbedVimeo:Content.Vimeo':\n  superTypes:\n    'Jonnitto.PrettyEmbedHelper:Mixin.Lightbox': false\n```\n\nThese are the available mixins:\n\n| Mixin name (Prefix: `Jonnitto.PrettyEmbed`) | Description                                                                 | Default value | Enabled per default |\n| ------------------------------------------- | --------------------------------------------------------------------------- | :-----------: | :-----------------: |\n| `Helper:Mixin.Groups`                       | Enables the inspector groups                                                |               |          ✓          |\n| `Helper:Mixin.Image`                        | Add the preview image property                                              |               |          ✓          |\n| `Helper:Mixin.Lightbox`                     | Open the video in a lightbox                                                |    `false`    |          ✓          |\n| `Helper:Mixin.PreserveAspectRatio`          | If the lightbox is active, the preview image can preserve his aspect ratio. |    `true`     |          ✓          |\n| `Helper:Mixin.BackendLabel`                 | Read the title of the video and set this as label in the content tree       |               |          ✓          |\n| `Vimeo:Mixin.VideoID`                       | Let the user enter the video id or vimeo url                                |               |          ✓          |\n| `Helper:Mixin.AllowFullScreen`              | Allow fullscreen or not                                                     |    `true`     |                     |\n| `Helper:Mixin.Loop`                         | Loop the video                                                              |    `false`    |                     |\n| `Helper:Mixin.Muted`                        | Whether the video is muted upon loading                                     |    `false`    |                     |\n\nIf you want to give the editor even more control, you can also add your own properties like `color`, or `background`, for example. For a full list, look at the `defaults` section in the [Settings.Jonnitto.yaml] file.\n\nIf you want to include the youtube video in your node type, you should use at least the mixin `Jonnitto.PrettyEmbedVimeo:Mixin.VideoID`. This add besides the `videoID` property also the properties for the metadata fetched from the oembed service. This mixin is also necessary to fetch/update the data from the service.\n\n### Fusion\n\nIf you want to use the player as a pure component, you can use the [`Jonnitto.PrettyEmbedVimeo:Component.Vimeo`] fusion prototype.\n\nIf you want to read the node properties and let the package handle all for you, you should use the [`Jonnitto.PrettyEmbedVimeo:Content.Vimeo`] prototype. For more comfortable including in your node types, you can disable the content element wrapping with `contentElement = false`. This is useful if you want to create, for example, a text with a video node type.\n\n## Get metadata\n\nTo get the metadata, you can run the flow command `./flow prettyembed:metadata`. This command search for nodes with the `VideoID` mixin, and tries to get the metadata. If for some reason, it is not possible to fetch the metadata (Perhaps the video is set to private, or the ID does not exist), you will get a table with the name of the node type, the type, the video ID and the node path.  \nThe task comes with two options:\n\n- `--workspace` Workspace name, default is 'live'\n- `--remove` Is set, all metadata will be removed\n\nTo get an overview of the options in the cli, you can run `./flow help prettyembed:metadata`\n\n## Update from version 1\n\nTo update from version 1, you have to run following command in your cli:  \n`./flow node:migrate --version 20190617204500`\n\nTo check the current state of the migrations, you can run  \n`./flow node:migrationstatus`\n\n[packagist]: https://packagist.org/packages/jonnitto/prettyembedvimeo\n[latest stable version]: https://poser.pugx.org/jonnitto/prettyembedvimeo/v/stable\n[total downloads]: https://poser.pugx.org/jonnitto/prettyembedvimeo/downloads\n[license]: https://poser.pugx.org/jonnitto/prettyembedvimeo/license\n[github forks]: https://img.shields.io/github/forks/jonnitto/Jonnitto.PrettyEmbedVimeo.svg?style=social\u0026label=Fork\n[donate paypal]: https://img.shields.io/badge/Donate-PayPal-yellow.svg\n[wishlist amazon]: https://img.shields.io/badge/Wishlist-Amazon-yellow.svg\n[amazon]: https://www.amazon.de/hz/wishlist/ls/2WPGORAVYF39B?\u0026sort=default\n[paypal]: https://www.paypal.me/Jonnitto/20eur\n[github stars]: https://img.shields.io/github/stars/jonnitto/Jonnitto.PrettyEmbedVimeo.svg?style=social\u0026label=Stars\n[github watchers]: https://img.shields.io/github/watchers/jonnitto/Jonnitto.PrettyEmbedVimeo.svg?style=social\u0026label=Watch\n[github followers]: https://img.shields.io/github/followers/jonnitto.svg?style=social\u0026label=Follow\n[follow jon on twitter]: https://img.shields.io/twitter/follow/jonnitto.svg?style=social\u0026label=Follow\n[twitter]: https://twitter.com/jonnitto\n[fork]: https://github.com/jonnitto/Jonnitto.PrettyEmbedVimeo/fork\n[stargazers]: https://github.com/jonnitto/Jonnitto.PrettyEmbedVimeo/stargazers\n[subscription]: https://github.com/jonnitto/Jonnitto.PrettyEmbedVimeo/subscription\n[followers]: https://github.com/jonnitto/followers\n[license]: LICENSE\n[neos cms]: https://www.neos.io\n[prettyembedhelper]: https://github.com/jonnitto/Jonnitto.PrettyEmbedHelper\n[jonnitto.plyr]: https://github.com/jonnitto/Jonnitto.Plyr\n[settings.jonnitto.yaml]: Configuration/Settings.Jonnitto.yaml\n[`jonnitto.prettyembedvimeo:component.vimeo`]: Resources/Private/Fusion/Component/Vimeo.fusion\n[`jonnitto.prettyembedvimeo:content.vimeo`]: Resources/Private/Fusion/Content/Vimeo.fusion\n[`main.scss`]: https://github.com/jonnitto/Jonnitto.PrettyEmbedHelper/blob/master/Resources/Private/Assets/Main.scss\n[screenshot]: https://user-images.githubusercontent.com/4510166/76710124-1d29d680-6705-11ea-9b6e-10c0ec9e96e4.png\n[prettyembedvideoplatforms]: https://github.com/jonnitto/Jonnitto.PrettyEmbedVideoPlatforms\n[follow these instructions]: https://github.com/jonnitto/Jonnitto.PrettyEmbedVideoPlatforms#merge-prettyembedyoutube-and-prettyembedvimeo\n[sitegeist.slipstream]: https://github.com/sitegeist/Sitegeist.Slipstream\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonnitto%2Fjonnitto.prettyembedvimeo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonnitto%2Fjonnitto.prettyembedvimeo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonnitto%2Fjonnitto.prettyembedvimeo/lists"}