\n\n# Beer CSS\n\nBuild material design interfaces in record time...\n\n...without stress for devs πΊπ\n\nCheers, www.beercss.com\n\n# Sponsors\n\nBeer CSS is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome sponsors and backers. If you'd like to join them, please consider sponsoring Beer CSS's development.\n\n
\n\n# Why?\n\n- π₯ The first CSS framework based on Material Design 3\n- π Latest \"M3 Expressive\" already.\n- β¬οΈ 10x smaller than others CSS frameworks based on Material Design.\n- π§ββοΈ Translates Material Design to HTML semantic standard.\n- π€ Ready to use with any JS framework.\n- π― Highly focused on DX.\n- π« No build steps, configurations or dependencies.\n- β¨ Build modern interfaces without any custom CSS.\n- β Compliance with web standards.\n- π― Google Lighthouse friendly.\n\n# A lightweight beer\n\nLet's be honest, in the ever-evolving world of web development, we're all looking for that sweet spot: powerful functionality without the bloat. We want speed, efficiency, and something that doesn't feel like lugging around a digital elephant. And if you're looking at the chart below, you're probably thinking, \"Wow, XYZ is huge!\". You're not wrong. But look all the way to the top. See that? That's Beer CSS.\n\n\n\n# The principles\n\nThis project was guided by the **\"Germany Beer Purity Law\"** or **\"Reinheitsgebot\"** created in 1516. This law states that beer should only be brewed with the following ingredients: **water**, **barley malt** and **hops**. Only 3 ingredients. Exciting, right? So we thought about it and our 3 ingredients are: [Settings](docs/SETTINGS.md), [Elements](docs/ELEMENTS.md) and [Helpers](docs/HELPERS.md). This sounds weird at first, because it's not BEM, OOCSS, SMACSS, ITCSS, \"Utility first\" or any other approach. Our approach doesn't avoid some bad practices, but is lightweight, tasty and pure like a beer. Just try it and feel it! π\n\n```\n| SETTINGS | // The settings affects all document\n|---------------|----|\n| | |\n| ELEMENTS | | // The elements are the components, widgets or tags\n| | |\n|---------------| |\n| | |\n| | |\n| HELPERS |----| // The common helpers makes the elements more scalable and customizable\n| |\n| |\n|---------------|\n```\n\n# Get started\n\n### DEFAULT VERSION\n\n```html\n\n\n\n```\n\n```js\nnpm i beercss\nnpm i material-dynamic-colors\n```\n\n```js\nimport \"beercss\";\nimport \"material-dynamic-colors\";\n```\n\n### SCOPED VERSION\nApplied on child elements of `<* class=\"beer\">...`.\n\n```html\n\n\n\n```\n\n```js\nnpm i beercss\nnpm i material-dynamic-colors\n```\n\n```js\nimport \"beercss/scoped\";\nimport \"material-dynamic-colors\";\n```\n\n### CUSTOM ELEMENT VERSION\nApplied on child elements of `...`.\n\n```html\n\n\n```\n\n```js\nnpm i beercss\nnpm i material-dynamic-colors\n```\n\n```js\nimport \"beercss/custom-element\";\nimport \"material-dynamic-colors\";\n```\n\n### LOCAL CDN VERSION\n\nDownload all files from CDN https://cdn.jsdelivr.net/npm/beercss@4.0.23/dist/cdn/ and https://cdn.jsdelivr.net/npm/material-dynamic-colors@1.1.4/dist/cdn/. Now put the files inside a new folder in your project (like `/beercss` for example):\n\n```html\n\n\n\n```\n\n### HTML\n\nYou can use this html to setup your project. See on [Codepen](https://codepen.io/leo-bnu/pen/yLKLPxj). More about in [Main layout](docs/MAIN_LAYOUT.md).\n\n```html\n\n\n \n \n \n \n \n Hello world\n \n \n \n \n \n \n\n \n\n \n\n \n \n
Welcome
\n
The beer is ready!
\n \n \n\n```\n\n**The `beer.min.js` and `material-dynamic-colors.min.js` are optional, but could be required for some use cases.**\n\n### β DO:\n\n```\n// 1 setting to 1 document\n...\n\n// 1 element to N helpers\n...\n
...
\n\n// 1 main element per document\n<...>\n \n\n\n// inline/block elements in block elements\n
\n \n \n
\n\n// write css like this\n.element.helper {...}\n.element > .element {...}\n.element > .helper {...}\n```\n\n### π« DON'T:\n\n```\n// N elements to 1 tag\n
...
\n...\n\n// element with dependencies\n
\n
...
\n
...
\n \n
\n\n// N main elements per document\n<...>\n \n \n\n\n// block elements in inline elements\n\n \n\n\n// write css like this\n.element.element {...}\n.element .element {...}\n.element .helper {...}\n```\n\n# Documentation\n\nComplete documentation and examples available at:\n\n- **[Documentation](docs/INDEX.md)**\n- **[Codepen](https://codepen.io/collection/XydYMB)**\n- **[Homepage](https://www.beercss.com)**\n\n# Contributing guide\n\nHi! We are really excited that you are interested in contributing to Beer CSS! Before submitting your contribution, please make sure to take a moment and read through the following guidelines:\n\n[Beer CSS Contributing Guidelines](CONTRIBUTING.md)\n\n# License\n\n[MIT](https://opensource.org/licenses/MIT)\n\n# Cheers to all stargazers π»\n[](https://github.com/beercss/beercss/stargazers)\n\n### Stargazers over time\n[](https://starchart.cc/beercss/beercss)\n","readmeFilename":"README.md"}
![\"beer](\"https://www.beercss.com/beer-and-woman.svg\")
\n ![\"Beer](\"https://www.beercss.com/favicon.png\")
![\"Beer](\"https://www.beercss.com/logo.png\"){kind=logo}
\n![\"license\"](\"https://img.shields.io/github/license/beercss/beercss\")
![\"downloads\"](\"https://img.shields.io/jsdelivr/npm/hy/beercss\")
![\"brotli](\"https://img.shields.io/badge/brotli_size-14.4kb-green\"){kind=icon}
![\"version\"](\"https://img.shields.io/npm/v/beercss\")
![\"pull](\"https://img.shields.io/github/issues-pr/beercss/beercss\")
![\"issues\"](\"https://img.shields.io/github/issues/beercss/beercss\")
![\"Sponsors\"](\"https://opencollective.com/beercss/sponsors.svg?avatarHeight=56&button=false\")
\n ![\"Sponsors\"](\"https://opencollective.com/beercss/backers.svg?avatarHeight=56&button=false\")
\n![\"Sponsors\"](\"https://images.weserv.nl/?url=/avatars.githubusercontent.com/u/96993393?s=56&v=4&mask=circle&maxage=7d\")
![\"Sponsors\"](\"https://images.weserv.nl/?url=avatars.githubusercontent.com/u/15235526?s=56&v=4&mask=circle&maxage=7d\")
![\"Sponsors\"](\"https://images.weserv.nl/?url=avatars.githubusercontent.com/u/12303444?s=56&v=4&mask=circle&maxage=7d\")
![\"Sponsors\"](\"https://images.weserv.nl/?url=avatars.githubusercontent.com/u/40445940?s=56&v=4&mask=circle&maxage=7d\")
![\"Sponsors\"](\"https://images.weserv.nl/?url=avatars.githubusercontent.com/u/74856856?s=56&v=4&mask=circle&maxage=7d\")
![\"Sponsors\"](\"https://images.weserv.nl/?url=avatars.githubusercontent.com/u/419690?s=56&v=4&mask=circle&maxage=7d\")
![\"Sponsors\"](\"https://images.weserv.nl/?url=avatars.githubusercontent.com/u/181576?s=56&v=4&mask=circle&maxage=7d\")
![\"Sponsors\"](\"https://images.weserv.nl/?url=avatars.githubusercontent.com/u/797439?s=56&v=4&mask=circle&maxage=7d\")
![\"Sponsors\"](\"https://images.weserv.nl/?url=avatars.githubusercontent.com/u/3647943?s=56&v=4&mask=circle&maxage=7d\")