Cicadaes / minna-ui

πŸ“‘ A friendly UI framework which aims to be straightforward, intuitive, and high performance.

Home Page:https://ui.wearegenki.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build status Coverage status NPM version Licence PRs Welcome

minna-ui

A friendly UI framework which aims to be straightforward, intuitive, and high performance. It can be used as standalone CSS and web components or in a Svelte or other JavaScript framework project.

ηš†, みんγͺ, or minna, is a Japanese adverb and verb meaning all, everyone, or everybody. It embodies the idea that through mindful attention to universal design concepts the framework can work well for everybody; everyone's UI.

NOTE: minna-ui is in early development. Before we reach v1.0.0, minor releases may contain breaking changes.

Overview

The minna-ui framework is designed around the types of projects we do at We Are Genki β€” ecommerce, microsites, and next-gen progressive web apps β€” but it's flexible so you can build any UI on the web. It aims to strike a balance between easy to use predefined styles, utilities for rapid prototyping, and opinionated but customizable web components.

Under the hood components use the Svelte JavaScript framework so minna-ui is a great match for your Svelte based projects. All components are also available precompiled for easy use in any web project regardless of which framework you use.

Features:

  • Universal design as a core concept
  • Semi-flat design aesthetic
  • Microinteractions
  • High performance

Technologies:

Documentation

To see live examples and the docs, visit ui.wearegenki.com (coming soon).

Quick start

The easiest way to get started is to get a copy of our example project template:

wget https://github.com/WeAreGenki/minna-ui-template/archive/master.zip -o minna-ui-template.zip

Browser compatibility

If you choose to use the CSS Grid Layout options the framework provides, you'll be limited to browsers that support it. Minimum browser versions include:

  • Chrome for Android 61
  • Android browser 56
  • iOS Safari 10.3
  • Chrome 57
  • Firefox 52
  • Safari 10.1
  • Edge 16
  • Opera 46

NOTE: Old browser compatibility via progressive fallback is possible and we'll add examples in the future.

Changelog

See CHANGELOG.md.

Licence

minna-ui is an Apache-2.0 licensed open source project. See LICENCE.


Β© 2018 We Are Genki

About

πŸ“‘ A friendly UI framework which aims to be straightforward, intuitive, and high performance.

https://ui.wearegenki.com

License:Apache License 2.0


Languages

Language:JavaScript 56.6%Language:CSS 30.1%Language:HTML 13.2%Language:Shell 0.1%