{"id":19169876,"url":"https://github.com/yshyshkin/orocommerceelfsightbundle","last_synced_at":"2025-09-04T04:06:45.332Z","repository":{"id":68556554,"uuid":"599015005","full_name":"yshyshkin/OroCommerceElfsightBundle","owner":"yshyshkin","description":"The bundle adds integration with the Elfsight widget provider and puts multiple content blocks into strategic places all over the application storefront. Now developers can add custom forms, subscription forms, live chats, various popups, countdown timers, social feeds, and many other types of widgets to the storefront.","archived":false,"fork":false,"pushed_at":"2024-07-11T09:50:07.000Z","size":4416,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"6.0","last_synced_at":"2025-04-19T16:19:23.841Z","etag":null,"topics":["cms","elfsight","orocommerce","widget"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yshyshkin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"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":{"custom":["https://paypal.me/yshyshkin"]}},"created_at":"2023-02-08T09:21:06.000Z","updated_at":"2024-07-11T09:48:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"53b5e107-4f1f-4f7f-a588-13009ffd6e71","html_url":"https://github.com/yshyshkin/OroCommerceElfsightBundle","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yshyshkin%2FOroCommerceElfsightBundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yshyshkin%2FOroCommerceElfsightBundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yshyshkin%2FOroCommerceElfsightBundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yshyshkin%2FOroCommerceElfsightBundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yshyshkin","download_url":"https://codeload.github.com/yshyshkin/OroCommerceElfsightBundle/tar.gz/refs/heads/6.0","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252902614,"owners_count":21822261,"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":["cms","elfsight","orocommerce","widget"],"created_at":"2024-11-09T09:51:38.296Z","updated_at":"2025-05-07T15:10:31.365Z","avatar_url":"https://github.com/yshyshkin.png","language":"PHP","funding_links":["https://paypal.me/yshyshkin"],"categories":[],"sub_categories":[],"readme":"# OroCommerce Elfsight Bundle\n\nThe bundle adds integration with the [Elfsight](https://go.elfsight.io/click?pid=233\u0026offer_id=3) widget provider \nand adds multiple content blocks into strategic places all over the application storefront. \n\nNow developers can add custom forms, subscription forms, live chats, various popups, countdown timers, social feeds, \nand many other types of widgets to the storefront.\n\n* [Widget Types](#widget-types)\n    * [Form Builder](#form-builder)\n    * [Subscription Form](#subscription-form)\n    * [Live Chat](#live-chat)\n    * [Popup](#popup)\n    * [Countdown Timer](#countdown-timer)\n    * [Social Feed](#social-feed)\n    * [Other Widgets](#other-widgets)\n* [Content Blocks](#content-blocks)\n    * [All Pages](#all-pages)\n    * [Home Page](#home-page)\n    * [Search Results Page](#search-results-page)\n    * [Product Listing Page](#product-listing-page)\n    * [Product Details Page](#product-details-page)\n    * [Quick Order Form Page](#quick-order-form-page)\n    * [Shopping List Page](#shopping-list-page)\n    * [Checkout Page](#checkout-page)\n* [How To Install The Bundle](#how-to-install-the-bundle)\n* [How To Add Widgets](#how-to-add-widgets)\n    * [Registration](#registration)\n    * [Create New Widget](#create-new-widget)\n    * [Add The Widget](#add-the-widget)\n* [How To Thank The Author](#how-to-thank-the-author)\n\n\n## Widget Types\n\nHere are the most popular widget types used in Ecommerce that you can add \nthrough this integration.\n\n### Form Builder\n\n[Form builder widget](https://go.elfsight.io/click?pid=233\u0026offer_id=3\u0026l=1677843053) can help you to build a completely \ncustom form from scratch, collect the data, send email notifications, analyze the data, and many other things.\n\n![Form Builder Example](Resources/doc/img/form_builder_example.png)\n\n### Subscription Form\n\n[Subscription form widget](https://elfsight.com/subscription-form-widget/) lets you collect emails of people\nwho want to be notified when something happens.\n\n![Subscription Form Example](Resources/doc/img/email_subsription_example.png)\n\n### Live Chat\n\n[All-in-one chat widget](https://go.elfsight.io/click?pid=233\u0026offer_id=3\u0026l=1677841093) allows you to talk \nto your customers in real-time  and assist them when they need help.\n\n![Live Chat Example](Resources/doc/img/live_chat_example.png)\n\n### Popup\n\n[Popup widget](https://elfsight.com/banner-widget/) shows a banner with your marketing materials.\nIt is a great tool to notify your customers about events or just say hello.\n\n![Popup Example](Resources/doc/img/popup_example.png)\n\n### Countdown Timer\n\n[Countdown widget](https://go.elfsight.io/click?pid=233\u0026offer_id=3\u0026l=1677841108) helps you to let customers \nhow much time is left till something important is going to happen.\n\n![Countdown Example](Resources/doc/img/countdown_example.png)\n\n### Social Feed\n\n[Social feed widget](https://go.elfsight.io/click?pid=233\u0026offer_id=3\u0026l=1677843061) aggregates news \nfrom your social networks and shows them in a nice convenient form.\n\n![Social Feed Example](Resources/doc/img/social_feed_example.png)\n\n### Other Widgets\n\nThere are many other widget types that you can add to your website. \nCheck the [full list of widgets](https://elfsight.com/widgets/) and find the best widget for you.\n\n\n## Content Blocks\n\nBy default, you can add Elfsight widgets to any place that supports content widgets: landing pages, product or category \ndescriptions, and predefined content blocks.\n\nThis bundle adds new content blocks to different pages all over the application storefront, so you can add Elfsight \nwidgets to any of that blocks. Some Elfsight widgets that are always presented on the screen (e.g. live chat, popup) \ncan be added to any block. Other widgets that have to be added to the right place on the page (e.g. forms, social feeds) \nshould be added to the right content block.\n\nHere are all pages with new content blocks added to them.\n\n### All Pages\n\n* `placeholder-general-header-before` added before the header;\n* `placeholder-general-header-after` added after the header;\n* `placeholder-general-menu-after` added after the main menu;\n* `placeholder-general-footer-before` added before the footer;\n* `placeholder-general-footer-after` added after the footer.\n\n![General Placeholders](Resources/doc/img/placeholders_general.png)\n\n### Home Page\n\n* `placeholder-home-content-before` added before the home page content;\n* `placeholder-home-content-after` added after the home page content.\n\n![Home Page Placeholders](Resources/doc/img/placeholders_home_page.png)\n\n### Search Results Page\n\n* `placeholder-search-content-before` added before the search results grid;\n* `placeholder-search-content-after` added after the search results grid.\n\n![Search Results Page Placeholders](Resources/doc/img/placeholders_search_results.png)\n\n### Product Listing Page\n\n* `placeholder-plp-content-before` added before the products grid;\n* `placeholder-plp-content-after` added after the products grid.\n\n![Product Listing Page Placeholders](Resources/doc/img/placeholders_plp.png)\n\n### Product Details Page\n\n* `placeholder-pdp-content-before` added before the product details block;\n* `placeholder-pdp-content-after` added after the product details block.\n\n![Product Details Page Placeholders](Resources/doc/img/placeholders_pdp.png)\n\n### Quick Order Form Page\n\n* `placeholder-qof-content-before` added before the quick order form;\n* `placeholder-qof-content-after` added after the quick order form.\n\n![Quick Order Form Placeholders](Resources/doc/img/placeholders_qof.png)\n\n### Shopping List Page\n\n* `placeholder-sl-content-before` added before the shopping list content;\n* `placeholder-sl-content-after` added after the shopping list content.\n\n![Shopping List Placeholders](Resources/doc/img/placeholders_sl.png)\n\n### Checkout Page\n\n* `placeholder-checkout-content-before` added before the checkout content;\n* `placeholder-checkout-content-after` added after the checkout content.\n\n![Shopping List Placeholders](Resources/doc/img/placeholders_checkout.png)\n\n\n## How To Install The Bundle\n\nIf you did not install the application yet, you just need to add the bundle as the composer dependency, and then\ninstall the application.\n\n```\ncomposer require ys-tools/orocommerce-elfsight-bundle\n```\n\nIf you already have installed the application, you need to add the bundle as the composer dependency, remove the cache, \nand upgrade the application.\n\n```\nrm -rf var/cache/prod\ncomposer require ys-tools/orocommerce-elfsight-bundle\nrm -rf var/cache/prod\nbin/console oro:platform:update --force --env=prod\n```\n\n\n## How To Add Widgets\n\nHere is the [video that demonstrates how to add widgets](https://www.youtube.com/watch?v=tSCyaRgmEdI). All required steps are described below. \n\n### Registration\n\nThe first thing you need to do before using Elfsight widgets is to register in the Elfsight portal. You need to open \nthe list of content widgets under `Marketing \u003e Content Widgets` and click the green button \n`Sign Up | Log In to Elfsight`.\n\n![Registration Button](Resources/doc/img/registration_button.png)\n\nYou will be redirected to the Elfsight website, there you can either enter your email and register manually, or click \nthe `Sign Up Free` button in the top right corner and sign up manually, via Google or Facebook.\n\n![Elfsight Home Page](Resources/doc/img/elfsight_home_page.png)\n\n![Elfsight Sign Up](Resources/doc/img/elfsight_sign_up.png)\n\nThen you should go back to the OroCommerce application and open the list of content widgets under \n`Marketing \u003e Content Widgets` again. The sign op button should disappear, and you'll see a new button \n`Manage Elfsight Widgets`. You can use it to get back to the Elfsight website and manage all your widgets and \nsubscriptions there.\n\n![Elfsight Apps](Resources/doc/img/manage_widgets_button.png)\n\n![Elfsight Apps](Resources/doc/img/elfsight_apps.png)\n\n### Create New Widget\n\nThe next step is adding a new Elfsight widget. You need to click `Create Content Widget` button, pick `Elfsight Widget` \ntype from the dropdown, give the widget a name, and then click on the plus icon near the `Elfsight Widget` field \nin the `Options` section.\n\n![Create Widget Button](Resources/doc/img/create_widget_button.png)\n\nYou should see a popup with a list of all available widget types. Find the one you want to use and click on it.\n\n![Create Widget Popup](Resources/doc/img/create_widget_popup.png)\n\nThe application should open another popup where you can configure your widget. After you finish the configuration,\nclick `Add to Website` or `Save` button.\n\n![Elfsight Create Countdown](Resources/doc/img/elfsight_create_countdown.png)\n\nThe popup will be closed, and you should see the identifier of your new widget in the `Elfsight Widget` field. \nYou can edit your widget or remove the identifier using appropriate buttons near the `Elfsight Widget` field. \nFinally, you need to save the new content widget by clicking the `Save and Close` button.\n\n![Create Widget Identifier](Resources/doc/img/create_widget_identifier.png)\n\n### Add The Widget\n\nNow, you can add your new content widget to any place that supports content blocks. For example, if you want it to\nalways be presented in the application header you can use `placeholder-general-header-after` content block. You need to\nopen the list of content blocks under `Marketing \u003e Content Blocks`, find the required content block, edit it, and add\nnew content widget to this block.\n\n![Add Block Backend](Resources/doc/img/add_block_backend.png)\n\nThen you have to save this content block, go to the storefront, and verify that the new widget is properly rendered \nin the header.\n\n![Add Block frontend](Resources/doc/img/add_block_frontend.png)\n\n\n## How To Thank The Author\n\nIf this bundle helped you and you are feeling generous today, then you can thank the author\nand support this initiative using one of the following buttons.\n\n[![Support](https://raster.shields.io/badge/Support-PayPal-blue.png)](https://paypal.me/yshyshkin)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyshyshkin%2Forocommerceelfsightbundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyshyshkin%2Forocommerceelfsightbundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyshyshkin%2Forocommerceelfsightbundle/lists"}