Skip to content
This repository has been archived by the owner on Dec 27, 2023. It is now read-only.

Latest commit

 

History

History
112 lines (74 loc) · 5.37 KB

README.md

File metadata and controls

112 lines (74 loc) · 5.37 KB
Raw

This package has been deprecated

Use the new oc-template-react template on vite-templates

oc-template-typescript-react

React-templates with TypeScript support & utilities for the OpenComponents template system

Based on Nick Balestra's work on oc-template-react

Packages included in this repo

Name Version
oc-template-typescript-react npm version
oc-template-typescript-react-compiler npm version

Usage:

Initialize a component with the oc-template-react and follow the CLI instructions

$ npx oc init my-awesome-oc oc-template-typescript-react
$ cd my-awesome-oc
$ npm install

Extra info:

Linting

Like in Create React App, linting will be done during the build, and you can extend it from .eslintrc.json, by setting the EXTEND_ESLINT environment variable to true.

It can also be disabled completely by setting the DISABLE_ESLINT_PLUGIN environment variable to true.

package.json requirements

  • template.src - the react App entry point - should export a react component as default
  • template.type - oc-template-typescript-react
  • required in devDependencies - oc-template-react-compiler, react, react-dom, @types/react

conventions

  • 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]
  • You can register an event handler within the oc.events system for the the oc:componentDidMount event. The event will be fired immediately after the react app is mounted.
  • You can register an event handler within the oc.events system for the the oc:cssDidMount event. The event will be fired immediately after the style tag will be added to the active DOM tree.

externals

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

features

  • Server Side Rendering = server side rendering should work as for any other OpenComponent
  • css-modules are supported.
  • sass-modules are supported (you need to install the node-sass dependency).
  • post-css is supported with the following plugins:

Utils

The compiler exposes some utilities that could be used by your React application:

Hooks

useData

A hook that will make a getData function available via props, plus the initial data passed from the server to the component.

Usage:
import { useData } from 'oc-template-typescript-react-compiler/utils/useData';

const App = (props) => {
  // getData and getSetting are always available
  const { id, getData, getSetting } = useData<{ id: number }>();
  const staticPath = getSetting('staticPath');

  return (
    <div>
      <h1>Id: {id}</h1>
      <img src={`${staticPath}/public/logo.png`} alt="Logo" />
    </div>
  )
};

yourEnhancedApp = withDataProvider(yourApp);

getData accept one argument: (params) => Promise<result>. It will perform a post back request to the component endpoint with the specified query perams invoking the callback with the results.

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 component
  • getSetting('version') : return the version of the OC component
  • getSetting('baseUrl') : return the baseUrl of the oc-registry
  • getSetting('staticPath') : return the path to the static assets of the OC component

For more details, check the example app