react-templates & utilties for the OpenComponents template system
Module for handling React templates in OC
Name | Version |
---|---|
oc-template-react |
|
oc-template-react-compiler |
|
oc-react-component-wrapper |
Initialize a component with the oc-template-react and follow the CLI instructions
$ oc init <your-component-name> oc-template-react
template.src
- the react App entry point - should export a react component asdefault
template.type
-oc-template-react
- required in
devDependencies
-oc-template-react-compiler
props = server()
- the viewModel generated by the server is automatically passed to the react application as props- The oc-client-browser is extended and will now expose all the available react-component at
oc.reactComponents[bundleHash]
Externals are not bundled when packaging and publishing the component, for better size taking advantage of externals caching. OC will make sure to provide them at Server-Side & Client-Side rendering time for you.
- React
- ReactDOM
- PropTypes
Server Side Rendering
= server side rendering should work as for any other OpenComponentcss-modules
are supported.post-css
is supported with the following plugins:
The compiler exposes some utilities that could be used by your React application:
An Higher order component that will make a getData
function available via props.
import { withDataProvider } from 'oc-template-react-compiler/utils';
const yourApp = props => {
// you can use props.getData here
};
yourEnhancedApp = withDataProvider(yourApp);
getData
accept two arguments: (params, callback) => callback(err, result)
. It will perform a post back request to the component endpoint with the specified query perams invoking the callback with the results.
For more details, check the example app
An Higher order component that will make a getSetting
function available via props.
import { withSettingProvider } from 'oc-template-react-compiler/utils';
const yourApp = props => {
// you can use props.getSetting here
};
yourEnhancedApp = withSettingProvider(yourApp);
getSetting
accept one argument: settingName => settingValue
. It will return the value for the requested setting.
Settings available at the moment:
getSetting('name')
: return the name of the OC componentgetSetting('version')
: return the version of the OC componentgetSetting('baseUrl')
: return the baseUrl of the oc-registrygetSetting('staticPath')
: return the path to the static assets of the OC component