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

bhp-ui-react

v0.0.4

Published

BHP UI react library. A companion to [`bhp-ui`](https://github.com/BHP-DevHub/bhp-ui) for developers using React.

Downloads

4

Readme

BHP UI React

BHP UI react library. A companion to bhp-ui for developers using React.

Getting started

One option is to grab a copy of bhp-react-app, a basic starter prepared that includes this library and all its dependencies.

Otherwise, run

yarn add bhp-ui-react

to install this library. the required peer dependencies for the package will be listed as warnings, so yarn add those next.

You can now reference the library by importing from it, for example

import { BHPLogo } from 'bhp-ui-react';

// ...

export default () => (
  <BHPLogo />
);

Using CSS

If your project is using CSS rather than SASS/SCSS, you will find precompiled CSS files in css/index-light.css and css/index-dark.css, which you can use directly in your React project with code like

import 'node_modules/bhp-ui-react/css/index-light.css';

You must add class="light-theme" (or dark-theme) to the root HTML object of your project for these styles to work.

Using SCSS (recommended)

The SCSS is designed so that it can be included and extended within the context of an active project. Two major entry points in scss/index-dark.scss and scss/index-light.scss which may be sufficient for your needs, and which are also provided as simple examples of how to use the SCSS.

If you want to customise the SCSS, you can create an scss file in your repository containing

@import '~bhp-ui/scss/themes/light';
@import '~bhp-ui-react/scss/0-root';
@import '~bhp-ui-react/scss/1-base';

.light-theme {
  @import '~bhp-ui-react/scss/2-within-theme';
}

You must add class="light-theme" (or dark-theme) to the root HTML object of your project for this to work, though you can omit this if you only intend to support one theme, modifying the SCSS to remove the theme class qualifier:

@import '~bhp-ui/scss/themes/light';
@import '~bhp-ui-react/scss/0-root';
@import '~bhp-ui-react/scss/1-base';
@import '~bhp-ui-react/scss/2-within-theme';