Skip to content

Bucklescript + ReasonReact binding Ant Design

Notifications You must be signed in to change notification settings

bloom/bs-ant-design

 
 

Repository files navigation

bs-ant-design-alt

Introduction

** See forked repo for details. This repo is a staging area for me to test out components not in original bs-ant-design before doing a pull request. I am new to reason-react and these are my first bindings. Many have incorrect types for parameters (especially callbacks) I don't happen to be using yet.
I will fix them up before pull request to parent repo. **

Bucklescript + ReasonReact binding for Ant Design components. I write bindings when I needed them in my projects. If you find a component is missing, it's because I don't need it (yet).

Difference from bs-antd : It uses the official recommended way for writing bindings and it doesn't work for me. I explained this in this blog post

I also attempted to rewrite the components when possible for a better integration.

Installation

  • With npm:
npm install --save bs-ant-design-alt
  • With yarn:
yarn add bs-ant-design-alt
  • Add bs-ant-design-alt to bs-dependencies in bsconfig.json.

THIS LIBRARY ONLY INCLUDES THE BINDINGS FOR ANT DESIGN, NOT THE STYLE. You'll have to include the Ant Design CSS in your project yourself. We've included the compiled and minified CSS that Ant Design publishes to CDN JS in this file for your convenience. It's in the "vendor" directory. You can require that using a bundler, if you like. Or you can load the CSS on your html page from the CDN directly! Just make sure the version you load correlates with the version of ant-design that this package uses.

Usage

Please check ant design's documentation for each component.

I tried to keep the API as close to the original JS API as possible.

Some common patterns I used:

  • string enums -> polymorphic variants
  • function argument accepts different types: GDATs or %identity hack.

Components

Almost all of them are done, some completely, some superficially with params I needed. Refer to src for specifics.

Contributions

All contributions are welcomed. I intend to merge and release quickly.

LICENSE

MIT

About

Bucklescript + ReasonReact binding Ant Design

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Reason 99.0%
  • Other 1.0%