silverware / social
SilverWare Social Module.
Installs: 177
Dependents: 4
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 2
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- php: >=5.6.0
- silverware/silverware: ^1.0
README
Provides a sharing component for use with SilverWare, allowing pages to be shared via a series of sharing buttons for social media services.
Contents
Requirements
Installation
Installation is via Composer:
$ composer require silverware/social
Configuration
As with all SilverStripe modules, configuration is via YAML. Page settings for sharing are applied
using the included PageExtension
class, allowing sharing to be disabled for certain pages.
Usage
This module provides a SharingComponent
which can be added to a SilverWare template
or layout using the CMS. A SharingComponent
renders a series of social media sharing buttons for
the current page, allowing the user to easily share the page with others.
Included with the repository is SharingButton
, which forms a base class from which to extend sharing button
implementations, and EmailSharingButton
which renders a button for sharing the current page via
email.
Buttons can be added and removed using the site tree as children of SharingComponent
.
Disabling Sharing
After installation, this module adds a "Sharing" section to the Settings tab for pages, with a
"Sharing disabled" checkbox. Simply check this box for a particular page, and the sharing component
will not be shown. By default, sharing is disabled for ErrorPage
instances.
Issues
Please use the GitHub issue tracker for bug reports and feature requests.
Contribution
Your contributions are gladly welcomed to help make this project better. Please see contributing for more information.
Maintainers
License
BSD-3-Clause © Praxis Interactive