• Stars
    star
    189
  • Rank 204,649 (Top 5 %)
  • Language
    Rust
  • License
    Apache License 2.0
  • Created about 4 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Yew wrapper for Material Web Components

Material Yew

Material Yew is a components library for Yew framework which is a wrapper around Material Web Components exposing Yew components. All modern browsers are supported. There is no support for polyfills required by Internet Explorer 11.

Example

use material_yew::MatButton;
use yew::html;

html! {
    <MatButton label="Click me!" />
};

Getting started

Installation

Cargo.toml:

[dependencies]
material-yew = "0.2"

Material icons and a Material font can also be imported for full functionality.
index.html:

<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Material+Icons&display=block" rel="stylesheet">

It's also important to note that you need viewport meta tag for the Material Components to be responsive.

<meta name="viewport" content="width=device-width, initial-scale=1.0">

Feature flags

Following are all the cargo features available (each feature corresponds to its respective component):

  • button
  • circular-progress
  • checkbox
  • circular-progress-four-color
  • drawer
  • top-app-bar
  • icon-button
  • fab
  • formfield
  • linear-progress
  • icon
  • radio
  • switch
  • top-app-bar-fixed
  • dialog
  • list
  • icon-button-toggle
  • slider
  • tabs
  • snackbar
  • textfield
  • textarea
  • select
  • menu

full feature enables all the components

Theming

These components respect the theming applied to Material Web Components using stylesheets. Learn about how to theme Material Web Components.

Documentation

Full API documentation can be found here. Demos of components can be found here.

Contributing

  1. Fork it (https://github.com/hamza1311/material-yew)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request