@lardy/core v0.5.1

volvo-react-composer

Installation

To install volvo-react-composer into your project you need to have authenticated yourself to the fbinhouse gemfury repository.

If you've never had access to the repository, ask one of the admins (e.g. @phil, @mike, @max-bolotin) for access.

Once you have access, authenticate once by running:

npm login –registry=“https://npm.fury.io/fbinhouse/” –scope=@fbinhouse

You can now install the package:

npm i -S @fbinhouse/volvo-react-composer

What is it?

• A (reasonably) opinionated React component composer
• Based on MobX
• Enforces separation of business and presentation logic
• Functional component composition, without the scaffolding
• Handles dependency injection
• Supports powerful 3rd party middlewares

...but most of all...

• A great way to start a new VCC-UI or DMS component project

What does it do (so far)?

• Declaration of strongly typed props and state
• Dependency injection
• Static and runtime type checking of props
• Whatever it's middlewares wants it to, for example:
  • Stackable transformations for styling/animations of HTML elements
  • Responsivity tracking
  • Reacting to element rects
  • etc ...

What does it spare me from doing?

Again, this depends a bit on what middlewares you are opting in to use, but:

• Figuring out how to handle CSS in your pipeline
• Tracking component/application and window-level responsivity
• Ensuring that your component library is consumable by other applications and component libraries in the VCS/VCC or DMS spheres
• Taking responsibility for the separation of business and presentation logic
• Juggling composition of multiple higher order components and decorators while maintaining a strongly typed set of inputs

Great! How do I use it?

Start by checking out the Quick start!