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

plug-n-play-ui-kit

v0.0.0-3.10

Published

Plug-N-Play-Ui-Kit is a design system built with Storybook, Vite, React, TypeScript and styled-components

Downloads

121

Readme

Plug-N-Play-Ui-Kit

npm version

Plug-N-Play-Ui-Kit is a design system built with Storybook, Vite, React, TypeScript, and styled-components. It provides a powerful and customizable UI kit for your web applications.

Getting Started

To get started with Plug-N-Play-Ui-Kit, follow these steps:

1. Installation

You can install the library using npm:

npm install plug-n-play-ui-kit

2. Usage

Theming:

To avoid theming issues on components, make sure to wrap your entire application with the PlugNPlayContainer component at the root element level. This will provide the correct theme to all components within your app.

Example:

import React from 'react';
import { PlugNPlayContainer, darkTheme } from 'plug-n-play-ui-kit';
import App from './App'; // Replace with your root component
import './index.css';

ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <PlugNPlayContainer theme={darkTheme}>
      <App />
    </PlugNPlayContainer>
  </React.StrictMode>
);

TypeScript Configuration:

To ensure TypeScript can correctly find the declaration files for Plug-N-Play-Ui-Kit, add the following paths to your tsconfig.json:

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "plug-n-play-ui-kit": ["./node_modules/plug-n-play-ui-kit/dist/index.d.ts"]
    }
  }
}

Troubleshooting

If you encounter issues like "Could not find a declaration file for module 'plug-n-play-ui-kit,'" make sure to follow the above instructions carefully. If the issue persists, consider the following:

  • Ensure Vite or your build tool correctly handles TypeScript declaration files and module resolution.
  • Make sure you're using the latest version of Plug-N-Play-Ui-Kit.
  • If you need any assistance kindly create an issue in Git Issues

License

This project is licensed under the MIT License.


This README provides clear instructions and guidance for users and potential contributors. Make sure to include the actual code examples and create the corresponding files (like `CONTRIBUTING.md` and `LICENSE`) in your repository to support these sections. This can help attract more users and contributors to your project.