simonknittel/components

This repository contains the interface component library for my personal website.

Under the hood the library makes use of Stencil for Web Components.

---

Disclaimer: Like my personal website, this component library is still under heavy development, so regular breaking changes can be expected. This won't change until version 1.0 releases.

Links

• Documentation via Storybook
  • Overview of all components and instructions on how to use them
  • Reflects the latest published release
• Visual Regression Testing via Chromatic
  • Tests each commit to the master branch
• Components "live in action" on my personal website
  • Uses the latest commit of the master branch

Usage

React

Install @simonknittel/components-react as dependency:

npm install @simonknittel/components-react

Add this to your JavaScript entry point:

import { applyPolyfills, defineCustomElements } from '@simonknittel/components/loader'

applyPolyfills().then(() => {
  defineCustomElements()
})

Import components like this:

import { SkBadge } from "@simonknittel/components-react"

export default function MyReactComponent() {
  return <SkBadge>Hello World!</SkBadge>
}

Contributing

See CONTRIBUTING.md