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

@locomotivemtl/grid-helper

v1.0.0

Published

Creates an overlay grid for web development, allowing designers and developers to visualize the grid structure based on design guidelines.

Downloads

71

Readme

GridHelper

The GridHelper class is a utility that creates an overlay grid for web development, allowing designers and developers to visualize the grid structure based on design guidelines. It provides easy toggling and responsiveness based on screen breakpoints.

Features

  • Toggle the grid visibility with Control + g (customizable key).
  • Define grid structure: number of columns, gutter width, margin, color, and opacity.
  • Supports custom breakpoints, allowing different grid configurations at various screen widths.
  • Automatically updates the grid when the window is resized.

Installation

npm install @locomotivemtl/grid-helper

Usage

Basic Example

To initialize the grid with default settings:

const gridHelper = new GridHelper();

Custom Configuration

You can provide a custom configuration to adjust the grid properties:

const gridHelper = new GridHelper({
    columns: 4,
    gutterWidth: '10px',
    marginWidth: '10px',
    color: 'blue',
    opacity: 0.2,
    key: 'g',
    breakpoints: {
        '768': { columns: 8, gutterWidth: '15px' },
        '1024': { columns: 12, gutterWidth: '20px' }
    }
});

You can also use CSS variables to bind them with your CSS logic, especially for columns, gutterWidth, and marginWidth. This can be useful in cases where you dynamically update CSS variables within media queries.

const gridHelper = new GridHelper({
    columns: 'var(--grid-columns)',
    gutterWidth: `var(--grid-gutter)`,
    marginWidth: `var(--grid-margin)`,
});

Options

Main Options

| Option | Default Value | Type | Description | |---------------|---------------|---------------------|-----------------------------------------------------------------------------| | columns | 12 | number \| string | Number of columns in the grid or a CSS variable for columns. | | gutterWidth | '16px' | string \| CSSVariable | Width of the gutters between columns or a CSS variable for gutter width. | | marginWidth | '16px' | string \| CSSVariable | Width of the margins around the grid or a CSS variable for margin width. | | color | 'red' | string | Color of the grid in CSS format. | | opacity | 0.1 | number | Opacity of the grid. | | key | 'g' | string | Key to toggle the grid visibility (with Control key). | | breakpoints | undefined | object | Breakpoint configurations for responsive grids. |

Breakpoint Options

| Option | Type | Description | |---------------|--------------------------|---------------------------------------------------------------| | columns | number \| string | Number of columns in the grid or a CSS variable for columns. | | gutterWidth | string \| CSSVariable | Width of the gutters between columns or a CSS variable for gutter width. | | marginWidth | string \| CSSVariable | Width of the margins around the grid or a CSS variable for margin width. | | color | string | Color of the grid in CSS format. | | opacity | number | Opacity of the grid. | | key | string | Key to toggle the grid visibility (with Control key). |