rimble-ui icon indicating copy to clipboard operation
rimble-ui copied to clipboard

Typescript definitions

Open JasoonS opened this issue 5 years ago • 10 comments

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. :)

JasoonS avatar Jun 10 '19 09:06 JasoonS

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?

MikeLockz avatar Jun 11 '19 19:06 MikeLockz

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 :)

JasoonS avatar Jun 12 '19 07:06 JasoonS

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

gesquinca avatar Jun 21 '19 14:06 gesquinca

Acceptance criteria:

  • should have a branch that implements typescript definitions
  • should have pros/cons for switching
  • should have impact on documentation prop generation tables

E: 2D

MikeLockz avatar Nov 12 '19 18:11 MikeLockz

any updates on this?

tpae avatar May 08 '20 02:05 tpae

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

MikeLockz avatar May 08 '20 15:05 MikeLockz

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

JasoonS avatar May 28 '20 23:05 JasoonS

@MikeLockz are the type definitions complete?

yarn add @types/rimble-ui

fails. Is there another way to get them?

br4e avatar Aug 19 '20 21:08 br4e

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

kevinweaver avatar Oct 10 '20 23:10 kevinweaver

+1 for type definitions with Rimble

Ryan-Gordon avatar Feb 12 '21 23:02 Ryan-Gordon