wp-module-runtime 1.0.6
Install from the command line:
Learn more about npm packages
$ npm install @newfold-labs/wp-module-runtime@1.0.6
Install via package.json:
"@newfold-labs/wp-module-runtime": "1.0.6"
About this version
Runtime for Newfold WP modules and plugins
Follow instructions at GH Packages Setup.
npm install @newfold-labs/wp-module-runtimeThe PHP module can be installed only on the Brand plugin.
composer config repositories.newfold composer https://newfold.github.io/satiscomposer require newfold-labs/wp-module-runtimeIn your React component you can import the runtime module as so,
import { NewfoldRuntime } from "@newfold-labs/wp-module-runtime";
function Component(props) {
if (NewfoldRuntime.hasCapability("hasYithExtended")) {
//
}
}While the default runtime has useful values, you can extend the runtime and add newer values under NewfoldRuntime.sdk. This is done via use of WP filter.
An example usage
add_filter( 'newfold-runtime', array( $this, 'add_to_runtime' ) );
public function add_to_runtime( $sdk ) {
return array_merge( $sdk, array( 'my_field' => 'custom value' ) );
}Now when you use NewfoldRuntime.sdk.my_field, you'll see the value as 'custom value';
As the runtime can be extended via the newfold-runtime filter, you can also configure the type definitions to make sure you safely access the extended values. Since sdk is an TS interface, it can be easily extended in the following manner.
declare module "@newfold-labs/wp-module-runtime" {
export interface DefaultSdk {
my_field: string;
}
}Now when you use NewfoldRuntime.sdk, your editor should give you the correct type hints.
