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

@sheet-ui/sheet

v1.1.1

Published

A 📄 sheet is a modal used to replicate an Apple-like sheet experience on the mobile web.

Downloads

117

Readme

Sheet

A mobile web sheet that replicates the Apple-style sheet experience, designed to be accessible to all users.

Usage

Explore the Sheet examples and view the example code. To use Sheet in your project follow these instructions.

Step 1: Install peer dependency

First, make sure you have the required peer dependency framer-motion installed. If you haven't installed it yet, you can do so with the following command:

npm install framer-motion

Step 2: Install the library

After installing the peer dependency, proceed to install the @sheet-ui/sheet package:

npm install @sheet-ui/sheet

Step 3: Use the component

The component API provides consumers with a high level of rendering control through a simple interface.

import { Sheet, SheetHeader, SheetContent } from "@sheet-ui/sheet";

function Example() {
  const [isOpen, setOpen] = useState(false);
  const toggle = () => setOpen(!isOpen);

  return (
    <Sheet size="sm" isOpen={isOpen} onDismiss={toggle}>
      <button onClick={toggle}>Open</button>
      <SheetContent>
        <SheetHeader>Title</SheetHeader>
        <div>Some content goes here</div>
      </SheetContent>
    </Sheet>
  );
}

Development

To develop @sheet-ui/sheet, link the local library to a local test application created with Next.js or Remix. You can achieve this using npm link to connect your library with the test app.

To avoid issues caused by multiple React instances (such as hooks failing due to different React copies), ensure that both the library and the consumer app share the same React dependency.

In the root directory of @sheet-ui/sheet, run the following command to link React from your consumer app:

npm link ../my-library-consumer/node_modules/react

Then in the root directory of the consumer app:

npm link @sheet-ui/sheet

Disclaimer

Avoid using sheets on desktop platforms; instead, opt for regular modals in desktop applications. While drawing inspiration from Apple's operating system can be beneficial, it's important to remember that the web is a unique platform. Web design should respect its distinct nature, rather than always attempting to mimic native iOS or other operating systems entirely. Ensure you are following web specifications and accessible web standards.