BeerCSS

Build material design interfaces in record time... without stress for devs....

CSS Toolkit Material design

beercss/beercss www.beercss.com beercss

README

Beer CSS

Build material design interfaces in record time...

...without stress for devs 🍺💛

Cheers, www.beercss.com

Why? ##

- The first CSS framework based on Material Design 3.

- 10x smaller than others CSS frameworks based on Material Design.

- Translates Material Design to HTML semantic standard.

- Ready to use with any JS framework.

- Highly focused on DX.

Applying "the beer way" in css?

This 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 thinking about It and our 3 ingredients are: settings, elements and helpers. This sounds weird at first time, 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! 😁

```
| SETTINGS | // The settings affects all document
|---------------|----|
| | |
| ELEMENTS | | // The elements are the components, widgets or tags
| | |
|---------------| |
| | |
| | |
| HELPERS |----| // The common helpers makes the elements more scalable and customizable
| |
| |
|---------------|
```

DO:

```
// 1 setting to 1 document
<body class="dark|light">...</body>
// 1 element to N helpers
<element class="helper helper">...</element>
<div class="element helper helper">...</div>
// nav elements before all others
<body>
<nav class="left|right|top|bottom">...</nav>
...
</body>
<div id="app">
<nav class="left|right|top|bottom">...</nav>
...
</div>
// write css like this
.element.helper {...}
.element > .element {...}
.element > .helper {...}
```

DON'T:

```
// N elements to 1 tag
<div class="element element helper">...</div>
// element with dependencies
<div class="element">
<div class="element-header">...</div>
<div class="element-content">...</div>
<div class="element-footer">...</div>
</div>
// nav elements after all others
<body>
...
<nav class="left|right|top|bottom">...</nav>
</body>
<div id="app">
...
<nav class="left|right|top|bottom">...</nav>
</div>
// write css like this
.element.element {...}
.element .element {...}
.element .helper {...}
```

Get started

CDN

From jsdelivr.net.

```html
// with html
<link href="https://cdn.jsdelivr.net/npm/beercss@3.4.2/dist/cdn/beer.min.css" rel="stylesheet" />
<script type="module" src="https://cdn.jsdelivr.net/npm/beercss@3.4.2/dist/cdn/beer.min.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/material-dynamic-colors@1.1.0/dist/cdn/material-dynamic-colors.min.js"></script>
```

```css
// with css
@import "https://cdn.jsdelivr.net/npm/beercss@3.4.2/dist/cdn/beer.min.css";
```

```js
// with javascript
import "https://cdn.jsdelivr.net/npm/beercss@3.4.2/dist/cdn/beer.min.js";
import "https://cdn.jsdelivr.net/npm/material-dynamic-colors@1.1.0/dist/cdn/material-dynamic-colors.min.js";
```

NPM

You can get the latest release using NPM. This release contains source files as well as the compiled CSS and JavaScript files.

```js
// installing
npm i beercss
npm i material-dynamic-colors
```

```js
// importing as window.beercss and window.materialDynamicColors
import "beercss";
import "material-dynamic-colors";
```

```js
// importing as beercss and materialDynamicColors
import beercss from "beercss";
import materialDynamicColors from "material-dynamic-colors";
```

```js
// importing manually from dist
import "beercss/dist/cdn/beer.min.css";
import "beercss/dist/cdn/material-symbols-outlined.woff2";
import "beercss/dist/cdn/material-symbols-rounded.woff2";
import "beercss/dist/cdn/material-symbols-sharp.woff2";
import beercss from "beercss/dist/cdn/beer.min.js";
import materialDynamicColors from "material-dynamic-colors/dist/cdn/material-dynamic-colors.min.js";
```

```js
// importing manually from src
import "beercss/src/cdn/beer.css";
import "beercss/src/cdn/material-symbols-outlined.woff2";
import "beercss/src/cdn/material-symbols-rounded.woff2";
import "beercss/src/cdn/material-symbols-sharp.woff2";
import beercss from "beercss/src/cdn/beer.ts";
import materialDynamicColors from "material-dynamic-colors/src/cdn/material-dynamic-colors.js";
```

HTML

You can use this html to setup your project. See on Codepen.

```html
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<meta name="google" content="notranslate">
<title>Hello world</title>
<link href="https://cdn.jsdelivr.net/npm/beercss@3.4.2/dist/cdn/beer.min.css" rel="stylesheet">
<script type="module" src="https://cdn.jsdelivr.net/npm/beercss@3.4.2/dist/cdn/beer.min.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/material-dynamic-colors@1.1.0/dist/cdn/material-dynamic-colors.min.js"></script>
</head>
<body class="light">
<nav class="left m l">
<img src="https://www.beercss.com/favicon.png" class="circle margin">
<a>
<i>home</i>
<div>Home</div>
</a>
<a>
<i>search</i>
<div>Search</div>
</a>
<a>
<i>share</i>
<div>Share</div>
</a>
<a>
<i>more_vert</i>
<div>More</div>
</a>
</nav>
<nav class="bottom s">
<a>
<i>home</i>
</a>
<a>
<i>search</i>
</a>
<a>
<i>share</i>
</a>
<a>
<i>more_vert</i>
</a>
</nav>
<main class="responsive">
<img src="https://www.beercss.com/beer-and-woman.jpg" class="responsive round">
<h3>Welcome</h3>
<h5>The beer is ready!</h5>
</main>
</body>
</html>
```

We recommend use the material-dynamic-colors only when your app needs to change theme at runtime.

Documentation

Complete documentation and examples available at:

- Codepen

- Homepage

Contributing guide

Hi! 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:

License

MIT