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

@huement/ui

v0.3.104

Published

<p align="center"> <img src="logo.png" width="400" /> </p>

Downloads

12

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

johnny13johnny13

Keywords

scssframeworkuimodularscale

Readme

| Version Badge | Build Date Badge | Build Size Badge | Code Name Badge |

Based on Bootstrap 5's sass framework, it really shines when used in a text heavy content setting, such as a blog page, where it can greatly improve the overall reading experience.

@huement/ui is not a full featured theme for bootstrap 5, nor is it suitable for building complex applications with intricate ui's that process data and allow end users to perform actions. Instead, use it on a blog, or a simple landing page, a one off project index.html page etc.

hui is easily configured via $SCSS_Variables then build with npm run css to produce a CSS file (and optionally a custom SVG based icon font). Simply load that resulting CSS file into whatever HTML5 based application you're developing and you're good to go!

INSTALL

The best way to use @huement/ui is to install it via your favorite node package manager (npm, yarn etc) and then import the sass files into your app.

  $ npm install @huement/ui
  $ yarn add @huement/ui

You will always need to import the library, and then optionally you can include to import icons here as well.

  @import '~@huement/ui/scss/mojo';

  // optionally import the icons
  @import '~@huement/ui/dist/hi/icons';

CSS VARIATION INSTALL

Rather that include the SCSS files and bundling that, you can instead simply add the CSS file to your app's <head>. Although you will likely want to build it at least once yourself, once you customize the colors etc. and then include that compiled css file.

BUILDING A CUSTOM CSS FILE

Building your own version of @huement/ui is easy and can be broken up into the following simple steps: Clone the repo, customize the SCSS variables, run the build command.

  $ git clone @huement/ui hui
  $ cd hui
  $ npm install
  # ... customize scss files ...
  $ npm run build

LIVE DEVELOPMENT MODE

If you are looking to do more than change some colors, you likely want to run the live development server with hot reloading etc to make customizing things much easier. Assuming you have already cloned the reposity are working from its root directory

  $ npm run dev

• SECTIONS

hui is designed to be SIMPLE! The folder structure is a testament to that principle.

  1. bin ❱ command line scripts
  2. dist ❱ finalized output
  3. public ❱ static files
  4. src ❱ SCSS framework
  5. tokens ❱ design variables
  6. web ❱ documentation & demo content

NOTES: • Everything in the public folder is copied to the /dist/ folder on build. • /dist/ is routinely deleted. Never attempt to make a permanent change to anything in that folder directly. Modify /scss/ and rebuild.

SCSS FRAMEWORK

TODO: this part needs a lot of work

STYLE + DESIGN TOKENS

  1. tokens/icons ❱ TODO Fantasticon details
  2. tokens/chords.json ❱ TODO explain how to generate this
  3. stack.json + color_tokens.json ❱ TODO sort out the token color files

⬦ public

So the directory structure goes like this:

   ━━❪ public ❫
   ━━━▶ demo
   ━━━▶ favicon
   ━━━▶ fonts

• web

INSTALL

...

 @huement/ui |  HUEMENT USER INTERFACE
     version |  0.1.*
    codename |  mojo