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

component-variants

v1.1.0

Published

Styled variants for styled-components

Downloads

1

Readme

Component Variants

Why this package?

To style different variants of a single component has so far been a hassle. This package greatly simplifies the way you define and type your variants of a component, while it keeps you in the same control as you have with styled components. Just a simple addon to styled-components.

Installation

With yarn

yarn add component-variants

or with NPM

npm i component-variants

Usage

We will assume the following imports

import React from "react";
import styled, { css } from "styled-components";
import { componentVariants, Variants } from "component-variants";

To express our variants on a certain option, we create a nested styling object where the first level is the option (size) and its children is the variants (small, medium, large).

const variants = componentVariants({
  size: {
    small: css`
      padding: 0;
    `,
    medium: css`
      padding: 2px;
    `,
    large: css`
      padding: 10px;
    `,
  },
});

To extract the typings required by the mixin, we utilize the provided typings helper, Variants.

type ButtonProps = Variants<typeof variants>;

We can then use this styling object (variants) as a mixin in our styled-component (MyStyledButton). Not that we've added ButtonProps to our styled button, to allow the usage to pass in the required props.

const StyledButton = styled.button<ButtonProps>`
  ${variants}
`;

interface Props extends ButtonProps {}

export const Button: React.FC<Props> = ({ size }) => {
  return <StyledButton size={size} />;
};

Variants

Variants can be described with string, enum, number or a string-represented boolean.

String

{
  size: {
    small: css``;
  }
}

Enums

{
  size: {
    [MyEnum.Small]: css``
  }
}

#### Numbers

{
  size: {
    0: css``
  }
}

#### String-represented boolean

{
  size: {
    false: css``,
    true: css``
  }
}

Theme

You can still utilize theme the same way as you are used to.

{
  size: {
    small: css`
      background-color: ${props => props.theme.colors.white};
    `,
  }
}

If you have not set up theme yet, please follow the instructions by (styled-components)[https://styled-components.com/docs/advanced].

Syntax

componentVariants(styledObject)

Parameters

styledObject | required

{
  option: {
    variant: Interpolation
  }
}

option is a string that describes the option you want to style. For example size

variant can be either a string, enum, number or a string-represented boolean.

Interpolation is the styled-components interpolation type that supports all styling you are used to do within your styled components