Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 3.7 KB

README.md

File metadata and controls

51 lines (35 loc) · 3.7 KB

 

Minze

Minze

Dead-simple JS framework for native web components.

Minze (German shorthand for "Peppermint", pronounced /ˈmɪnt͡sə/) lets you rapidly build native web components.

It provides an intuitive abstraction layer around the web components API with its own fully typed JavaScript API. Including reactivity, lifecycle hooks, scoped styles, one-shot components registration, and more.

  1. You can create cross-framework component libraries or design systems and share them with your team or the world.
  2. You can add Minze to any web project and create components without even using any build tools.

Read the Docs to Learn More.

Features

  • 👶 Simple - Dive right in by scaffolding a project, installing from npm or using a CDN link.
  • ⚡ Fast - Tiny footprint ~3KB (minified and compressed).
  • 🚀 Modern - Based on the latest technologies around web components.
  • 📦 Shareable - Build component libraries or design systems. Define once, use everywhere.
  • 🎲 Framework Agnostic - Use Minze with any common framework - React, Vue, Svelte, etc ...
  • 📕 Storybook - Minze x Storybook dev environment integration.
  • 📖 Extensive Docs - Comprehensive documentation and API reference.
  • 🔒 Typed API - Scale your component library with ease by using TypeScript.

Packages

Package Version Description
create-minze create-minze version Scaffolding CLI tool for setting up a Minze dev environment.
minze minze version Dead-simple JS framework for native web components.
minze-vscode minze-vscode version VS Code language support for Minze.
vite-plugin-minze vite-plugin-minze version Vite plugin for Minze dev environment.

Contribution

See Contributing Guide. Open the Minze repo in Codeflow or StackBlitz.

Open in Codeflow Open in StackBlitz

License

MIT