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

@stylable/runtime

v6.1.1

Published

Stylable runtime DOM integration

Downloads

12,901

Readme

@stylable/runtime

npm version

@stylable/runtime provides the utility that is used to create the stylesheet functions that apply classNames and states to the DOM. It also exposes an optional DOM renderer that is responsible for loading CSS in its correct order.

End-users will usually not add this package directly as a dependency themselves, and would instead receive it as a dependency of their chosen integration (e.g. @stylable/webpack-plugin).

Usage

@stylable/runtime exposes two methods, Stylesheet and Renderer.

Stylesheet

When importing a Stylable stylesheet, there are multiple named exports that are exposed for usage.

import { 
    style, 
    classes, 
    vars, 
    stVars, 
    keyframes, 
    layers, 
    containers, 
    cssStates 
} from './local.st.css';

|Import name|Description| |-----------|-----------| |style|utility function that returns a string to be used as a node class name for classes and states passed to it | |classes|an object mapping exported classes from their source name to their scoped name | |vars|an object mapping exported css custom properties (vars) from their source name to their scoped name | |stVars|an object mapping build time Stylable variables to their build time values (these cannot be overridden in runtime) | |keyframes|an object mapping exported keyframes from their source name to their scoped name | |layers|an object mapping exported layers from their source name to their scoped name | |containers|an object mapping exported containers from their source name to their scoped name | |cssStates|utility function that maps an object representing states and their values to a string with all required classes |

Style utility function

The style function is useful for creating the root node of you component, passing along classes passed through props, or whenever a state is being defined.

style(
    contextClassName: string, stateOrClass: string | StateMap, ...classes: string[]
)

|Argument|Type|Description|Required| |---------|----|-----------|:------:| |contextClassName|string|className to be namespaced|true| |stateOrClass|StateMap | string|either an object containing states and their values, or a class string|false| |classes|string|any other argument passed will represent a classes that should be applied. In any root node of a component, props.className should be passed along to maintain external customization |false|

import { style, classes } from './local.st.css';

// properties passed to the component externally
props = { className: "app__root app--propstate" };

// The classes export exposes a map of classNames and their namespaced values.
classes.root;
// returns "local__root"

<div className={style(classes.root)} />
// becomes <div className="local__root" /> 

<div className={style(classes.root, { localState: true })} />
// becomes <div className="local__root local--localstate" /> 

<div className={style(classes.root, { localState: true }, props.className)} />
// becomes <div className="local__root local--localstate app__root app--propstate" /> 

<div className={style(classes.root, 'global-class', props.className)} />
// becomes <div className="local__root global-class app__root app--propstate" /> 

<div className={classes.part} />
// becomes <div className="local__part" /> 

Renderer

Responsible for managing CSS files, linking to the document and maintaining their correct order in your application.

TypeScript integration

When importing a Stylable stylesheet in TypeScript, a global module declaration needs to be defined in order to not receive type errors about unknown imports.

Add the following file to your /src directory.

// globals.d.ts
declare module '*.st.css' {
    export * from '@stylable/runtime/stylesheet';

    const defaultExport: unknown;
    export default defaultExport;
}

License

Copyright (c) 2017 Wix.com Ltd. All Rights Reserved. Use of this source code is governed by a MIT license.