Git Product home page Git Product logo

Comments (11)

BrentFarese avatar BrentFarese commented on June 25, 2024 3

So it seems that the distribution in the filestack-react package does not export types, which means that a TS project will not be able to resolve the types correctly, despite the types being present in src/index.d.ts. Can the project maintainers please expose the types in the distribution so that TS projects can consume those types?

It would be great if you can publish types to Definitely Typed or bundle the types correctly so they are exposed in the project. Thank you!

from filestack-react.

BrentFarese avatar BrentFarese commented on June 25, 2024 3

These are valid workarounds but really the maintainer should publish types on DefinitelyTyped or generate and expose proper types in the dist directory. We are just consuming filestack-js as well but considered using the React component and ran across this common TS issue, which sort of prevented our use of the component.

from filestack-react.

namoscato avatar namoscato commented on June 25, 2024 3

FYI v4.x also does not have any types.

from filestack-react.

fishactual avatar fishactual commented on June 25, 2024 3

I realise everyone is busy but the fact that this package still does not have types is kind of a pain in the ass.

from filestack-react.

zack-frontend avatar zack-frontend commented on June 25, 2024 1

This makes it incredibly difficult to use with React

from filestack-react.

peterjhart avatar peterjhart commented on June 25, 2024 1

Behold. https://www.npmjs.com/package/@types/filestack-react

from filestack-react.

deltek-rossjackson avatar deltek-rossjackson commented on June 25, 2024

Any update on this one?

from filestack-react.

mpoisot avatar mpoisot commented on June 25, 2024

I see typescript has been added to Filestack-react, but for some reason types aren't working for me in VS Code. I'm able to use Filestack-react components just fine, it's only the typing that isn't working right.

I don't know much about how VS Code finds d.ts files, but perhaps it's because the d.ts file isn't located in the dist folder (it's only in the src folder)?

image

from filestack-react.

deltek-rossjackson avatar deltek-rossjackson commented on June 25, 2024

What we did in our codebase is that we recreated filestack-react and created our own button which is not hard to do. We use filestack-js which has the typings you need.

from filestack-react.

mpoisot avatar mpoisot commented on June 25, 2024

What I ended up doing was create a file filestack-react.d at the top level of my project. I initially copied /src/index.d.ts, but I modified it a bit to eliminate warnings.

declare module "filestack-react" {
  import React from "react"
  import { PickerFileMetadata, ClientOptions } from "filestack-js"

  type FilestackAction =
    | "transform"
    | "retrieve"
    | "metadata"
    | "storeUrl"
    | "upload"
    | "multiupload"
    | "remove"
    | "pick"
    | "removeMetadata"
    | "preview"
    | "logout"

  type ComponentDisplayModeType = "button" | "link" | "immediate"

  interface Props {
    apikey: string | undefined
    action?: FilestackAction
    componentDisplayMode?: {
      type?: ComponentDisplayModeType
      customText?: string
      customClass?: string
    }
    onSuccess?: (data: PickerResponse) => void
    onError?: (error: PickerFileMetadata[]) => void
    clientOptions?: ClientOptions
    file?: File
    source?: string
    customRender?: React.ComponentType<{ onPick: (arg: unknown) => void }>
    actionOptions: OptionsObject
  }

  declare class ReactFilestack extends React.Component<Props> {}
  export default ReactFilestack
}

from filestack-react.

mpoisot avatar mpoisot commented on June 25, 2024

I figured out what was missing to get the existing types recognized and created a pull request.

from filestack-react.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.