heise.rocks/kirby-social-media-links

Social media integration for kirby.

1.0.1 2024-03-27 13:37 UTC

This package is auto-updated.

Last update: 2024-05-22 19:47:08 UTC


README

banner

Setup

Add the socialMediaTab: social_media_entries tab to your site.yml blueprint.

Example:

title: Site

tabs:
  content:
    label:
      en: Content
      de: Inhalt
    icon: text
    sections:
      pages:
        type: pages
      files:
        type: files
  socialMediaTab: social_media_entries

Blueprint usage

Add socialMedia: social_media_links to a blueprint to use social links based on this plugin for a field.

Example:

person:
  label:
    en: Person
    de: Person
  type: structure
  fields:
    name:
      label:
        en: Person name
        de: Name der Person
      type: text
      width: 1/2
      required: true
    socialMedia: social_media_links

Snippet usage

<?php snippet('social_media_entries'); ?>

Variables

Variable Default Description
containerClasses '' (String) Classes that are applied to the ul container.
containerId '' (String) ID that is applied to the container.
itemClasses '' (String) Classes that are applied to the li element.
linkClasses '' (String) Classes that are applied to the a element.
iconClasses '' (String) Classes that are applied to the svg element.
items $site->socialMediaLinks()->toStructure() (Kirby Structure) Social Media Entries to be used. Has to be resolved to Kirby Structure via toStructure(). Defaults to site-wide definition of social media entries when left empty.

screenshot