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

@polymathnetwork/polymesh-ui

v0.3.386

Published

A library for Polymath's custom UI components. Check out [the docs here](https://polymath-ui-develop.netlify.com/) and [visit the Storybook](https://polymathnetwork.github.io/Polymesh-UI) for examples how to use it.

Downloads

115

Readme

Polymath UI

A library for Polymath's custom UI components. Check out the docs here and visit the Storybook for examples how to use it.

Install

Clone the repo and run yarn to install all dependencies.

Build

yarn build

Development

For the development we recommend to work with Storybook playground which allows to easily preview component changes.

Start it with the following command:

yarn start

Testing

yarn test

Deployment

The CI automatically deploys the latest Storybook from the main branch after each commit to gh-pages branch, which is then hosted here: https://polymathnetwork.github.io/Polymesh-UI/.

Add a new component

New component should follow the following patterns

  • Styling of components should not impact other components: no external margins on the parent container (with the exception of the Heading and Paragraph primitives that have default, overridables, margins). The component styles should not take into consideration its position in the app. It should be displayable anywhere. You will use the primitives to "layout" your components in the final page (where they are being used).

Don't

<Component style={{ marginTop: '30px' }} />

Do

<Box mr={30}>
  <Component />
</Box>
  • Component should reuse primitive components as much as possible.
  • Avoid adding custom props. Create a new alternative component instead. [More infos].(https://medium.freecodecamp.org/introducing-the-single-element-pattern-dfbd2c295c5d#25ff).

Don't

  <Page centered />

Do

  <Page />
  <PageCentered />
  • Nested components should follow the Parent.Child pattern.
  • Component should be tested (snapshot + unit tests if applicable).
  • Component should have a specific page in the UI website usign an .mdx file.

Add new SVG icons

  • Export your SVG in black #000 (or replace the hex value in the following command by the color of your SVG)
  • Add the SVG files to images/{folder}
  • npx @svgr/cli --icon --replace-attr-values "#000=currentColor" --ext tsx -d images/{folder}/generated images/{folder}
  • Add an entry to images/icons/index.ts to export the icon component

Examples:

npx @svgr/cli --icon --replace-attr-values "#000000=currentColor" --ext tsx -d ./src/images/icons/generated ./src/images/icons`
npx @svgr/cli --icon --ext tsx -d src/assets/images/icons/generated src/assets/images/icons