https://github.com/mlctrez/goapp-mdc
go-app implementations of Material Components for the web
https://github.com/mlctrez/goapp-mdc
Last synced: 5 months ago
JSON representation
go-app implementations of Material Components for the web
- Host: GitHub
- URL: https://github.com/mlctrez/goapp-mdc
- Owner: mlctrez
- License: mit
- Created: 2021-10-12T19:04:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-18T18:13:29.000Z (about 4 years ago)
- Last Synced: 2025-10-10T03:56:34.078Z (9 months ago)
- Language: Go
- Homepage: https://goapp-mdc.mlctrez.com/
- Size: 1.18 MB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# goapp-mdc
[go-app](https://go-app.dev/) implementations of Material Components for the web
## Goal
Provide a set of components for [go-app](https://github.com/maxence-charriere/go-app) that make use of
[material-components-web](https://github.com/material-components/material-components-web/) for
styling, animations, and interaction.
## Dependencies
### Material Components Web
The [material-components-web](https://github.com/material-components/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](https://github.com/material-components/material-components-web/blob/master/docs/getting-started.md)
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](https://fonts.google.com/icons?selected=Material+Icons) font
being pulled in correctly via [Material Icons Guide](https://developers.google.com/fonts/docs/material_icons).
This project's [icon](pkg/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](https://github.com/material-components/material-components-web/tree/master/packages/)
but some library packages like mdc-animation won't have a `goapp-mdc` component.
[PackageProgress](PackageProgress.md) shows this mapping and also the development progress, if any.