Easily integrate social sharing buttons into your web pages with socialite-share
. This library offers a straightforward way to add share buttons for popular social media platforms and a QR code option for sharing URLs.
- Easy Integration: Quickly add social sharing buttons with a few lines of JavaScript.
- Customizable: Choose which platforms to include and customize the appearance.
- QR Code Sharing: Option to generate a QR code for easy URL sharing.
- No Dependencies: Works standalone, without the need for jQuery or other libraries.
- Callback Support: Implement custom behavior on share actions with callbacks.
You can install socialite-share
via npm:
npm install socialite-share
First, ensure you include socialite-share
in your project:
import SocialiteShare from 'socialite-share';
Then, initialize socialite-share
with your desired options:
new SocialiteShare({
selector: '#share-buttons', // The selector for the container where the buttons will be rendered
platforms: ['facebook', 'twitter', 'linkedin', 'whatsapp'], // Platforms to include
urlToShare: 'https://example.com', // The URL to share
qrCode: true, // Enable QR code sharing
onSuccess: () => console.log("Share successful!"), // Optional success callback
onError: (error) => console.error("Share failed", error) // Optional error callback
});
-
selector
: CSS selector for the container where the buttons will be added. -
platforms
: Array of strings indicating which platforms' share buttons to include. Supported platforms are 'facebook', 'twitter', 'linkedin', and 'whatsapp'. -
urlToShare
: The URL that will be shared when using the share buttons. -
qrCode
: Boolean to enable or disable QR code sharing functionality. -
onSuccess
: Optional callback function that executes after a successful share action. -
onError
: Optional callback function that executes if there is an error in the sharing process.
The appearance of the share buttons can be customized with CSS. Each button has a class following the pattern socialite-[platform]
, where [platform]
is the name of the social media platform (e.g., socialite-facebook
).
Contributions are welcome! If you'd like to contribute, please fork the repository and submit a pull request.
MIT