Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 3.1 KB

README.md

File metadata and controls

55 lines (37 loc) · 3.1 KB

goapp-mdc

go-app implementations of Material Components for the web

Go Report Card GitHub release Go Reference GitHub go.mod Go version GitHub

Goal

Provide a set of components for go-app that make use of material-components-web for styling, animations, and interaction.

Dependencies

Material Components Web

The material-components-web project are what components in this library depend on for styling, animation, and interaction. Usage of this library assumes that the stock css and js from material-components-web are referenced via CDN or included in application in the /web folder. See Getting Started in material-components-web.

A custom styled theme may be used, but this library depends on the css and js objects being in the right spots. i.e. new mdc.ripple.MDCRipple(element) and class="mdc-ripple-surface" need to work in order for this library to render components correctly.

Material Icons

This project also depends on the Material Icons font being pulled in correctly via Material Icons Guide. This project's icon package contains a generated constants file for the list of current (as of Oct 2021) icons and custom names not found in these constants can be used by passing in a MaterialIcon variable with a custom icon name. The supported icon style class is currently material-icons. Other styles like material-icons-outlined or material-icons-sharp could be added with a bit of work.

Progress

First a word on stability - "This is a work in progress. Expect breaking changes before the v1 release."

Packages

This library's package structure loosely follows the naming of packages under material-components-web/packages but some library packages like mdc-animation won't have a goapp-mdc component.

PackageProgress shows this mapping and also the development progress, if any.