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

@shervin/core

v0.0.3-alpha.0

Published

VideoAmp's Component library

Downloads

4

Readme

PreAmp Core

PreAmp Core in VideoAmp's component library.

File structure

core/
  components/
    componentGroup/              #holds all related components
      singleComponent/           #single component
        examples/                #example use cases
        subComponents/           #child components used only by this component
        component.md             #documentation
        component.tsx            #component definition
        component.spec.tsx       #tests

Adding components

  • Component definition
    • include the description in a comment above the component definition
    • component should be a named export, not default
  • Props
    • named with this format [ComponentName]Props
    • include the descriptions in a comment above each prop
  • Examples
    • include enough examples to show off all use cases for this component
  • Tests
    • TBD
  • SubComponents
    • subComponents used only this component should live in /subComponents. If a child component is used in multiple places, then it should be pulled out as a stand alone component
  • Types
    • include only prop interfaces in component definition file
    • put all other types in core/types/ for reuse

Example Component.tsx file

import React from 'react';

interface ComponentProps {
    /** Description of first prop */
    propOne: string;
    /** Description of the second prop */
    propTwo: boolean
}

/**
 * This is a description of Component.
 */
export const Component: React.SFC<ComponentProps> = (
    props: ComponentProps
): React.ReactElement<any> => {
    ...
};

How to publish

TODO

Using in another project

import multiple components at once from @shervin/core

import { Button, Card, TextField } from '@shervin/core';