Skip to content

Shmew/Fable.MaterialUI.Icons

Repository files navigation

Fable.MaterialUI.Icons

This package provides Fable bindings for the <SvgIcon> React components in @material-ui/icons. You can use it with fable-material-ui (>= 3.0.0 due to module/namespace clashes) or on its own.

For more icons, see Fable.MaterialUI.MaterialDesignIcons.

Installation

  • Install the @material-ui/icons npm package and its peer dependency @material-ui/core:

    • using npm: npm install @material-ui/icons @material-ui/core
    • using yarn: yarn add @material-ui/icons @material-ui/core
  • Install the bindings:

    • using dotnet: dotnet add package Fable.MaterialUI.Icons
    • using paket: paket add Fable.MaterialUI.Icons

Usage

open Fable.Helpers.React
open Fable.MaterialUI.Icons

let view =
  div [ ] [
    homeIcon [ ]
  ]

For icon-specific properties, use fable-material-ui and see its SvgIcon documentation.

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 @material-ui/icons.

Contributing/updating

  1. Check the Material-UI changelog for relevant changes
  2. Run npm up
  3. Run ./fake.cmd build -t BuildTest
  4. Check the HTML file in the output folder to verify that all icons render correctly
  5. Update the version number, release notes, and supported npm dependency versions for femto in src/Fable.MaterialUI.Icons/Fable.MaterialUI.Icons.fsproj
  6. Commit, tag (to trigger release from AppVeyor), and push