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

@newtonschool/grauity

v1.3.1

Published

Design System for Newton School

Downloads

494

Readme

About gra.UI.ty

Inspired by the natural laws that guide the cosmos, gra.UI.ty (pronounced "gravity") is a React-based UI component library designed to harmonize simplicity and functionality. Our mission is to provide developers and designers with the tools to create intuitive and aesthetically pleasing user interfaces.

Philosophy

Like gravity itself, the principles of great design are universal, omnipresent, yet often unobserved. With gra.UI.ty, we aim to tap into these fundamental elements to craft UI components that not only look stunning but feel inherently right.

Component Naming Convention

gra.UI.ty components should be prefixed by NS. For example, NSButton, NSTable, NSInput

Alias

gra.UI.ty is also affectionately known as grauity, graUIty or simply as gravity

Key Features

  • Comprehensive Component Set: From buttons and dialogs to complex data grids and sliders, gra.UI.ty has everything you need. (Coming soon!)
  • Semantic and Mindful Components: Our components are more than just divs. Each one is thoughtfully designed with semantic HTML for better accessibility and SEO. We aim to ensure that each component has a clear and meaningful structure.
  • Modular and Extensible: Integrate seamlessly with your projects, adding only what you need without bloating your codebase.
  • Theming and Customization: Easily adapt the components to match your brand or project’s aesthetic. (Coming soon!)
  • Accessibility First: Built with accessibility in mind, ensuring that your applications are usable by everyone. (We'll get there...)

Setup gra.UI.ty to make it your own!

Developing Components

To develop components gra.UI.ty locally, follow these steps:

# Install all packages via NPM in grauity
grauity$: npm install

# Initialize submodules for iconland
grauity$: git submodule init
grauity$: git submodule update --recursive

# Build icons when running for first time
grauity$: npm run build-icons

# To run storybook, run this command in grauity
grauity$: npm run storybook
# Then head to localhost:6006

# To build storybook, run this command in grauity
grauity$: npm run build-storybook

Integrating locally with newton-web

To integrate grauity locally with newton-web, follow these steps:

# Firstly, install all packages via NPM in grauity
grauity$: npm install

# To build grauity, run this command
grauity$: npm run build

# Then, run these commands in newton-web:
newton-web$: npm install ../grauity
# This is assuming `grauity` and `newton-web` share same parent folder

# Now, link react, react-dom from grauity to newton-web:
newton-web$: npm link ../gruity/node_modules/react ../gruity/node_modules/react-dom --legacy-peer-deps

# Finally, run newton-web
newton-web$: npm run dev

After you have made changes in grauity, build it.

grauity$: npm run build

If changes are not showing up even after rebuilding, you may have to delete newton-web/node_modules/@newtonschool/grauity and install it again using

newton-web$: npm i ../grauity --legacy-peer-deps
newton-web$: npm run dev

Then simply import components you want from @newtonschool/grauity in newton-web like so:

import { NSButton, BUTTON_VARIANTS_ENUM } from '@newtonschool/grauity';

And use it as you wish

import { NSButton } from '@newtonschool/grauity';

export const MyComponent = () => (
    <NSButton
        variant="primary"
        onClick={() => {
            setShowFormErrors(true);
        }}
    >
        Click me!
    </NSButton>
);

How to's

Add icons

Adding new icons is easy. Design team to provide .svg files for new icons, and they are to be added to the ./iconland/seeds/ directory. Then follow these steps:

0. Update the iconland submodule in grauity

grauity$: git submodule update --remote --merge

1. Generate icons

grauity$: npm run build-icons:generate

2. Optimise icons (from [iconland/seeds/] to iconland/optimised/ )

grauity$: npm run build-icons:optimize

3. Build font icons from optimised icons

grauity$: npm run build-icons

Use icons in newton-web

To use grauity icons, add the following import in global-styles.scss or any root-level CSS/SCSS file. Make sure CSS/SCSS loaders are setup properly in your app.

@import '~@newtonschool/grauity/dist/css/index.scss';