https://github.com/markjaquith/encute
WordPress plugin for fluent management of scripts and styles.
https://github.com/markjaquith/encute
Last synced: about 1 year ago
JSON representation
WordPress plugin for fluent management of scripts and styles.
- Host: GitHub
- URL: https://github.com/markjaquith/encute
- Owner: markjaquith
- License: gpl-2.0
- Created: 2021-10-07T15:45:29.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-17T20:28:35.000Z (over 4 years ago)
- Last Synced: 2025-04-17T14:42:48.306Z (about 1 year ago)
- Language: PHP
- Size: 1.9 MB
- Stars: 107
- Watchers: 8
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Encute
WordPress plugin for fluent management of scripts and styles.
Managing scripts and styles on the front of your site can be tricky. This makes it trivial to do stuff like:
- Shove a script (and its entire connected family) into the footer
- Defer a script or a style until page load
- Load a script `async`
- Mark a script as `type="module"`
- Mark a script as `nomodule`
- Remove some plugin script or style you don't need
## Installation
If you're using composer you can `composer require markjaquith/encute`. Else, install via Git.
## Usage
Put this in an `mu-plugins` drop-in:
```php
debug(); // Optional: Adds HTML comments to scripts and styles, making it easier to see the handle.
// Move jQuery to footer and defer its loading.
Script::get('jquery')->footer()->defer();
// Move 'some-handle' to the footer.
Script::get('some-handle')->footer();
// Defer 'wp-embed'.
Script::get('wp-embed')->defer();
// Make 'some-module' load as a module.
Script::get('some-module')->module();
// Make 'nomodule-fallback' load as nomodule.
Script::get('nomodule-fallback')->noModule();
// Move 'admin-bar' styles to the footer and defer their loading.
Style::get('admin-bar')->footer()->defer();
// Move 'wp-block-library' styles to the footer.
Style::get('wp-block-library')->footer();
// Keep 'contact-form-7' style on contact page only.
Style::get('contact-form-7')->keepIf(fn() => is_page('contact'));
// Remove 'cruft' script on the about page.
Script::get('cruft')->removeIf(fn() => is_page('about'));
});
```
## API
### Initialization
Always run code in this wrapper:
```php
add_action(\CWS\Encute\Plugin::class, function (\CWS\Encute\Plugin $encute) {
// Your code here.
});
```
This wrapper will be a no-op if Encute is not available, and it will both wait for Encute to be available to run, and pass you Encute's main class instance.
### Fluency
`Script::get()` and `Style::get()` return an instance of themselves, as do all calls to their methods, so you can just chain your calls.
### Script
- `static CWS\Encute\Script::get(string $handle): CWS\Encute\Script` — get a Script instance for that handle.
- `CWS\Encute\Script::module(): CWS\Encute\Script` — make the script a module.
- `CWS\Encute\Script::noModule(): CWS\Encute\Script` — make the script nomodule.
- `CWS\Encute\Script::footer(): CWS\Encute\Script` — send the script to the footer (along with its entire dependency family).
- `CWS\Encute\Script::async(): CWS\Encute\Script` — make the script async.
- `CWS\Encute\Script::defer(): CWS\Encute\Script` — make the script defer.
- `CWS\Encute\Script::remove(): CWS\Encute\Script` — remove the script.
- `CWS\Encute\Script::removeIf(callable $callback): CWS\Encute\Script` — remove the script if the callback resolves as true.
- `CWS\Encute\Script::keepIf(callable $callback): CWS\Encute\Script` — keep the script if the callback resolves as true (else remove it).
### Style
- `static CWS\Encute\Style::get(string $handle): CWS\Encute\Style` — get a Style instance for that handle.
- `CWS\Encute\Style::footer(): CWS\Encute\Style` — send the style to the footer (along with its entire dependency family).
- `CWS\Encute\Style::defer(): CWS\Encute\Style` — defer the style's loading.
- `CWS\Encute\Style::remove(): CWS\Encute\Style` — remove the style.
- `CWS\Encute\Style::removeIf(callable $callback): CWS\Encute\Style` — remove the style if the callback resolves as true.
- `CWS\Encute\Style::keepIf(callable $callback): CWS\Encute\Style` — keep the style if the callback resolves as true (else remove it).