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

@asyarb/goobed

v0.2.1

Published

Very opinionated light abstractions for CSS-in-JS styling built on top of [`goober`](https://github.com/cristianbote/goober).

Downloads

8

Readme

Goobed (TBD)

Very opinionated light abstractions for CSS-in-JS styling built on top of goober.

Installation

# Install package and required `goober` peer-dependency:
yarn install @asyarb/goobed goober

# If you plan on using <Box />, install the required `clsx` peer-dependency.
yarn install clsx

Usage

CSS-style function

import { createSx } from '@asyarb/goobed';

const breakpoints = {
  sm: '48rem',
  md: '75rem',
};

const sx = createSx(breakpoints);

// Use it inline to create styles:
const Example = () => <div className={sx({ display: 'block' })} />;

// sx() just returns a valid className, so it's usage is straightforward:
const redClassName = sx({ color: 'red' });
const PlainClassExample = () => <div className={redColor} />;

// Define mobile-first, responsive styles with auto-complete for breakpoints:
const responsiveClassName = sx({ color: 'red', sm: { color: 'blue' } });

React Integration

import { createBox } from '@asyarb/goobed';

const { Box, sx } = createBox(breakpoints); // => sx() is also available!

// <Box /> supports a convenience `sx` prop for styling:
const BoxSXExample = () => <Box sx={{ display: 'block' }} />;

// <Box /> supports polymorphism via the `as` prop with full TypeScript support:
const BoxAsExample = () => <Box as="img" src="..." sx={{ width: '300px' }} />;
const TypeSafetyExample = () => <Box as="a" loading="lazy" />; // => 'loading' is not a property of HTMLAnchorElement.

// <Box /> supports auto-completed responsive styling too:
const BoxResponsive = () => (
  <Box sx={{ color: 'red', sm: { color: 'blue' } }} />
);

Extending Box

Creating components with sx support can be done like the following:

import { BoxProps } from '@asyarb/goobed';
import { Box, breakpoints } from '../path/to/Box-And-Breakpoints';

// Define your component's props as a union of BoxProps.
type StackProps<T extends React.ElementType = 'div'> = BoxProps<
  typeof breakpoints,
  T
> & {
  space: string;
};

// Extending React.ElementType is required for type-safe polymorphism.
const Stack = <T extends React.ElementType = 'div'>({
  as,
  sx,
  space,
  ...props
}: StackProps<T>) => (
  <Box
    as={as as React.ElementType}
    sx={{ display: 'flex', flexDirection: 'column', gap: space, ...sx }}
    {...props}
  />
);

const Usage = () => <Stack space="1rem" />;

SSR

See goober's documentation on setting up SSR. For NextJS example, check their examples repo.

Why?

Goober (imo) provides a nice balance of performance, flexibility and performance size for css-in-js. This library just provides mostly type-level and responsive helpers for authoring styles without sacrificing run-time performance.