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

heliux-ui-style

v1.0.17

Published

Heliux UI CSS Foundations

Downloads

125

Readme

Heliux Design System Foundations

This package includes all of the styling foundations for Heliux Theme definition, colors, shadows, dimensions, icons, etc.

Installation

npm install heliux-ui-style

Usage

Styles: Import the css file in order to have the css variables exposed on the root level

@import "~heliux-ui-style/dist/index.min.css";

or if you want to import it in your JS files

import "heliux-ui-style/dist/index.min.css";

Icons: We expose each icon's SVG from the dist files so you can use them in your app.

import IconName from "heliux-ui-style/src/Icons/IconName.svg";

Mixins and functions: We export multiple SCSS mixins and function helpers that can be used in your application if you use SASS. All helpers can be imported as demonstrated below.

@import "~heliux-ui-style/dist/mixins";
@import "~heliux-ui-style/dist/functions";

Icons

Adding a new icon

In order to add a new icon you will need to fork the repo and open a PR

When adding a new icon please make sure that there isn't a similar icon - if so, either replace the icon or make sure that we need another version of it

Metadata file

We maintain a metadata file for each icon, it helps our icon library be more readable and searchable when searching for relevant icons

How to add a new icon? Add the icon in SVG format under the src/Icons folder (size 20x20) then run npm run generate-meta and fill in the relevant information (you can add multiple icons and run the command once)

Icon colors

We want to support the ability for the svg icon to adapt the css color attribute, therefore when adding an icon all of the colors in the SVG should be currentColor.

In some rare occasions when you want to preserve a color within the icon please consider the following:

  • currentColor might change according to position and theming
  • this is an open source library so brand colors might change
  • please be aware that we will add a monochrome version of that icon as well

New icon request

To create a non existing monday.com style icon open a PR with please see the guidelines

Stylelint rules

It is recommended to extend our Stylelint config in order to ensure proper usage of this library.
To use the supplied config, add heliux-ui-style/stylelint-config as a Stylelint config extension:

// Your .stylelintrc
{
  ...
  "extends": "heliux-ui-style/stylelint-config",
  ...
}

Functions

The following SCSS functions are exported:

  • camelize: camelcase string
  • capitalize: capitalize string
  • contain: returns whether $value is contained in $list as a Boolean
  • map-collect: merges maps from different scopes into one
  • extract-rgb: returns a comma separated list of rgb values from a color

Mixins

The following SCSS mixins are exported:

  • Common:
    • hidden-element
    • grid-auto-fit($grid-gap, $grid-column-gap, $grid-row-gap. $grid-cell-min-width, $grid-cell-array-calc, $important)
    • scroller($width, $height, $color)
  • States:
    • disabled
    • reset-button
    • focus-style($focus-radius)
  • Typography:
    • vibe-text($type, $weight)
    • vibe-heading($type, $weight)
    • line-clamp($lines)
    • ellipsis