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

react-brandbook

v1.1.2

Published

Quickly setup branding website with styles and navigations.

Downloads

8

Readme

React Brandbook

Quickly setup a brand book with title, logo and a list of topics (with sub-topics).

It supports multiple themes and layouts where you can switch between different flavour of theme and page layout.

It is especially suitable for portfolios, style guides, resumes, or just any slides like pages.

Usage

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

where props supported includes,

Title and Logo

You can replace them with any element, ex.

  const title = 'MyBook'
  const logo = (
    <Icon
      size={'auto'}
      children={<Logo />}
      style={{ position: 'relative', top: '-3px' }}
    />
  )

  <Book title={title} logo={logo} />

Topic

Each topic is a page that can be specified via an object with title and stories inside.

  const topics = [
    { title: 'Button', stories: buttonStories }
  ]

where each story again can be defined with title, text and body.

  const Demo = ({ story }) => ()
  const buttonStories = [
    {
      title: 'Normal',
      text: 'Normal button states',
      body: <Demo />
    },
    ...
  ]

Each story can be added via body attributes of topic stories. And it can be decorated with story as input if needed.

Navigation

In order to navigate from one topic to another topic, you can use story.goto(search), where search is the topic name that you want to go to.

  const Demo = ({ story }) => {
    const onClick = e => { story.goto('Button') }
    return (
      <p>Used in <code onClick={onClick}>Button</code></p>
    )
  }

Themes

  const fontFamily = 'Times New Rome'
  const themes = [
    { title: 'Light', theme: { mode: 'light', fontFamily } },
    { title: 'Dark', theme: { mode: 'dark', fontFamily } }
  ]

  return <Book themes={themes} />