Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom social link icons and use variations #59368

Draft
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

gaambo
Copy link
Contributor

@gaambo gaambo commented Feb 26, 2024

What?

This PR changes the social-link block to use the variations icon/label in the editor and adds a PHP filter to adding custom social services.
It's similar to ndiegos social sharing link block.

Why?

  • add custom icons - maybe for social networks that are regional and not globally available or just a niche
  • core doesn't have to provide all possible icons there are
  • change icons to fit the style of the website
  • have a good editing experience = show the same icon in the editor as on the frontend

Related discussions/PR:
#19041
#39419
#30749
#39868
#55142

How?

  • use active variation data in editor (variations already have an icon + label defined)
  • add filter in php to allow adding services there ( + cache them since they can be called multiple times)

TODO

  • Currently the filter name gets prefixed with gutenberg_ in the build process and I don't know why.
  • make changes in edit.native.js

Testing Instructions

Existing social blocks

  1. Add a social links block
  2. Add a facebook link block and see the facebook logo being used in the editor + on the frontend

Custom social icons

In a custom plugin/theme

  1. Register a variation with an icon in the editor. Dashicon-Slugs as well as SVG Icon Components (eg from @wordpress/icons) can be used:
registerBlockVariation("core/social-link", {
  name: "custom-social-service-2",
  title: "Custom Social Service 2",
  description: "A link to a custom social service with a custom SVG icon",
  icon: createElement(
    SVG,
    {
      viewBox: "0 0 24 24",
      xmlns: "http://www.w3.org/2000/svg",
      "aria-hidden": "true",
      focusable: "false",
    },
    createElement(Path, {
      d: "M18 4H6c-1.1 0-2 .9-2 2v12.9c0 .6.5 1.1 1.1 1.1.3 0 .5-.1.8-.3L8.5 17H18c1.1 0 2-.9 2-2V6c0-1.1-.9-2-2-2zm.5 11c0 .3-.2.5-.5.5H7.9l-2.4 2.4V6c0-.3.2-.5.5-.5h12c.3 0 .5.2.5.5v9z",
    })
  ),
  attributes: {
    service: "custom-social-service-2",
  },
  isActive: ["service"],
});
  • test existing social blocks
  • test cusotm social blocks with plugin
  1. Open Editor and add the custom social service to a social links block. The Dashicon for post-format (a speech-bubble) should be shown
  2. Add PHP for the frontend:
add_action('enqueue_block_editor_assets', function () {
    wp_enqueue_script(
        'social-link-variation',
        plugins_url('index.js', __FILE__),
        ['wp-element', 'wp-primitives', 'wp-blocks', 'wp-components'],
        filemtime(plugin_dir_path(__FILE__, 'index.js')),
    );
});

function my_add_custom_social_link_data($services_data)
{
    $services_data['custom-social-service'] = [
        'name' => 'Custom Social Service',
        'icon' => '<span class="dashicons dashicons-format-status"></span>'
    ];
    $services_data['custom-social-service-2'] = [
        'name' => 'Custom Social Service 2',
        'icon' => '<svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false"><path d="M18 4H6c-1.1 0-2 .9-2 2v12.9c0 .6.5 1.1 1.1 1.1.3 0 .5-.1.8-.3L8.5 17H18c1.1 0 2-.9 2-2V6c0-1.1-.9-2-2-2zm.5 11c0 .3-.2.5-.5.5H7.9l-2.4 2.4V6c0-.3.2-.5.5-.5h12c.3 0 .5.2.5.5v9z"></path></svg>'
    ];
    return $services_data;
}

add_filter('gutenberg_block_core_social_link_services', 'my_add_custom_social_link_data');
add_filter('block_core_social_link_services', 'my_add_custom_social_link_data');
  1. View post/page on the frontend, the icon should be displayed on the frontend as well.

Testing Instructions for Keyboard

Screenshots or screencast

@Mamaduka
Copy link
Member

This probably would be easier to implement after register_block_variation is added to the Gutenberg/core - #47170 (comment).

@skorasaurus skorasaurus added the [Block] Social Affects the Social Block - used to display Social Media accounts label Mar 11, 2024
Copy link

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
  • Labels found: [Block] Social.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Social Affects the Social Block - used to display Social Media accounts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants