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

@draekien/clean-ui

v2.15.0

Published

Clean UI is a custom React JS component library built using theme-ui.

Downloads

6

Readme

semantic-release Commitizen friendly Branch Coverage Function Coverage Line Coverage Statement Coverage


Introduction

Clean UI is a custom React JS component library built using theme-ui and typescript. The aim of this library is to create a catalogue of plug and play components that are clean and functional so that they can be used in a wide variety of situations.

Storybook

A storybook of this component library is published on Chromatic. You can view it here.

Getting Started

Install and Consume

Install the package using either npm or yarn

# npm
npm install @draekien/clean-ui

# yarn
yarn add @draekien/clean-ui

To consume CleanUi, you must import the CleanUi component and wrap your app in this component.

// index.{tsx,jsx}
import { CleanUi } from 'clean-ui';

function Main() {
  return (
    <CleanUi>
      <App />
    </CleanUi>
  );
}

ReactDOM.render(<Main />, document.getElementById('root'));

Customizing the theme

All it takes to use your own theme is to pass in a theme object to the CleanUi theme prop. The theme passed in will be merged with the default theme provided with Clean UI.

// index.{tsx,jsx}
import { CleanUi, Theme } from 'clean-ui';

const myCustomTheme: Theme = {
  colors: {
    'p-400': 'purple',
  },
};

function Main() {
  return (
    <CleanUi theme={myCustomTheme}>
      <App />
    </CleanUi>
  );
}

ReactDOM.render(<Main />, document.getElementById('root'));

Using a component

All components are exported from the main module. This means you can import compoments using object destructuring like below.

import React from 'react';
import { Button } from 'clean-ui';

const MyComponent: React.FC = () => {
  const handleClick = () => console.log('click!');

  return (
    <div>
      <Button onClick={handleClick}>Click me!</Button>
    </div>
  );
};