npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-flares

v2.0.1

Published

A React component to facilitate lazy loading.

Downloads

12

Readme

react-flares

A small utility library for lazy loading React components. Also contains a scaffolding cli designed around library. Uses React, TypeScript and Webpack in scaffolding for implementation and bundling.

Table of Contents

Installation

Usage

Flares

Configuration


Installation

npm install -g react-flares

Usage

Project Setup

Run these commands to create default project set up:

react-flares project MyProject
npm install

Webpack dev server comes installed with the setup. Start it with:

npm start

Commands

Create a project. Should only be used once per project.

react-flares project ProjectName

Create a module with a default component.

react-flares module ModuleName 

Create a component with a view and types file.

# Create a component within a module
react-flares component ModuleName:ComponentName

# Create a component outside of module
react-flares component ~:ComponentName

# Create a sub-component (Allows more organization than changing functionality of the component.)
react-flares component ModuleName:ComponentName/SubComponentName

Options:

  • --no-mod - Prevents create of default module and all its associated files. (project)
  • --no-styles - Prevents creation of styles file. (project, module)
  • --no-comp - Prevents creation of default component and all its associated files. (project, module)
  • --no-view - Prevents creation of default components view file. (project, module, component)
  • --no-types - Prevents creation of default components types file. (project, module, component)

Flares

Flares are a way of lazy loading a component. They are used just like normal React components but are set up to load their corresponding component before trying to render it.

ReactDom.render(
    <MyComponentFlare />
    , document.getElementById("content")
);

The component flare files are generated when ever a component is generated with the cli tool. However their implementation is simple if you have to make one yourself.

import * as ReactFlares from 'react-flares';
import {MyComponentProps} from "../../modules/MyModule/MyComponent.types";

// Importing the component's props from its types file allows you to pass the same props to the flare as you would to the regular component
export class MyComponentFlare extends ReactFlares.ComponentFlare<ReactFlares.ComponentFlareProps & MyComponentProps> {
    get componentId(): string {return "MyModule:MyComponent";}

You may also choose to use a flare directly without of inheritance.

ReactDom.render(
    <ReactFlares.ComponentFlare componentId="MyModule:MyComponent" />
    , document.getElementById("content")
);

Resolution

Modules correspond to bundles created by webpack. The default setup creates a bundle from each .module.ts file. When a module is created its default component is imported and registered in its constructor.

export class MyModuleModule implements ReactFlares.Module {
    private _components: {[name:string]: any};
    constructor() {
        this._components = {};
        this._components["MyComponent"] = MyComponent;
    }
}

When you need additional components to be fetchable with flares, you'll need to add similar lines to their module's constructor.

Configuration

You can set a different root for flares to load .js and .css files from. Defaults are "js/" and "css/", which corresponds to how webpack-dev-server is setup to load them.

import * as ReactFlares from "react-flares";

ReactFlares.setJsRoot("path/to/js/");
ReactFlares.setCssRoot("path/to/css/");