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

@justeattakeaway/pie-webc

v0.5.54

Published

Component bundle containing all PIE web components

Downloads

2,377

Readme

Table of Contents

  1. Introduction
  2. Installation
  3. Contributing

pie-webc

pie-webc is a wrapper package which contains all PIE web components.

This means that after installing this package as a dependency, you can use as many PIE web components as you like, without bloating your application with unused code, or slowing it down with unnecessary component registrations in the browser.

Installation

To install pie-webc in your application, run the following on your command line:

npm i @justeattakeaway/pie-webc

yarn add @justeattakeaway/pie-webc

Importing components

Simply import each component individually using its specific entrypoint.

import '@justeattakeaway/pie-webc/components/button.js';
import '@justeattakeaway/pie-webc/components/modal.js';

Or for React applications:

import { PieButton } from '@justeattakeaway/pie-webc/react/button.js';
import { PieModal } from '@justeattakeaway/pie-webc/react/modal.js';

For full information on using PIE components as part of an application, check out the Getting Started Guide.

For maintainers

There is a command that can be run (from the root of the monorepo) which adds all PIE components to this package:

npx add-components

This does the following:

  1. Loops through the (root) packages/components folder to find all of the PIE components, ignoring non-component folders, helper packages, and this package itself.
  2. Adds a .js and .d.ts file for each component to both the components and react directories (inside pie-webc).
  3. Adds entries for each component to the exports field in pie-webc/package.json.
  4. Adds entries for each component to the dependencies field in pie-webc/package.json, using the current (latest) version.

Generally, there should be no need to run this script. The only time it should be run is when a new component is created using the component generator. The generator runs this script automatically after creating a new component.

changeset should also make sure that the versions of components are up-to-date.

Contributing

Check out our contributing guide for more information on local development.