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

@wookiejin/react-component

v0.1.7

Published

This library aims to provide useful semantic colorsets, HOCs and components for easy layout building.

Downloads

121

Readme

React-Component

This library aims to provide useful semantic colorsets, HOCs, and components for easy layout building. Check out our storybook!

Install

This library requires React and Emotion as peer dependencies. Install these packages before using this library.

"@emotion/react": "^11.7.1",
"@emotion/styled": "^11.6.0",
"react": "^18.2.0"
yarn add react @emotion/react @emotion/styled
yarn add @wookiejin/react-component

ResetStyle

The library provides a stylesheet for resetting browser-specific styling. Use <Gloabl/> from @emotion to import the stylesheet to your app.

import { Global } from '@emotion/react'
import { ResetStyle } from '@wookiejin/react-component'

function App() {
  return (
    <>
      <Global styles={ResetStyle} />
      ...
    </>
  )
}

View

The library provides a higher-order component View for layout building. You can wrap your custom component with View to inherit parameters for margins. You should pass the remaining props to the outermost component.

import { View } from '@wookiejin/react-component'

interface Props {
  children: React.ReactNode
}

const CustomComponent = View<Props>(({ children, ...props }) => {
  return <div {...props}>{children}</div>
})

function App() {
  return (
    <div>
      <CustomComponent marginLeft={4} marginVertical={8}>
    </div>
  )
}

Components & Layouts

The components are styled by Emotion theme context API. You should wrap the components from this library with ThemeProvider from Emotion and inject a theme object predefined in this library.

import { ThemeProvider } from '@emotion/react'
import { Fill, FillButton, DEFAULT_THEME } from '@wookiejin/react-component'

function App() {
  const onClick = () => {
    console.log('Clicked!')
  }

  return (
    <ThemeProvider theme={DEFAULT_THEME}>
      <HeaderText marginBottom={4}>Header<HeaderText>
      <FillButton fill="Secondary" onClick={onClick}>
        Click Me
      </FillButton>
    </ThemeProvider>
  )
}

Themes

The library provides a list of predefined themes. You can also define your theme. Refer to the theme files in /src/themes/ on the GitHub page.

import { css } from '@emotion/react'

export const CUSTOM_THEME = {
  font: {
    Title: css`
      font-size: 2rem;
    `,
    SubTitle: css`
      font-size: 1.3rem;
    `,
    SubSubTitle: css`
      font-size: 1.1rem;
    `,
    Body: css`
      font-size: 1rem;
    `,
    Caption: css`
      font-size: 0.8rem;
    `,
  },
  ...
}

Typescript

If you use typescript, add the following type definition to access the theme type safely.

// emotion.d.ts
import '@emotion/react'
import { DEFAULT_THEME } from '@wookiejin/react-component'

declare module '@emotion/react' {
  export interface Theme {
    color: typeof DEFAULT_THEME.color
    font: typeof DEFAULT_THEME.font
    border: typeof DEFAULT_THEME.border
    elevation: typeof DEFAULT_THEME.elevation
    fill: typeof DEFAULT_THEME.fill
  }
}