receter / my-component-library

89 stars 26 forks source link
ViteReactComponentLibrary

A simple (demo) react component library

This repository was published together with an article on how to create a react component library using Vite's library mode.

Here is another repo that consumes this libarary: https://github.com/receter/my-component-library-consumer

The demo library on npm: https://www.npmjs.com/package/@receter/my-component-library

Installation

You can install it with npm (don't expect much fanciness):

npm i @receter/my-component-library

Usage

import { Button, Label, Input } from '@receter/my-component-library';

See this file for an example on using this library: https://github.com/receter/my-component-library-consumer/blob/main/src/App.tsx

React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

   parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module',
    project: ['./tsconfig.json', './tsconfig.node.json'],
    tsconfigRootDir: __dirname,
   },