ConsenSysMesh / rimble-ui

React components that implement Rimble's Design System.
https://rimble.consensys.design/
MIT License
462 stars 67 forks source link

Typescript definitions #318

Open JasoonS opened 5 years ago

JasoonS commented 5 years ago

Typescript is a common tool to help make javascript code typesafe. Typescripts ability to do this improves the better the type definitions of the libraries it uses are.

TypeScript definitions for rimble-ui would be helpful for any project using typescript. :)

MikeLockz commented 5 years ago

Hey @JasoonS, we just released a patch version of rimble-ui (0.9.2) that includes proptype definitions for all our components. Does this resolve your issue around type safety or do you want a typescript-specific implementation?

JasoonS commented 5 years ago

Hi @MikeLockz I don't think the proptype definitions are interoperable with typescript. But they are definitely better than nothing.

Typescript type definitions are definitely not a deal breaker for a UI library in my opinion, but they are an enhancement.

Thanks for the great work :)

gesquinca commented 5 years ago

Thanks @JasoonS. We're looking at this as a future enhancement.

MikeLockz commented 4 years ago

Acceptance criteria:

E: 2D

tpae commented 4 years ago

any updates on this?

MikeLockz commented 4 years ago

Hey @tpae we have TS definitions that will get released in the next week.

JasoonS commented 4 years ago

Just BTW, I've stopped using typescript and do everything with reasonML/reason-react now (much better than typescript in my opinion).

Anyway, you can see my rimble ui bindings here: https://github.com/wildcards-world/ui/blob/master/src/wrappedLibs/rimble-ui/Rimble.re , they are incomplete, and just what I'm using; but it's easy to extend

br4e commented 3 years ago

@MikeLockz are the type definitions complete?

yarn add @types/rimble-ui

fails. Is there another way to get them?

kevinweaver commented 3 years ago

Came here to ask this, would love a @types/rimble-ui 😄

Ryan-Gordon commented 3 years ago

+1 for type definitions with Rimble