Social media components for Plone and Volto
Project description
plonegovbr.socialmedia
Social media components for Plone and Volto
Overview 📚
plonegovbr.socialmedia provides behaviors for managing social media metadata and links in Plone sites.
It can be used both with the Volto frontend.
Features ✨
This package provides two Dexterity behaviors:
plonegovbr.socialmedia.settings
Designed for navigation root objects (e.g., the Plone Site itself), it replaces the classic Social Media control panel, providing:
share_social_data: Enable/disable sharing social metadata for content.facebook_app_id: Populate thefb:app_idmeta tag.social_links: List of social media profile URLs.facebook_username: Auto-calculated to populateog:article:publisher.x_username: Auto-calculated to populatetwitter:site.
plonegovbr.socialmedia.links
Designed for content types that require listing social network profiles (e.g., Speaker Profiles on a conference site).
social_links: List of social media profile URLs.
Installation 🛠️
Add plonegovbr.socialmedia to your project dependencies.
Using setup.py 🐍
In your setup.py:
install_requires = [
...
"plonegovbr.socialmedia",
]
Then install:
pip install -e .
Using pyproject.toml 📜
In your pyproject.toml:
dependencies = [
...
"plonegovbr.socialmedia",
]
Then install:
pip install .
Usage 📖
After installation:
- Go to the Plone Control Panel and enable the
plonegovbr.socialmedia.settingsbehavior for your Plone Site. - Edit the root object to configure social media settings.
To use the plonegovbr.socialmedia.links behavior on other content types:
- Go to Control Panel → Content Types.
- Select the content type (e.g., Event).
- In the Behaviors tab, enable Social Media: Links.
- Save the changes.
Volto Support ⚡
For Volto frontend integration, install @plonegovbr/social-media in your Volto project.
This package provides Volto widgets that integrate seamlessly with the fields provided by plonegovbr.socialmedia.
pnpm add @plonegovbr/social-media
# or
npm install @plonegovbr/social-media
Compatibility ✅
- Plone: 6.1+
- Python: 3.10+
- Volto: 18+
Contributing 🤝
Contributions are welcome!
Before submitting a pull request, please make sure your code passes tests and follows project guidelines.
License 📜
This project is licensed under the GPLv2.
Credits & Acknowledgements 🙏
Maintained by the PloneGov-Br Community 🇧🇷❤️.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters