Skip to content

stylizedjs/stylized

Repository files navigation

Stylized CSS framwork

GitHub last commit GitHub contributors GitHub GitHub repo size GitHub main language repository

Docs · Installation · Stylizers

Documentação em Português   Documentación en Español  

✨ Features

  • ▶️ Easy start — just install, import and start using
  • 🎨 Easy customization and adaptation for your project
  • 🤝 High compatibility with libraries and frameworks
  • 📦 Complete package of Stylized components
  • 🌍 Multilingual documentation
  • 💾 Extremely lightweight

✔️ Prerequisites

  • Node.js
  • NPM

📦 Installation

npm install stylizedjs

🔨 Usage

If you're using just HTML and JavaScript raw, you can build the components with the following command:

npm run build

And then, just import into the HTML file each component you need as the example below:

<script type="module" src="./dist/components/command-line/command-line.js"></script>
<script type="module" src="./dist/components/header/header.js"></script>
<script type="module" src="./dist/components/button/button.js"></script>
<script type="module" src="./dist/components/alert/alert.js"></script>
<script type="module" src="./dist/components/input/input.js"></script>

🤝 Contributing

This is an open source project which accepts contributions for anyone. Feel free to contribute after reading our contribution guideline.

❔ FAQ

What is Stylized?

Stylized is an UI library created with Lit, a framework created and maintained by Google. Stylized comes with dozens of components for JavaScript and TypeScript applications.

How compatible is Stylized with browsers?
Chrome logo Edge logo Firefox logo Opera logo
67+ ✅ 79+ ✅ 63+ ✅ 64+ ✅

Browser compatibility is based on support for web components. You can get more information about web components here and here.

I don't know how to code. Is there any other way to contribute?

Yes! There are a lot of ways to contribute with Stylized. You can star the repository, share with your friends, contribute with no code issues or just help with translations in the documentation.

How to request the creation of a new component?

It's possible to open an issue using the label enhancement. Enter as much information as possible and, if possible, give examples.

📝 License

This project is licensed under the MIT license