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

example-typescript-react-component-library

v1.0.3

Published

An example react component library using typescript with a runnable example server using create-react-app.

Downloads

5

Readme

Example typescript react component library

NPM LICENSE

An example project setup that allows for publishing a TypeScript React component module to npm.

Initially setup using create-react-library and converted to use TypeScript.

Project structure

The project contains a src directory containing the module files that get published to npm, and an example directory containing a working create-react-app project that contains an example usage of the module.

CI

This example also includes a .gitlab-ci.yml which publishes the module to npm (based on this guide) and deploys an example build to GitLab pages.

Development

Setup

Module

Whilst in the root directory, install dependencies

npm install

To run in watch mode

npm start

To build

npm run build

Example create-react-app

First, cd into the example directory

cd example

Install dependencies

npm install

To run development server

npm start

To build

npm run build

Contributing

Please read CONTRIBUTING.md.

Deployed Module

Install

npm install --save example-typescript-react-component-library

Usage

import * as React from "react";

import MyComponent from "example-typescript-react-component-library";

class Example extends React.Component {
    render() {
        return <MyComponent />;
    }
}