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

sui-web-components

v0.0.1

Published

Web Components with Utility Props for styling

Downloads

2

Readme

Screenshot of Utility Web Components in action with the <sui-box> component

Built With Stencil

Utility Web Components

Component library built using Web Components and utility-props. Build and style your app with flexible and declarative components using "utility CSS" style props.

<sui-box width={[1, 0.5, 0.3]} bg="black" color="white" p="2"></sui-box>

Browse component documentation in Storybook.

Components

  • <sui-base>
  • <sui-box>
  • <sui-button>
  • <sui-input>
  • <sui-link>
  • <sui-select>
  • <sui-switch>
  • <sui-text>
  • <sui-textarea>

Getting Started

To start building a new web component using Stencil, clone this repo to a new directory:

git clone https://github.com/whoisryosuke/sui-web-components.git
cd sui-web-components
yarn
yarn start

To build the component for production, run:

yarn build

To run the unit tests for the components, run:

yarn test

Need help? Check out the StencilJS docs here.

Using these component

Script tag

  • Publish to NPM
  • Put a script tag similar to this <script src='https://unpkg.com/[email protected]/dist/mycomponent.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

Node Modules

  • Run npm install sui-web-components --save
  • Put a script tag similar to this <script src='node_modules/sui-web-components/dist/mycomponent.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

  • Run npm install sui-web-components --save
  • Add an import to the npm packages import sui-web-components;
  • Then you can use the element anywhere in your template, JSX, html etc

Storybook

yarn storybook

Requires production build of StencilJS components (for the ./dist/ folder). Run yarn build before running Storybook and after any changes to components. Can't use with StencilJS in development mode, requires different configuration, see here.

CSF Format

  • To use the Web Component knobs, make sure to provide the default export {} with the web component name as a property. Use full component name (e.g. <sui-button> would be component: "sui-button"). Then make sure to add the decorator and options properties with the knobs and knob panel name:
import { withKnobs } from "@storybook/addon-knobs";
import { withWebComponentsKnobs } from "storybook-addon-web-components-knobs";

export default {
  title: "Demo",
  component: "sui-button",
  decorators: [withKnobs, withWebComponentsKnobs],
  parameters: { options: { selectedPanel: "storybookjs/knobs/panel" } }
};

MDX Format

  • Import components from production build: import { Link } from "../../../dist/index.js";
  • To use the Web Component knobs, make sure to provide <Meta> component with the web component name as a prop. Use full component name (e.g. <sui-button> would be component: "sui-button").
import { withWebComponentsKnobs } from "storybook-addon-web-components-knobs";
import { withKnobs, text, number } from "@storybook/addon-knobs";

<Meta
  title="Components/Link"
  component={Link}
  parameters={{
    component: "sui-link",
    decorators: [withKnobs, withWebComponentsKnobs],
    options: { selectedPanel: "storybookjs/knobs/panel" }
  }}
/>

Your description here

## Example

<Preview withToolbar>
  <Story name="Simple">
    {html`
      <sui-link href="#">Hello World</sui-link>
    `}
  </Story>
</Preview>

## Props

<Props of="sui-link" />