Add typescript type definitions

uptick / react-keyed-file-browser

Folder based file browser given a flat keyed list of objects, powered by React.

MIT License

301 stars 144 forks source link

Add typescript type definitions #105

Open fbessou opened 4 years ago

fbessou commented 4 years ago

This file is necessary for typescript projects to be able to use react-keyed-file-browser without writing their own definition files. This is based on the work of @graywolf336 and adds definitions for the FileBrowser and its props.

The definition file doesn't provide type definitions for rendererers implementations but they should be the same as their interface.

Here is the list of exports that should be typed before this PR can be merged :

[X] FileBrowser
[x] RawFileBrowser,
[ ] BaseFile,
[ ] BaseFileConnectors,
[ ] BaseFolder,
[ ] BaseFolderConnectors,
[x] Headers,
[x] FileRenderers,
[x] FolderRenderers,
[x] Details,
[x] Filters,
[X] Groupers,
[X] Sorters,
[X] Icons,
[x] Utils,

Closes #44.

fbessou commented 4 years ago

I'm working on adding missing exports, thanks for the review :) I am not familiar with the react-dnd API so it might take a little more time to add types for BaseFile/FileRenderers...

InsOpDe commented 3 years ago

any news on this?

fbessou commented 3 years ago

I updated the MR to the latest version I wrote (months ago). If I remember correctly, I found props which were not documented and didn't know how to type them. But I think that the documented API is mostly covered by the types. I will not have a lot of time to work on this for a moment but would happily hand over the reins of this MR :)

tmarcinkowski-logitech commented 3 years ago

@fbessou Any reason not to merge it like it is for months? It's a shame to leave it without any typings at all.

fbessou commented 3 years ago

@scaredcat seemed to be ready to merge it as is. So maybe it's time to do so :slightly_smiling_face: I personally added this file directly in my project and I have not encountered any problem with that. Note that I am not using all the features of the library so I can't easily check that everything perfectly matches the .js API.

jarekwg commented 3 years ago

Hey guys, sorry about about silence on this. @dreadera will be taking a look at these soon.

dreadera commented 3 years ago

Hi Everyone!

I have started a new branch with all the typescript work on feature/typescript branch. I have also integrated all the types that @fbessou have created. (Thank you again. It was extremely helpful)

Currently I do not have an ETA as to when it will be complete but I've converted around 70% of the library to TypeScript. Feel free to contribute or ask question 😄