Download the PHP package pinkcrab/elm-mount without Composer
On this page you can find all versions of the php package pinkcrab/elm-mount. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package elm-mount
PinkCrab ElmMount
Mount compiled Elm apps into WordPress admin pages, shortcodes and other surfaces. Handles the enqueue, the localized flags blob, and the REST nonce. Bundling your Elm is your job — this package takes the compiled .js and wires it into WordPress.
Part of a three-package set:
| Role | Package |
|---|---|
| PHP mount helper (this package) | pinkcrab/elm-mount |
| JS bootstrap | @pinkcrab/elm-wp-bootstrap |
| Elm package | Pink-Crab/elm-wp |
Install
Usage
Build an Elm_App once with your script + flags, then call render() (echoes) or parse() (returns a string) from any WordPress callback that produces output — admin page, shortcode, meta box, widget, REST handler, template part. The same $app works for all of them.
Both render() and parse() enqueue the script, localize the flags blob on window.my_settings, and produce <div id="my_settings-root"></div> for Elm to attach to. The mount node id defaults to {handle}-root; override with ->mount_node( 'custom-id' ) if needed.
Your compiled Elm bundle reads window.my_settings and mounts into #my_settings-root — @pinkcrab/elm-wp-bootstrap handles that plumbing automatically.
Contract
This section is the authoritative spec shared by all three packages. Any change here is a contract bump and must be mirrored in the other two repos in lockstep.
Flags blob
Emitted via wp_localize_script( $handle, $handle, $blob ). The JavaScript side reads it from window.<handle> and hands it to Elm as flags.
Notes:
restNonceis minted from thewp_restaction and is whatwp.apiFetchneeds.ajaxNonceis minted from a package-specific action (one per handle) for the legacyadmin-ajax.phppath.pluginDatais the only free-form section — user-supplied flags via->flags( [...] ).capabilitiesis a UI hint for Elm to disable buttons etc; never trust it for authorisation (server-side checks are the real gate).
Port names
The JS bootstrap and the Elm package must agree on these names. Changing any is a contract break.
| Direction | Port name | Purpose |
|---|---|---|
| Elm → JS | wpApiFetch |
Outbound REST call via wp.apiFetch. Payload: { id, method, path, body? }. |
| JS → Elm | wpApiFetchResult |
Paired response. Payload: { id, ok, status, body }. |
| Elm → JS | wpNotice |
Show an admin notice. Payload: { kind: "success"\|"error"\|"info"\|"warning", message }. |
| Elm → JS | copyToClipboard |
Copy text to clipboard. Payload: string. |
id on wpApiFetch / wpApiFetchResult is a string correlation id the Elm side generates so multiple in-flight requests can be matched to their responses.
Versioning
All three packages share a major version. Within 1.x, minor and patch versions can move independently per package — compatibility is guaranteed across the same major.
pinkcrab/elm-mount |
@pinkcrab/elm-wp-bootstrap |
Pink-Crab/elm-wp |
|---|---|---|
1.x |
1.x |
1.x |
License
MIT © PinkCrab