Skip to content

README.md

Latest commit

 

History

History
134 lines (96 loc) · 4.24 KB

README.md

File metadata and controls

134 lines (96 loc) · 4.24 KB

Stability Nexus

 

Static Badge

Telegram Badge    X (formerly Twitter) Badge    Discord Badge    Medium Badge    LinkedIn Badge    Youtube Badge

SocialShareButton

Lightweight social sharing component for web applications. Zero dependencies, framework-agnostic.

npm version License: GPL v3

Features

  • 🌐 Multiple platforms: WhatsApp, Facebook, X, LinkedIn, Telegram, Reddit, Email
  • 🎯 Zero dependencies - pure vanilla JavaScript
  • ⚛️ Framework support: React, Next.js, Vue, Angular, or plain HTML
  • 🔄 Auto-detects current URL and page title
  • 📱 Fully responsive and mobile-ready
  • 🎨 Customizable themes (dark/light)
  • ⚡ Lightweight (< 10KB gzipped)

Installation

Via CDN (Recommended)

<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/AOSSIE-Org/SocialShareButton@v1.0.3/src/social-share-button.css">
<script src="https://cdn.jsdelivr.net/gh/AOSSIE-Org/SocialShareButton@v1.0.3/src/social-share-button.js"></script>

Via npm

npm install social-share-button-aossie

Quick Start

new SocialShareButton({
  container: '#share-button'
});

Add this HTML element:

<div id="share-button"></div>

Full Documentation

For framework-specific guides, configuration options, customization, and troubleshooting, visit the complete documentation in the /docs directory.

Contributing

We welcome contributions of all kinds! To contribute:

  1. Fork the repository and create your feature branch (git checkout -b feature/AmazingFeature).
  2. Commit your changes (git commit -m 'Add some AmazingFeature').
  3. Test your changes by opening index.html in your browser to verify functionality.
  4. Push your branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request for review.

If you encounter bugs, need help, or have feature requests:

  • Please open an issue in this repository providing detailed information.
  • Describe the problem clearly and include any relevant logs or screenshots.

We appreciate your feedback and contributions!

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.