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

typestyle-react

v2.5.0

Published

React integration for TypeStyle

Downloads

11

Readme

typestyle-react

Simplified integration between TypeStyle and React.

Installation

npm install --save typestyle-react
# or
yarn add typestyle-react

API

styled

type styled = (tag: string, ...properties: (NestedCSSProperties | ((props: {}) => NestedCSSProperties))[]) => React.Component;

Create a React component with styles applied.

import { styled } from "typestyle-react";

const RedText = styled("span", {
  color: "red"
});

// Renders a `<span class="…">…</span>`, where `class` is computed by TypeStyle.
let element = <RedText>Hello world!</RedText>;

Components pass-through supported props, so they can be used the same as the unstyled originals.

element = <RedText id="my-red-text">Hello world!</RedText>;

Caveats:

  • If className is passed, its value will be merged with the TypeStyle computed value.
  • Using ref will expose the wrapped component, use innerRef to access the inner element.

Parameterised Styles

Styling can be parameterised, and be passed values via props. Instead of passing an CSSNestedProperties object to styled, pass a function:

import { styled } from "typestyle-react";

const ColoredText = styled("span", (props: { color: string }) => ({
  color: "red"
}));

// Styled props passed via the special `styled` prop.
let element = <ColoredText styled={{ color: "red" }}>Hello world!</ColoredText>;

Hint: Don't confuse the styled prop with the native style prop.

style

type style = (...properties: NestedCSSProperties[]) => string;

A wrapper around TypeStyle's style export that schedules forceRenderStyles() in a microtask.

import { style } from "typestyle-react";

const coloredTextStyle = style({
  color: "red"
});

let element = <span className={coloredTextStyle}>Hello world!</span>;

StyleSheet flushing to DOM

Styles are computed (via TypeStyle) when the component is rendered, and are immediately scheduled to be flushed to the DOM synchronously.