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

patternfly-webcomponents

v0.3.0

Published

PatternFly Web Components

Downloads

42

Readme

PatternFly Web Components

This project will provide a set of core web components for the PatternFly project.

Image of PatternFly

https://patternfly-webcomponents.github.io/

Note: This project is in alpha state and currently makes use of Patternfly 4 / Bootstrap 3 CSS. In future releases, we will add support for Patternfly 5 / Bootstrap 4 Atomic CSS.

Getting Started

   npm install --save patternfly-webcomponents

JS

Include dist\js\patternfly.js to load all components or load the *.js components individually.

CSS

Load the web component CSS in dist\css\patternfly-webcomponents.css alongside Patternfly CSS.

API Docs

API documentation for each component is generated with JSDocs. You can view these docs here:

https://patternfly-webcomponents.github.io/patternfly-webcomponents/

Build

npm install
gulp build

Serve

gulp serve

URL: http://localhost:3000/index.html

  • Uses gulp watch and browser-sync

image

Testing

Unit and Peformance test notes can be found in TESTS.md

Test pages for each component can also be found at the following url: https://rawgit.com/patternfly-webcomponents/patternfly-webcomponents/master-dist/index.html

Tech Notes

Repository uses the following:

  • Babel - Essentially an ECMAScript 6 to ECMAScript 5 Javascript compiler. It allows you to use ES6 features in your projects and then compiles ES5 for you to use in production.
  • Plumber - Prevent pipe breaking caused by errors from gulp plugins
  • Webpack - Webpack is a module bundler. Webpack takes modules with dependencies and generates static assets representing those modules.

Gotchas

If you choose to include components individually, you will also want to include dist\js\customElementShim.js. This resolves an issue currently with the HTMLElement prototype in Safari.

Source

Git Commit Guidelines

PatternFly Web Components uses a semantic release process to automate package publishing, based on the following commit message format.

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject (full explanation):

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Patch Release
fix(pencil): stop graphite breaking when too much pressure applied
Feature Release
feat(pencil): add 'graphiteWidth' option
Breaking Release
perf(pencil): remove graphiteWidth option