https://github.com/shmew/fable.materialui.materialdesignicons

Fable bindings for mdi-material-ui
https://github.com/shmew/fable.materialui.materialdesignicons

fable fable-bindings icons material-design material-ui svg-icons

Last synced: 22 days ago
JSON representation

Fable bindings for mdi-material-ui

• Host: GitHub
• URL: https://github.com/shmew/fable.materialui.materialdesignicons
• Owner: Shmew
• License: mit
• Created: 2018-12-02T17:07:23.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-06-05T20:40:24.000Z (over 3 years ago)
• Last Synced: 2024-11-04T12:43:39.938Z (about 2 months ago)
• Topics: fable, fable-bindings, icons, material-design, material-ui, svg-icons
• Language: F#
• Size: 2.1 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fable.MaterialUI.MaterialDesignIcons

This package provides Fable bindings for the `` React components in `mdi-material-ui`. You can use it with [fable-material-ui](https://github.com/mvsmal/fable-material-ui) (>= 3.0.0 due to module/namespace clashes) or on its own.

For more icons, see [Fable.MaterialUI.Icons](https://github.com/cmeeren/Fable.MaterialUI.Icons).

## Installation

* Install the `mdi-material-ui` npm package and its peer dependency `@material-ui/core`:

  * using npm: `npm install mdi-material-ui @material-ui/core`

  * using yarn: `yarn add mdi-material-ui @material-ui/core`

* Install the bindings:

  * using dotnet: `dotnet add package Fable.MaterialUI.MaterialDesignIcons`

  * using paket: `paket add Fable.MaterialUI.MaterialDesignIcons`

## Usage

```f#

open Fable.Helpers.React

open Fable.MaterialUI.MaterialDesignIcons

let view =

  div [ ] [

    homeIcon [ ]

  ]

```

For icon-specific properties, use [fable-material-ui](https://github.com/mvsmal/fable-material-ui) and see its [SvgIcon documentation](https://mvsmal.github.io/fable-material-ui/#/api/svg-icon).

## Missing new icons?

If the bindings are outdated, please file an issue and I'll update them. It's quick and simple (they're auto-generated), but I don't have the capacity to manually check for changes in `mdi-material-ui`.

## Contributing/updating

1. Run `npm up`

2. Run `./fake.cmd build -t BuildTest`

3. Check the HTML file in the `output` folder to verify that all icons render correctly

4. Update the version number, release notes, and supported npm dependency versions for femto in `src/Fable.MaterialUI.MaterialDesignIcons/Fable.MaterialUI.MaterialDesignIcons.fsproj`

5. Commit, tag (to trigger release from AppVeyor), and push