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

@lightful/ray

v4.1.0

Published

Lightful style guide and component library

Downloads

651

Readme

Ray

Ray is Lightful's CSS and React component library. The package includes a CSS file that can be dropped in to any website or single-page application and a set of React components.

Installation

CDN

The Ray CSS file is available at the following CDN link:

https://cdn.jsdelivr.net/npm/@lightful/[email protected]/dist/css/ray.css

npm

Install the package with npm or yarn:

npm install @lightful/ray
yarn add @lightful/ray

Contributing

Creating a component

Start by running yarn create:component --name=MyComponent. This will create a new component file and associated test, saving time and helping to ensure all components are built in a consistent way.

Adding an icon

Icons should be in SVG format with a 24px width/height and ideally made of a single path with a fill of #ADB5BD.

Once you have obtained a new icon SVG it should be added to the src/icons directory and then you should run yarn build:icons - this will make the icon available for use in the React <Icon /> component.

CSS

Ray has been built on top of Bootstrap so includes Bootstrap CSS with variables changed to match the Ray style guide.

Please refer to the Bootstrap documention to get started.

Using Ray during development

If you are working on changes to Ray and wish to test them out in your application before publishing a new version of Ray to npm you can use yarn link.

First, run the link command in Ray:

yarn link

Then, in the application you are using Ray in:

yarn link @lightful/ray

This will create a symlink to your local copy of Ray to use in place of the package installed from npm.

Important: if you are continuing to make changes to Ray remember to rebuild yarn build for them to be picked up in your application. Or if you are continuously making changes, run yarn watch:js to watch for changes and rebuild.

To stop using the linked version you can use yarn unlink.

Using Ray

The components and icons can be viewed using the storybook packaged. There is a script you can run to get it working locally:
nvm use 12.19.1
yarn storybook

It is also hosted on AWS Amplify which automatically deploys new builds, so you can check the storybook on there as well.

There is also a Ray Design System in Figma. Ask for the link.

Finding Ray CSS classes

In Chrome:
Inspect > Elements > Styles

There's a Filter field, click the .cls button next to it, a new field will show beneath called Add new class.

Type in that field and it should bring up matching searches.

Releases

Releases are handled by np which provides and interactive UI for generating releases, safe-guarding against various mistakes and improving consistency in releases.

We follow semantic versioning, please ensure you are familiar with this approach before making a release.

Once ready, run yarn release to start a new release.