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

@robertkirsz/ui

v0.8.2

Published

UI components library that I use in my React apps

Downloads

2

Readme

UI Components Library

A library of UI components that I use in my apps.
Made with React and styled-components, built with Rollup.

Installation

yarn add @robertkirsz/ui

// or

npm install @robertkirsz/ui

Make sure you have latest react, react-dom and styled-components installed as well.

Usage

import React from 'react'
import ReactDOM from 'react-dom'
import { ThemeProvider, Button } from '@robertkirsz/ui'

const App = () => (
  <Button primary size="small">
    Hello
  </Button>
)

ReactDOM.render(
  <ThemeProvider>
    <App />
  </ThemeProvider>,
  document.getElementById('root')
)

All available components with usage examples and their documentation can be found here.

Drak mode and custom themes

To use dark mode styles, wrap a particular part of your app with <ThemeProvider> and pass darkMode prop to it.

<ThemeProvider darkMode>
  <PartsThatNeedToBeInDarkMode />
</ThemeProvider>

If you want to use a custom theme, you can pass your values as theme prop to <ThemeProvider>:

const customTheme = {
  borderRadius: '0',
  colors: {
    text: 'red',
    primary: 'green',
    secondary: 'blue'
  }
}

<ThemeProvider theme={customTheme}>
  <PartsThatWillReceiveCustomTheme />
</ThemeProvider>

You can find the theme structure and values in src/theme.ts file.

You can also import { defaultTheme } from '@robertkirsz/ui' and use it as a base for some more precise value-overwrites.

import { defaultTheme } from '@robertkirsz/ui'

const customTheme = {
  colors: {
    ...defaultTheme.colors,
    secondary: 'yellow'
  }
}

BasicStyles

You can import { BasicStyles } from '@robertkirsz/ui' and put it somewhere in your app to get some core styles and basic typography.

Troubleshooting

If you don't see Intellisense suggestions for components' props in your editor, make sure you have @types/react and @types/styled-components installed as your devDependencies.

Development

Make sure you're using Node version specified in .nvmrc file. If you have nvm installed, you can do this:

nvm use

It will set the proper Node version for you (or prompt you to install it).

Install dependencies

yarn install

Start Storybook

yarn storybook

You can use it as a development environment as well as the showcase app for all components.
It will be available at http://localhost:6006.

Unit tests

yarn test

Formatting code

yarn prettier