Skip to main content

Social media components for Plone and Volto

Project description

plonegovbr.socialmedia

Social media components for Plone and Volto

PyPI PyPI - Python Version PyPI - Wheel PyPI - License PyPI - Status PyPI - Plone Versions

CI GitHub contributors GitHub Repo stars

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 the fb:app_id meta tag.
  • social_links: List of social media profile URLs.
  • facebook_username: Auto-calculated to populate og:article:publisher.
  • x_username: Auto-calculated to populate twitter: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:

  1. Go to the Plone Control Panel and enable the plonegovbr.socialmedia.settings behavior for your Plone Site.
  2. Edit the root object to configure social media settings.

To use the plonegovbr.socialmedia.links behavior on other content types:

  1. Go to Control Panel → Content Types.
  2. Select the content type (e.g., Event).
  3. In the Behaviors tab, enable Social Media: Links.
  4. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plonegovbr_socialmedia-2.0.0a9.tar.gz (28.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plonegovbr_socialmedia-2.0.0a9-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

Details for the file plonegovbr_socialmedia-2.0.0a9.tar.gz.

File metadata

File hashes

Hashes for plonegovbr_socialmedia-2.0.0a9.tar.gz
Algorithm Hash digest
SHA256 578f460c4fb8d44c3527dfc2905a61815a2b8f361ef86fcdc7230fd1afbfbf8f
MD5 d20b3850b76c511b76b3a0a17d0c04f4
BLAKE2b-256 2cd146792ff334dd4c07dde5d8c37136da615ebd976e44957d2569a0824b5f87

See more details on using hashes here.

File details

Details for the file plonegovbr_socialmedia-2.0.0a9-py3-none-any.whl.

File metadata

File hashes

Hashes for plonegovbr_socialmedia-2.0.0a9-py3-none-any.whl
Algorithm Hash digest
SHA256 52ecc7d9809459d02e439b0e7ed5d60a0cee2d89b3f40ac66cc02dfed2592535
MD5 39856f41f3592624b020218980d1adcb
BLAKE2b-256 8a2550989d43da8c1ca8cd3bf86c31619d3e63ca8315103c37eed99be64dc277

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page