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

@stack-spot/portal-theme

v1.1.0

Published

This library contains the StackSpot theme (css) and many utilities to use and manipulate it.

Downloads

2,466

Readme

Theme

This library contains the StackSpot theme (css) and many utilities to use and manipulate it.

Attention: this is not Citric, our design system (DS), instead, it's a configuration that we pass to it.

Platforms: this library is compatible with the web (browser) and VSCode (used by the StackSpot AI extension).

Incomplete set of tokens

This library is mostly dealing with colors. The rest of the theme is still defined by Citric. This will be reviewed in a future version, along with Citric itself.

Using the theme

  1. Import the css into your main project file:
import '@stack-spot/portal-theme/dist/theme.css'
  1. Setup the theme provider for Citric.
import { CSSToCitricAdapter } '@stack-spot/portal-theme'

const App = () => (
  <CSSToCitricAdapter>
    // Your content goes here. Every component of Citric will be aware of the theme from this point on.
  </CSSToCitricAdapter>
)
  1. You can now use the theme in your jsx to define colors:
<p style={{ color: theme.color.primary['500'] }}>Hello World!</p>
  1. You can also use the css variables defined by the theme in your css files:
.my-class {
  background-color: var(--light-400);
}

Reading and changing the current theme

  • getThemeName(): gets the current theme name.
  • getThemeKind(): returns "dark" if the theme is mostly dark or "light" if the theme is mostly light. This can be different than the theme name.
  • useThemeName(): a React Hook to get the current theme name. Use this if you need your content to update when the theme changes.
  • useThemeKind(): a React Hook to get the current theme kind. Use this if you need your content to update when the theme changes.
  • loadTheme(): loads the theme from the cookie "theme".
  • setTheme(themeName): changes the current theme.

Observations:

  • The default theme is "dark".
  • The theme is always defined by the attributes data-theme-name and data-theme-kind on the tag body.
  • The theme automatically updates across multiple windows.

Utilities

  • withOpacity(variableName): applies an opacity to a theme css color variable.
  • contrastColor(color, level): gets the ideal contrast color for the color passed as parameter.
  • createColorSequence(options): generates a pre-defined, cyclic, set of ideally spread colors from the theme palette.
  • paletteSequence(options): same as createColorSequence, but generates the css variable instead.
  • valueOf(variableName): gets the value of a CSS variable.
  • listToClass(classList): removes all falsy values from the array and joins every item into a valid class string.