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

gatsby-theme-simpwa

v3.0.4

Published

Configurable template for building simple PWA's

Downloads

7

Readme

Gatsby theme for simple PWA's

This theme provides a generic, re-usable and modular layout for developing simple PWA's with responsive left/right sidebars. The intended use case is for simple web apps aiming to present themselves as close as possible to native mobile apps. The idea here is that a simple app can stuff all its content in the main screen and its sidebars.

Priorities:

  • Single codebase for both desktop and mobile
  • PWA experience comparable to native apps
  • Touch-friendly: sidebars should respond to swiping
  • Responsive design: should work on any viewport size
  • Simple sidebar design: see minimal implementation

How it looks:

Installation

  • Create a new project based on this theme's starter:

    gatsby new my-app https://github.com/davidde/gatsby-starter-simpwa
    cd my-app
    gatsby develop
  • Or install the theme to an existing project and configure it:

    npm install gatsby-theme-simpwa

    Then, in your gatsby-config.js, add the theme to your plugins, and override the default PWA manifest options:

    module.exports = {
      plugins: [
        {
          resolve: 'gatsby-theme-simpwa',
          options: {
            name: 'my-app',
            short_name: 'my-app',
            start_url: '/',
            background_color: '#663399',
            theme_color: '#663399',
            display: 'standalone',
            icon: 'src/images/icon.png', // This path is relative to the root of the site.
          },
        },
      ],
    }

Usage

The theme provides 4 main components to build your app; a parent <Layout> component, and its 3 children, <Leftside>, <MainView> and <Rightside>. Since the sidebar implementation relies on flexbox, it is important to specify the child components in that exact source order (left to right), although either of the sidebars can be omitted.

Simply import them into your code to start building:

import { Layout, MainView, Leftside, Rightside } from 'gatsby-theme-simpwa';

<Layout> component

The parent component that enables its 3 children components to work properly.

Optional props:

  • theme: The theme to use for your app: 'light', 'dark' or 'joy'. Defaults to 'light'.
  • leftActive: Bool (not string) indicating whether the left sidebar should be active on first load. Defaults to true.
  • rightActive: Bool (not string) indicating whether the right sidebar should be active on first load. Defaults to true.
  • mutex: Bool indicating whether the sidebars should mutually exclude each other from being active. Defaults to false.
  • sidestrip: String indicating the status of the small hoverable strip at the edge of the screen:
    'on', 'hidden', 'off', 'off-touchscreens'. Defaults to 'off-touchscreens'.

NOTE:
The Layout component's props are initialisation props. They will not trigger a rerender on subsequent updates, since they are immediately written to state.

<Leftside> and <Rightside> components

The left and right sidebars of your app. Should be direct descendants of <Layout>, and Leftside should be specified first in source order (before MainView), and Rightside last (after MainView). Either can be omitted if you only want a single sidebar.

Props:

  • header: The header of the sidebar.
  • icon: Font Awesome icon from @fortawesome/free-solid-svg-icons that triggers the sidebar.

<MainView> component

The main content of your app. Should be a direct descendant of <Layout>, and specified second in source order (after Leftside).

Props:

  • header: The header of your app.

Customization

Customization is fairly simple due to a modular approach to styling/theming.

Even the theme 's got themes!

These subthemes are defined in the _vars.scss partial in src/components/main/.
You can shadow this file together with the main layout.scss and modify the subtheme variables, or create your own subthemes altogether!