rtcamp/wp-partytown

Add partytown support to WordPress sites.

WP Partytown

This plugin is a POC for ticket #176 in WordPress/performance repo.

Goals

1. Allow plugin developers to execute scripts inside a Partytown Web Worker.
2. Allow site admins to select which scripts they want to execute inside a Partytown Web Worker.

Proposal and Working of Plugin

1. Scripts with dependency as partytown will be executed inside a Web Worker.

Create a function to enqueue scripts with dependency as partytown and it will add partytown support to the script by appending the type="text/partytown" attribute.

wp_enqueue_script(
  'non-critical-script',
  plugins_url( 'non-critical-script.js', __FILE__ ),
  array('partytown'),
  '1.0.0'
);

Output:

// Loaded in Partytown Web Worker
<script type="text/partytown" src="/wp-content/plugins/labs/non-critical-script.js?ver=1.0.0"></script>

2. Expose a filter to allow plugins to configure partytown

By default Partytown does not require a config for it to work, however, a config can be set to change the defaults. At the lowest level, it’s configured by setting the window.partytown = {...} object before the Partytown snippet script.

function my_plugin_partytown_config( $config ) {
  $config["debug"] = true;
  return $config;
}
add_filter( 'partytown_configuration', 'my_plugin_partytown_config' );

<script>
    window.partytown = {
        debug: true
    };
</script>

3. Show option to enable/disable partytown on Website

To get started with Partytown on a website, you need to add a script partytown.js to your website. While the partytown.js file could be an external request, it’s recommended to inline the script instead.

Showing an option to enable it ensures that script should be included only when needed.

wp-partytown's Issues

Add workflow to update partytown lib files

Update partytown files once a new release is published.

The plugin usage

Hello
I installed the plugin and enabled on a WordPress website, I need your help a small tutorial, How to use it.
For example :
For
https://mydomain.com/wp-content/plugins/woocommerce/assets/js/frontend/add-to-cart.min.js

At the end of Functions.php file of active theme i add the following code?

wp_enqueue_script(
'non-critical-script',
plugins_url( 'add-to-cart.min.js', FILE ),
array('partytown'),
'1.0.0'
);

Right?

Console error after plugin setup

@thelovekesh The plugin looks great! I have a problem setting up the plugin. I activated the plugin and I'm seeing an error. I didn't enqueue any script for Partytown yet. Is this a bug in the plugin or Partytown? Maybe it's on my end?

Here are some screenshots:

Enable @dependabot

• Add @dependabot config to keep dependencies up-to-date

Duplicated script type

Hi
I face duplicate script type when i enable partytown for a specific js script

script type="text/partytown" type='text/javascript' ....

The script is outside Plugins and i am using this code in active theme functions.php

function wpb_adding_scripts() {
wp_register_script('my_amazing_script', get_template_directory_uri() . '/js/scripts/combine.min.js', array('partytown'),'1.0.0', true);
wp_enqueue_script('my_amazing_script');
}
add_action( 'wp_enqueue_scripts', 'wpb_adding_scripts' );

minified js

Hi
As i noticed partytown not working when i try it for Minified Javascripts ( *.min.js ) files, Do you confirm?

#176 in WordPress/performance

cc: @maitreyie-chavan

Is PartyTown running and perfectly configure in my website?

I'm just following a minimum tutorials and few sample config available on the internet. The documentation so minimal and need more step by step tutorial to be able to running in WordPress.

but, after many attempt, I think PartyTown is running on my website, is it right?

Please consider give explanation about my screenshot, bcs I don't know exactly. There are bunch of proxytown i saw in network tab.

Partytown js on a WordPress site https://unej.ac.id/