{"id":16791850,"url":"https://github.com/posabsolute/jquery-engage","last_synced_at":"2026-01-03T14:30:54.497Z","repository":{"id":7402605,"uuid":"8732992","full_name":"posabsolute/jquery-engage","owner":"posabsolute","description":"A jQuery plugin to better engage with your blog audience","archived":false,"fork":false,"pushed_at":"2016-09-30T12:56:48.000Z","size":108,"stargazers_count":37,"open_issues_count":0,"forks_count":5,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-01-23T11:32:48.506Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/posabsolute.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-12T16:49:07.000Z","updated_at":"2023-10-06T06:05:13.000Z","dependencies_parsed_at":"2022-09-25T04:22:42.481Z","dependency_job_id":null,"html_url":"https://github.com/posabsolute/jquery-engage","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posabsolute%2Fjquery-engage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posabsolute%2Fjquery-engage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posabsolute%2Fjquery-engage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posabsolute%2Fjquery-engage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/posabsolute","download_url":"https://codeload.github.com/posabsolute/jquery-engage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243960451,"owners_count":20375101,"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":[],"created_at":"2024-10-13T08:36:00.322Z","updated_at":"2026-01-03T14:30:54.449Z","avatar_url":"https://github.com/posabsolute.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"## jQuery Engage, a better flow for blog readers\n\nThe plugin show a toolbar when a user finish reading an article containing engaging options (subscribe to newsletter, commenting \u0026 social sharing). It also include optional text for different period of the day.\n\nExample : http://www.position-absolute.com/?p=4449\n\n\n## Installation\n\nInclude the css \u0026 js.\n\n\t\u003cscript src=\"js/dist/jquery.engage.min.js\" type=\"text/javascript\"\u003e\u003c/script\u003e\n\t\u003clink rel=\"stylesheet\" type=\"text/css\" href=\"css/jquery.engage.css\"\u003e\n\n\nAfter you can instanciate the plugin on the article container:\n\n\t\u003cscript\u003e$(\".article\").engage();\u003c/script\u003e\n\n\n## Options\nThe options shown below are the current default:\n\n\t\u003cscript\u003e\n\t\t{\n            offset: 0, // change position\n            scrollhide : false // hide when the user scroll back to the top of the article\n            contents : [\"comment\",\"share\", \"newsletter\"], // content shown in the toolbar\n            newsletter : {\n            \turl : \"http://www.mailchimp.com/mylisttoken\" // url where the form will submit\n            },\n            share: :{\n            \tbuttons : ['linkedin', 'twitter', 'facebook', 'reddit'], // share links shown\n            \ttitle : document.title, // default shared title\n            \turl : location.href // default shared link\n            },\n            // text example\n            comment : {\n            \turl : \"/wp-comments-post.php\",\n\t            text : {\n\t\t            defaults : {\n\t\t                title : \"Have your say!\",\n\t\t                thanks : \"Thank you for contributing, your comment will be added shortly.\"\n\t\t            },\n\t\t            morning : {\n\t\t                title : \"Morning! Have some opinions on this article?\",\n\t\t                thanks : \"Thank you for contributing, your comment will be added shortly.\"\n\t\t            },\n\t\t            night : {\n\t\t                title : \"Have your say!\",\n\t\t                thanks : \"Thank you for contributing, your comment will be added shortly.\"\n\t\t            }\n\t\t        }\n\t\t    }\n        };\n\t\u003c/script\u003e\n\n### Offset (int)\n\nHelp you better position when the toolbar is shown, negative number are allowed. This is particulary useful when dealing with margins.\n\n\n### contents (array)\n\nContent zone shown into the toolbar by order. There is a maximum of 3 zones shown at the same time (2 or 3).  \n\n\n\n### Changing text\n\nThe plugin allow customized text depending of the time of the day, this can help you optimize users engagement by better connecting with the user.\n\nEach content type can be customized like shown above. Check all the text options in the content js file in the contents folder.\n\n## Connecting newsletter subscription to mailchimp, cakemail, etc.\n\nThe comment plugin take a url option where the form will be posted. I do not provide an ajax function for now, but there is a mailchimp wrapper included with this plugin.\n\n## Creating other content\n\nAdding other content types like bookmark or related article is easy. First add a js file in the contents folder, you can use the comment plugin as a reference, here how to namespace it.\n\n\t$.engage.contents.yourname\n\n\nWhen launching the plugin to not forget to add your content name to the options.\n\n\t\u003cscript\u003e$(\".article\").engage({contents: ['yourname','newsletter']});\u003c/script\u003e\n\n### The init(time)\n\nWhen the script load your content it will call the *init()* method.  The options are automatically passed to your plugin, you can retrieve them using *this.options*. The time (string, \"morning\", \"night\", \"default\") is given as parameter to the init function so you can use this information to better target your text.\n\nYou *must* return the parsed html content to the init function.\n\n### Events helper\n\nThere are 3 chatchable events for your plugin.\n\nengage.show // when the toolbar is shown\nengage.hide // when the toolbar is hided\nengage.destroy // when the plugin is destroyed\n\n### Adding your new content to the minified file\n\nYou can always simply add your file below the plugin in the html document like this:\n\n\t\u003cscript src=\"js/jquery.enagage.min.js\" type=\"text/javascript\" charset=\"utf-8\"\u003e\u003c/script\u003e\n\t\u003c!-- below is the google analitycs plugin --\u003e\n\t\u003cscript src=\"js/contents/name.js\" type=\"text/javascript\" charset=\"utf-8\"\u003e\u003c/script\u003e\n\nOr you can minify it using grunt, first *load npm install* to install dependencies, then just do grunt and it's all automatic. You must comply with jslint before a compilation is completed. If that sound complicated please check gruntjs, it should be simple to pick it up from there.\n\n\n## License (MIT)\n\nCopyright 2013 Cedric Dugas\nhttp://me.position-absolute.com\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fposabsolute%2Fjquery-engage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fposabsolute%2Fjquery-engage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fposabsolute%2Fjquery-engage/lists"}