Myg
An opinionated & modular state-of-the-web framework.
Disclaimer: Myg really is a state-of-the-web framework. It utilizes CSS variables, CSS grid and ES6. Better be aware before throwing it around.
Myg is being used on:
Table of Contents
Philosophy
Modular: Myg includes a lot of UI elements. Because everyone of them is separately published on NPM, you can just include what you actually use.
Lightweight: MixHTmlins > Classes. Myg's CSS classes are entirely optional to minimize file size.
Opinionated: Opinionated components prevent you from polluting your DOM.
Modern: Myg uses the latest web technologies to support its rich feature set while remaining lightweight.
Combinable: Myg does not force you into using it on every HTML5 element. Instead it only maps to them if you want to.
Usage
Stylesheets
Sass
CSS3
;JavaScript
ES6
;ES5 (Sprockets)
//= require myg/dist/mygGetting started
...
Components
- Action Buttons
- Animate
- Base
- Buttons
- Cards
- Checkboxes
- Dialogs
- Drawers
- Dropdowns
- Elevation
- Fonts
- Footers
- Form Fields
- Grids
- Hints
- Inputs
- Labels
- Layout
- Lists
- Menus
- Modals
- Progress Bars
- Radio Buttons
- Select Menus
- Sidebars
- Slides
- Sliders
- Spacing
- Switches
- Tabs
- Texts
- Themes
- Titlebars
- Toasts
- Toolbars
- Tooltips
To Do
Here is the full list of current projects.
To propose your ideas, initiate the discussion by adding a new issue.
Development
Here is how you can build Myg locally:
$ npm run build
CSS methodology
Myg has been built with BEVM in mind:
block__element--variation -modifier
Contributing
We hope that you will consider contributing to Myg. Please read this short overview for some information about how to get started:
Learn more about contributing to this repository, Code of Conduct
Contributors
Give the people some ❤️ who are working on this project. See them all at:
https://github.com/jonhue/myg/graphs/contributors
Semantic Versioning
Myg follows Semantic Versioning 2.0 as defined at http://semver.org.
License
MIT License
Copyright (c) 2018 Jonas Hübotter
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.