Wispkit

A modern, lightweight web component library built with Stencil.js.

Installation

npm install wispkit

Usage

Script Tag

<link rel="stylesheet" href="https://unpkg.com/wispkit@latest/dist/wispkit/wispkit.css">
<script type="module" src="https://unpkg.com/wispkit@latest/dist/wispkit/wispkit.esm.js"></script>

Node Modules

import { defineCustomElements } from 'wispkit/loader';
import 'wispkit/dist/wispkit/wispkit.css';

defineCustomElements();

In a Stencil App

import { WkButton } from 'wispkit';

Components

Button Component

A flexible button component with multiple variants and sizes.

<!-- Primary button -->
<wk-button variant="primary">Primary Button</wk-button>

<!-- Secondary button -->
<wk-button variant="secondary">Secondary Button</wk-button>

<!-- Outline button -->
<wk-button variant="outline">Outline Button</wk-button>

<!-- Ghost button -->
<wk-button variant="ghost">Ghost Button</wk-button>

<!-- Different sizes -->
<wk-button size="sm">Small</wk-button>
<wk-button size="md">Medium</wk-button>
<wk-button size="lg">Large</wk-button>

<!-- Disabled state -->
<wk-button disabled>Disabled Button</wk-button>

Props

| Property | Attribute | Type | Default | Description | | ---------- | ---------- | ----------------------------------------------- | ----------- | -------------------------- | | variant | variant | 'primary' \| 'secondary' \| 'outline' \| 'ghost' | 'primary' | The button variant style | | size | size | 'sm' \| 'md' \| 'lg' | 'md' | The button size | | disabled | disabled | boolean | false | Whether button is disabled | | type | type | 'button' \| 'submit' \| 'reset' | 'button' | Button type attribute |

Events

| Event | Description | | --------- | ---------------------------------- | | wkClick | Emitted when the button is clicked |

Development

# Install dependencies
npm install

# Start dev server
npm start

# Build for production
npm run build

# Run tests
npm test

# Start Storybook
npm run storybook

# Build Storybook
npm run build-storybook

Publishing

# Build the package
npm run build

# Publish to npm
npm publish

License

MIT

and run:

```bash
npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Need help? Check out our docs here.

Naming Components

When creating new component tags, we recommend not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic-generated web components use the prefix ion.

Using this component

There are two strategies we recommend for using web components built with Stencil.

The first step for all two of these strategies is to publish to NPM.

You can read more about these different approaches in the Stencil docs.

Lazy Loading

If your Stencil project is built with the dist output target, you can import a small bootstrap script that registers all components and allows you to load individual component scripts lazily.

For example, given your Stencil project namespace is called my-design-system, to use my-component on any website, inject this into your HTML:

<script type="module" src="https://unpkg.com/my-design-system"></script>
<!--
To avoid unpkg.com redirects to the actual file, you can also directly import:
https://unpkg.com/[email protected]/dist/foobar-design-system/foobar-design-system.esm.js
-->
<my-component first="Stencil" middle="'Don't call me a framework'" last="JS"></my-component>

This will only load the necessary scripts needed to render <my-component />. Once more components of this package are used, they will automatically be loaded lazily.

You can also import the script as part of your node_modules in your applications entry file:

import 'foobar-design-system/dist/foobar-design-system/foobar-design-system.esm.js';

Check out this Live Demo.

Standalone

If you are using a Stencil component library with dist-custom-elements, we recommend importing Stencil components individually in those files where they are needed.

To export Stencil components as standalone components make sure you have the dist-custom-elements output target defined in your stencil.config.ts.

For example, given you'd like to use <my-component /> as part of a React component, you can import the component directly via:

import 'foobar-design-system/my-component';

function App() {
  return (
    <>
      <div>
        <my-component
          first="Stencil"
          middle="'Don't call me a framework'"
          last="JS"
        ></my-component>
      </div>
    </>
  );
}

export default App;

Check out this Live Demo.