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

@fchh/fcos-suite-ui

v0.2.25

Published

Reusable UI components based on React and TailwindCSS for the Fab City OS Suite funded by the Interfacer EU project.

Downloads

78

Readme

fcos-suite-ui

Reusable UI components based on React and TailwindCSS for the Interfacer EU project.

Component Gallery

If you want to look at all components this library has to offer, you can take a look at our deployed component gallery (built with Ladle), either by visiting our live deployment or running npm run ladle locally.

Usage in another production project

To use any of the UI components from this package, make sure your consuming project has the following dependencies installed:

  • react
  • react-dom
  • @carbon/icons-react

After you've done this, you should be able to install this package:

npm i -D @fchh/fcos-suite-ui

Now you need to import the stylesheets from this component library by importing them somewhere in your top-level index/app file:

import '@fchh/fcos-suite-ui/dist/style.css'

After that, you can use any components like this:

import { Pill } from "@fchh/fcos-suite-ui"

Usage in a local development project

If you don't want to go through the hassle of alway publishing new versions to the package registry, you can also use this library locally, without any registry. In your consuming project just reference the location of this folder in the npm install command. If your consuming project and the component library lie next to each other in the same folder, it goes like this:

npm i -D ../fcos-suite-ui

If you now make any changes to the fcos-suite-ui folder, you need to run npm build again, and then your changes should show up.

Customizable Link component

Since this is a generic Component library, it should work for many use cases (e.g. in a classic React SPA as well as in a React Native app or server rendered components). Therefore, by default it wraps all Links inside a default HTML <a> tag. However, if you want to use it with react-router or any other routing library, that uses its own Link component, you can customize the Link component in your consuming app by wrapping it with a LinkContext like so:

import * as React from "react";
import { LinkContext } from "@fchh/fcos-suite-ui";

export const App = ({ children }) => (
  <LinkContext.Provider
    value={{
      linkRenderFn: (linkChildren, linkTarget, linkProps) => (
        <CrazyLinkComponent to={linkTarget} {...linkProps}>
          {linkChildren}
        </CrazyLinkComponent>
      ),
    }}
  >
    {children}
  </LinkContext.Provider>
);