PackageName__
This is a Modular View
View
Modular views are Modular
packages that, by
convention, export a default React component. They are
created with a default entry-point of
src/index.tsx in their package.json and they are built exactly like
package types. The only
difference is that, since views should always export a React component, they
can be started to spawn a local
developer server and render their default export to the DOM.
Build
To build your View for deployment, run:
modular build PackageName__When building a view, Modular transpiles it starting from its entry-point
twice: once with a target format of
CommonJS in the dist-cjs directory and
once with a target format of
ES Modules,
in the dist-es directory. The output package.json links both compiled
entry-points respectively in the
main and
module
field.
Start
To run your view locally on a development server, run start:
modular start PackageName__This causes a developer server to run on port 3000, serving the default export of the View entry-point with an additional runtime layer that provides developer experience functionalities like hot reloading and on-screen error overlay.
Entry-point
The entry-point for a View is configurable; Modular discovers it by looking at
the main field in the View's package.json; by default, modular adding a
new view sets it as "./src/index.tsx", but it's possible to manually modify
it. The entry-point of a View needs to export a React component as default for
the start command to work.
Template
Views are generated by modular add using the
modular-template-view
template.