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

@findkit/ui

v1.5.0

Published

Findkit Search UI

Downloads

1,291

Readme

Findkit UI package

See documentation at https://docs.findkit.com/ui

Contributing

Get pnpm 7 and clone the repository

git clone https://github.com/findkit/findkit.git

Install node modules

cd findkit/packages/ui
pnpm install

Unit tests with Vitest

Run

pnpm vitest

Manual testing

Start development server and build watcher with

pnpm dev

This will serve the files from the e2e directory.

Try http://localhost:28104/static/single-group?fdk_q=wordpress for example.

E2E Tests with Playwright

While the development server is running you can execute the Playwright tests with:

pnpm playwright-test --headed
pnpm playwright-visual --headed

Updating the visual snapshots

Run

pnpm playwright-update

and review and commit the changes.

Manual packaging

When you want test the changes in your project you must build the package and install it to your project.

Build everything first

pnpm build

and pack to .tgz file

pnpm pack

This will create a file like findkit-ui-0.0.1.tgz which can be installed to your project. When installing it you should use the package manager your project is using.

cd /path/to/project
npm install /path/to/findkit/clone/findkit-ui-0.0.1.tgz

Because this is a local build you must disable the CDN usage: https://docs.findkit.com/ui/advanced/disable-cdn

Conventions

Privates

This package uses custom convention for private properties and methods. Every private method and property should have the Typescript private keyword and PRIVATE_ prefix. The privates are mangled using esbuild when the package is published.

The native Javascript privates cannot be used because they produce too much code when transpiled down to legacy Javascript and they are too new ship as is.