Skip to content

morbidick/bootstrap-webcomponents

Repository files navigation

Bootstrap Web Components

CircleCI npm version npm bundle size (minified + gzip)

🛠 Status: In Development

Components get implemented as needed. PRs welcome!

Rewrite of bootstrap components as web components. See the demo for all implemented features.

Motivation

This isn't just a webcomponents wrapper around the bootstrap css, this aims to be a clean and simple rewrite easily understandable to everyone new to the webcomponents standards.

  • No build chain / preprocessors
  • allow easy theming via css custom properties
  • provide a clear api to end users in the form of attributes
  • Use web standards over big libraries where possible (even if that means loosing compatibility eg. dialog element)
  • Provide support to projects to include polyfills and buildsteps for the above points

Install

npm install @morbidick/bootstrap

Usage

Import into your module script:

import { BsButton, BsBadge } from "@morbidick/bootstrap/elements.js"

Alternatively, load a bundled version from CDN:

<script src="https://unpkg.com/@morbidick/bootstrap@latest/dist/elements.bundled.min.js"></script>

Use it in your web page:

<bs-button href="#link">Click Me</bs-button>
<bs-badge class="warning">warning</bs-badge>

Development

View the contributing notes for instructions and further resources.