{"id":17035890,"url":"https://github.com/christophery/good-share","last_synced_at":"2025-04-12T13:14:07.163Z","repository":{"id":38976760,"uuid":"196599074","full_name":"christophery/good-share","owner":"christophery","description":"Good Share is a share button library with Web Share API integration.","archived":false,"fork":false,"pushed_at":"2023-03-01T14:07:01.000Z","size":1611,"stargazers_count":11,"open_issues_count":7,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T13:14:01.539Z","etag":null,"topics":["javascript","share","share-buttons","web-share","web-share-api"],"latest_commit_sha":null,"homepage":"https://chrisyee.ca/good-share/","language":"JavaScript","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/christophery.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-12T15:03:16.000Z","updated_at":"2025-04-01T13:23:21.000Z","dependencies_parsed_at":"2023-01-25T15:46:21.992Z","dependency_job_id":null,"html_url":"https://github.com/christophery/good-share","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christophery%2Fgood-share","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christophery%2Fgood-share/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christophery%2Fgood-share/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christophery%2Fgood-share/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/christophery","download_url":"https://codeload.github.com/christophery/good-share/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248571842,"owners_count":21126522,"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":["javascript","share","share-buttons","web-share","web-share-api"],"created_at":"2024-10-14T08:48:28.475Z","updated_at":"2025-04-12T13:14:07.140Z","avatar_url":"https://github.com/christophery.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Good Share\n\nGood Share is a share button library with [Web Share API](https://css-tricks.com/how-to-use-the-web-share-api/) integration.\n\nUsing the Web Share API, it allows the user to share content using the native share dialog on [supported browsers](https://caniuse.com/#feat=web-share). \n\nFor unsupported browsers, a fallback modal window with sharing buttons can be used by the user.\n\nFeel free to [let me know](https://twitter.com/cmyee) if you use Good Share in one of your websites.\n\n[View Demo](https://chrisyee.ca/good-share/) | [Download](https://github.com/christophery/good-share/releases/latest)\n\n## Features\n- Web Share API for native share\n- Fallback modal for [unsupported browsers](https://caniuse.com/#feat=web-share)\n- Multiple share buttons\n- Uses CSS animations\n- Fallback modal closes when the site overlay is selected\n- Keyboard support for closing fallback modal (esc key)\n- Supports [Open Graph Metadata](https://ogp.me/)\n\n## Requirements\n- Your website must be served over [HTTPS](https://www.cloudflare.com/learning/ssl/what-is-https/)\n- Sharing can only be triggered by a user action (click or touch)\n\n## Getting Started\n\n- Include the CSS and JS files from the `dist/` folder.\n\n```html\n\u003clink rel=\"stylesheet\" href=\"css/good-share.min.css\"\u003e\n```\n\n```html\n\u003cscript src=\"js/good-share.min.js\"\u003e\u003c/script\u003e\n```\n\n- Add the `.good-share` CSS class to your share buttons along with the [data attribute options](#options).\n\n```html\n\u003cbutton class=\"good-share\" data-share-title=\"Hello World\" data-share-url=\"https://chrisyee.ca\"\u003e\n  Share This\n\u003c/button\u003e\n```\n\n## Options\n\n### data-share-title\nThe title to be shared.\n\n``data-share-title=\"Hello World\"``\n\n### data-share-text\nThe text to be shared.\n\n``data-share-text=\"Lorem ipsum dolor sit amet\"``\n\n### data-share-url\nThe URL to be shared.\n\n``data-share-url=\"https://chrisyee.ca\"``\n\n\n## Development\nGood Share CSS and JS are compiled and minified using Gulp. You'll need [Node](https://nodejs.org/en/) and [Gulp](https://gulpjs.com/) installed globally.\n\n**From the root directory run:**\n\n```\n$ npm install\n$ gulp\n```\n\nNow you can edit `css/good-share.scss` and `js/good-share.js`, which will be compiled to `dist/` automatically.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristophery%2Fgood-share","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchristophery%2Fgood-share","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristophery%2Fgood-share/lists"}