artemyb / feliz.materialui

Feliz-style Fable bindings for Material-UI

Feliz.MaterialUI

Feliz-style Fable bindings for MUI (aka Material-UI).

Documentation

https://artemyb.github.io/Feliz.MaterialUI/

Contributing

This project uses fable, paket and femto as .NET local tools. Therefore, dotnet tool restore is needed to work with the project. However build.cmd and build.sh scripts already include this step.

To run build targets using cmd or Powershell:

build.cmd TargetName

or using bash:

build.sh TargetName

Regular maintenance

1. Run the RegularMaintenance target, which will update all packages as well as the Femto metadata in Feliz.MaterialUI.fsproj, Feliz.MaterialUI.Icons.fsproj, Feliz.MuiX.DatePickers.fsproj and Feliz.MuiX.DatePickersPro.fsproj, and regenerate the bindings based on the live MUI docs.
2. Check all changes to Feliz.MaterialUI and adjust the generator’s API parser as needed. Remember to check all doc comment updates too, since changes there may indicate that something must be changed elsewhere. Run the RegenerateFromCache target (or run the generator project in VS) to re-generate based on the recently downloaded HTML pages.
3. Update the version number in Feliz.MaterialUI.fsproj, Feliz.MaterialUI.Icons.fsproj, Feliz.MuiX.DatePickers.fsproj and Feliz.MuiX.DatePickersPro.fsproj.
4. Update RELEASE_NOTES.md
5. Update relevant docs/samples (typically in docs-app/public/pages, potentially also by adding menu items in App.fs)
6. Run the CiBuild target to check that everything compiles
7. Run the Docs:Run target to verify that the docs are still working
8. Commit and tag the commit (this is what triggers deployment from AppVeyor). For consistency, the tag should be identical to the version (e.g. 1.2.3).
9. Push the changes and the tag to the repo. If AppVeyor build succeeds, the package is automatically published to NuGet.
10. Publish the docs by running the Docs:Publish target.

feliz.materialui's Issues

Did you try to become the maintainer of the origin repository?

Hi,
I am glad this Feliz.MaterialUI project is alive again.
However for me it was big luck that I found this fork. It would be much better if the changes would be merged back in https://github.com/Shmew/Feliz.MaterialUI

Additionally the current situation that there is no package that can be easily installed is quite frustrating. See #3

Since https://github.com/Shmew/Feliz.MaterialUI is currently inactive, and since I find it confusing when the URL of the repo changes each time the owner changes, I would suggest that somebody creates a github company to host the Felitz.MaterialUI repository.

Since @Shmew is not maintaining the project currently, maybe you can ask him if you can take over the repository. Even if you do not plan to contribute further, it would be good to have somebody that could accept or reject occasional merge requests.

@Linschlager - mentioned because he did the Material UI 5 upgrade for this repository.

Emotion bindings?

Hi!

Thank you for making this fork, so far everything is working great. 👍

I am curious what and how much work is required to create the Emotion bindings?

Generated `box` type shadows implicitly imported FSharp.Core's `box` (`FSharp.Core.Operators.box`) function

Probably the type should have box' name generated instead, like it is done in case of conflicts with keywords (e.g. open' for open prop). Or box name could be kept, but in that case to use the box operator it should be imported explicitly (e.g. to define let box = FSharp.Core.Operators.box before usage). However in Fable !! operator could be used instead, so the problem seems minor.

Incorrect binding to the `renderOption` prop of the `Autocomplete` component

The correct signature for MUI v5 is the following (from the MUI docs):

function(props: object, option: T, state: object) => ReactNode

• props: The props to apply on the li element.
• option: The option to render.
• state: The state of the component.

However the current Feliz.MaterialUI prop-binding has only 2 parameters (in MUI v4 there were only option and state parameters).

The new props parameter should be passed to the renderOption's output li-element to ensure that Autocomplete works correctly. Found this explanation in this SO-answer.

`anchorPosition` prop (e.g. of Menu, Popover) should accept `float`s, not just `int`s

Unauthorized error trying to install the package

Hi,

thanks for improving the Feliz.MaterialUI project.

I have added <add key="github" value="https://nuget.pkg.github.com/ArtemyB/index.json" /> to NuGet.config.
When I run dotnet add package Feliz.MaterialUI --version 5.11.0-beta.2 I get the following error

log  : Retrying 'FindPackagesByIdAsync' for source 'https://nuget.pkg.github.com/ArtemyB/download/feliz.materialui/index.json'.
log  : Response status code does not indicate success: 401 (Unauthorized).
info :   GET https://nuget.pkg.github.com/ArtemyB/download/feliz.materialui/index.json
warn : Your request could not be authenticated by the GitHub Packages service. Please ensure your access token is valid and has the appropriate scopes configured.
info :   Unauthorized https://nuget.pkg.github.com/ArtemyB/download/feliz.materialui/index.json 648ms
error: NU1301: Failed to retrieve information about 'Feliz.MaterialUI' from remote source 'https://nuget.pkg.github.com/ArtemyB/download/feliz.materialui/index.json'.

David