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

@affinidi/ui-core

v1.8.0

Published

The common UI library for affinidi

Downloads

25

Readme

UI Core

This is the Affinidi Core UI library. Exports a bunch of components and hooks for themeing their every aspect.

Made using React, SCSS for the components, Storybook for Documentation and rollup for bundling

Installation

$ npm i @affinidi/ui-core

Usage

Components

import {Button} from '@affinidi/ui-core'

const MyComponent = () => {
  return (
    ...
    <Button>Click Me!</Button>
    ...
  )
}

Palette Override

import { useUICoreTheme } from '@affinidi/ui-core'

const MyComponent = () => {
  useUICoreTheme({
    palette: {
      primary: {
        main: "darkblue"
      }
    }
  })

  return (
    ...
  )
}

Local Development

The library uses yalc for local development, bundling and testing. Make sure your machine has yalc installed by running npm i -g yalc

The following steps illustrate how to develop and test your local changes

  1. Do the required changes to the codebase. This can be creating new components(or updating older ones), writing hooks or any other changes that will affect the functioning of the library and ultimately the consumers
  2. Run npm run publish-local from the project root. This will run the build script and package the library into yalc's local registry acting like a pseudo npm store
  3. To test your changes in another library go to the consumer and run yalc add @affinidi/ui-core. This will create a local .yalc folder and a yalc.lock file to keep track of this local package. Then follow the usage guidelines above to test. We rinse and repeat till done.
  4. Once we're ready to commit we can cleanup the consumer by running yalc remove @affinidi/ui-core and removing the created files and folders from the previous step.
  5. Proceed with the commit.

Browsing Storybook

We dont host our storybook(yet), so one can clone the repository and browse through locally.

cd ui-core
npm i
npm run storybook

Documentation

All components have dedicated typings available but more concrete documentation would be available soon