Create your HTML5 Web Component with Svelte. Made your web components with this friendly boilerplate.

This project is free, open source and I try to provide excellent free support. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. THANK YOU!

• 💡 Features
• 🕹 Demo
• 👔 Screenshot
• 🚀 How to use
• • 🌎 Web
• • 📦 Webpack/Browserify
• • 📖 Wordpress
• • 🔵 React
• • 🔴 Angular
• • 🟠 Svelte
• • 🟢 Vue
• 📚 Documentation
• • 🧰 Options / Attributes
• • 🎨 CSS Customization
• 🔨 Developer Mode
• 👨‍💻 Contributing
• 🐛 Known Bugs
• 🍻 Community:
  • Discord (🇬🇧 English Channel | 🇮🇹 Italian Channel | 🇵🇱 Polish Channel)

• [✔️] Easy to use
• [✔️] MIT License
• [✔️] Text animation by Nooray Yemon on Codepen
• [✔️] Friendly boilerplate + Github templates
• [✔️] Powered by svelte framework
• [✔️] Without jQuery depencence
• [✔️] Configurable with attributes
• [✔️] Customization with CSS Style
• [✔️] HTML5 Custom Elements - Native webcomponents
• [✔️] Work with: Browserify / Webpack / ReactJS / Svelte / Angular / Vue / Wordpress
• [✔️] Typescript + TSPaths preconfigured
• [✔️] Userfriendly folders tree
• [✔️] Prettiers and ESLint preconfigured
• [✔️] all-contributors-cli and all-shields-cli preconfigured
• [✔️] JEST Test preconfigured
• [✔️] Full async code
• [✔️] i18n translations
• [✔️] Github and Vscode dotfiles preconfigured
• [✔️] Translations: 🇬🇧 🇮🇹 🇵🇱 (Help me ❤️)

See Demo here.

1. Add html code to your page:

<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>

2. Require javascript in yourpage (before </body>):

<script src="https://cdn.jsdelivr.net/npm/@ptkdev/svelte-webcomponent-boilerplate@latest/dist/webcomponent.js"></script>

You can replace @latest with specific version, example @2.0.1.

Below is available a description of options values.

1. Install npm module: npm install @ptkdev/svelte-webcomponent-boilerplate --save
2. Add html code to your page:

<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>

3. Require javascript in your app:

require("@ptkdev/svelte-webcomponent-boilerplate");

or

import "@ptkdev/svelte-webcomponent-boilerplate";

Below is available a description of options values.

1. Download wordpress plugin from mirror and install it.
2. Add code to your html widget, example: Appearance --> Widget --> insert HTML Widget and paste html code:

<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>

You can insert this html code in posts, widget, html box or theme.

1. Install npm module with npm install @ptkdev/svelte-webcomponent-boilerplate@latest --save:
2. Import module in your src/App.js on header:

import "@ptkdev/svelte-webcomponent-boilerplate";

3. Add html code to your App.js template:

<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>

1. Install npm module with npm install @ptkdev/svelte-webcomponent-boilerplate@latest --save:
2. Import module in your app/app.modules.ts on header:

import "@ptkdev/svelte-webcomponent-boilerplate";

3. Add html code to your html component:

<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>

1. Install npm module with npm install @ptkdev/svelte-webcomponent-boilerplate@latest --save:
2. Import module in your src/App.svelte on header:

import "@ptkdev/svelte-webcomponent-boilerplate";

3. Add html code to your html component:

<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>

1. Install npm module with npm install @ptkdev/svelte-webcomponent-boilerplate@latest --save:
2. Import module in your src/App.vue and add webcomponent to ignoreElements of vue config:

import Vue from "vue";
import "@ptkdev/svelte-webcomponent-boilerplate";

Vue.config.ignoredElements = ["svelte-webcomponent-boilerplate"];

3. Add html code to your html component:

<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>

<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>

You can overwrite default css with selector ::part, example:

<style>
	svelte-webcomponent-boilerplate::part(flip) {
		border: 2px solid red;
	}
</style>

Part attribute is, generally, suffix of a class. Use chrome inspector for get the correct value of part="" attributes. See MDN selector ::part docs.

1. Clone this repository or download nightly, beta or stable.
2. Run npm install
3. Run npm run dev
4. Run http://localhost:5000

Run npm run docs

Thanks to all our backers! 🙏 Donate 3$ or more on paypal, ko-fi, github or patreon and send me email with your avatar, name and web site url.

I ❤️ contributions! I will happily accept your pull request! Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together 👯 and remember to insert your name in .all-contributorsrc and package.json file.

Thanks goes to these wonderful people (emoji key):

Patryk Rzucidło 💻 🌍 📖 🐛

💰 In the future, if the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!

• Code and Contributions have MIT License
• Images and logos have CC BY-NC 4.0 License (Freepik Premium License)
• Documentations and Translations have CC BY 4.0 License