Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexferl/flowbite-mithril

Flowbite components for Mithril
https://github.com/alexferl/flowbite-mithril

flowbite flowbite-mithril mithril mithril-components tailwindcss

Last synced: about 1 month ago
JSON representation

Flowbite components for Mithril

Awesome Lists containing this project

README

        

# flowbite-mithril

Work in progress.

✅ = Fully implemented

🚧 = Partially implemented

❌ = Not implemented

## Components
| Name | Done | Notes |
|:------------:|------|-----------------------|
| Accordion | ✅ |
| Alert | ✅ |
| Avatar | ✅ |
| Badge | ✅ |
| Breadcrumb | ✅ |
| Button | ✅ |
| Button group | ✅ |
| Card | ✅ |
| Carousel | ❌ |
| Datepicker | ❌ |
| Dropdown | ✅ |
| Footer | ✅ |
| KBD | ✅ |
| List group | ✅ |
| Modal | ❌ |
| Navbar | ✅ |
| Pagination | ❌ |
| Progress bar | ❌ |
| Rating | ❌ |
| Sidebar | ❌ |
| Spinner | ✅ |
| Table | 🚧 | Missing hover/striped |
| Tabs | ❌ |
| Timeline | ❌ |
| Toast | ❌ |
| Tooltip | ❌ |

## Forms
| Name | Done | Notes |
|:----------:|------|------------------|
| Checkbox | ✅ |
| File Input | 🚧 | Missing dropzone |
| Input | ✅ |
| Radio | ✅ |
| Range | ✅ |
| Select | ✅ |
| Textarea | ✅ |
| Toggle | ✅ |

## Typography
| Name | Done | Notes |
|:----------:|------|-------|
| Blockquote | ✅ |

## Getting started
Learn how to get started with Flowbite Mithril.

### Setup Tailwind CSS
Install Tailwind CSS:

```shell
npm i -D autoprefixer postcss tailwindcss
npx tailwindcss init -p
```

Point Tailwind CSS to files you have class="..." in:
```javascript
module.exports = {
content: ["./src/**/*.js"],
theme: {
extend: {},
},
plugins: [],
};
```

Add Tailwind CSS to a CSS file:
```css
@tailwind base;
@tailwind components;
@tailwind utilities;
```

### Install Flowbite Mithril
Install Flowbite and Flowbite Mithril:
```shell
npm i -D flowbite github:alexferl/flowbite-mithril
```

Add the Flowbite plugin to `tailwind.config.js`, and include content from `flowbite-mithril`:
```javascript
module.exports = {
content: ["./node_modules/flowbite-mithril/**/*.js"],
plugins: [require("flowbite/plugin")],
};
```