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/twix

v0.3.2

Published

Create variant based className strings.

Downloads

33

Readme

twix 🍫

twix is a small utility for constructing classnames using a variant based api. The API is largely copied from stitches but works with just plain class strings instead.

Installation

twix has a peer dependency on clsx, a small utility for conditionally toggling class names.

npm i @asyarb/twix clsx

Example Usage

const button = twix({
	base: 'rounded',

	variants: {
		color: {
			purple: 'bg-purple',
			blue: 'bg-blue',
		},
		size: {
			small: 'p-5',
			large: 'p-8',
		},
	},

	compoundVariants: [
		{
			color: 'purple',
			size: 'small',
			class: 'font-bold',
		},
	],

	defaultVariants: {
		size: 'large',
	},
})

// => "rounded p-8 bg-purple"
button({ color: 'purple' })

// => "rounded p-5 bg-purple font-bold"
button({ color: 'purple', size: 'small' })

TypeScript

twix is written in TypeScript, and provides type-safety when defining and using your variants.

import type { GetVariants } from '@asyarb/twix'

// ... Same button from above.

// => TypeScript error - Variants must be provided.
button()

// => TypeScript error - Must provide `color` since no defaultVariant exists.
button({ size: 'small' })

// => Get variants as a type you can re-use elsewhere:
/**
 * { color: 'purple' | 'blue', size?: 'small' | 'large' }
 */
type ButtonVariants = GetVariants<typeof button>

Additional classes

The function returned from twix can also append arbitrary classes if desired.

// ... Same button from above.

// => "rounded p-5 bg-purple font-bold arbitrary"
button({ color: 'purple', size: 'small', class: 'arbitrary' })

React usage

// components/Button.tsx

import { GetVariants, twix } from '@asyarb/twix'

const button = twix({
	/** Same example from above... */
})

type ButtonProps = {
	/** Userland props... */
} & GetVariants<typeof button>

const Button = ({ color, size, ...props }: ButtonProps) => {
	return <button className={button({ color, size })} {...props} />
}