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

@stead/grid

v0.1.1

Published

Grid for digital and software products using the Stead Design System

Downloads

2

Readme

@stead/grid

Grid for digital and software products using the Stead Design System

Getting started

To install @stead/grid in your project, you will need to run the following command using npm:

npm install -S @stead/grid

If you prefer Yarn, use the following command instead:

yarn add @stead/grid

Usage

@stead/grid has three primitive class types to use in order to structure your application. They include:

  • st-grid, defines the overall grid context and sets some useful attributes like width and margin
  • st-row, defines a row of items in a grid
  • st-col, used to define individual columns

You can use a combination of these classes to build a layout. For example, if we wanted a 4 column layout for a small breakpoint we could use the following markup:

<div class="st-grid">
  <div class="st-row">
    <div class="st-col">1/4</div>
    <div class="st-col">1/4</div>
    <div class="st-col">1/4</div>
    <div class="st-col">1/4</div>
  </div>
</div>

While this layout can work for some grid usage scenarios, we probably will want more control over how many columns our layout will span at each given breakpoint.

By default, @stead/grid uses the breakpoints defined in @stead/layout. There are five breakpoints: sm, md, lg, xlg, and max. You can use each one in combination with a column to specify the number of columns to span at a given breakpoint. For example, we could rewrite the above example to be:

<div class="st-grid">
  <div class="st-row">
    <div class="st-col-sm-1">1/4</div>
    <div class="st-col-sm-1">1/4</div>
    <div class="st-col-sm-1">1/4</div>
    <div class="st-col-sm-1">1/4</div>
  </div>
</div>

The .st-col-sm-1 class names tells us that this <div> should only span one column at our sm breakpoint. By default, as we scale beyond the breakpoint the layout will still take up a percentage of the overall width.

📖 API Documentation

If you're looking for @stead/grid API documentation, check out:

🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide! 👀

📝 License

Licensed under the Apache 2.0 License.