Giter Club home page Giter Club logo

Comments (3)

CatsJuice avatar CatsJuice commented on July 28, 2024 1

That's a good suggestion!
I'm also new to web-component. I'll try to refine this part of the type definition.

from dockbar.

CatsJuice avatar CatsJuice commented on July 28, 2024

@LoTwT
It seems that if I want to and types for react in this package, I have to add @types/react for devDeps. I'm not pretty sure is that appropriate. And for other frameworks, we may need some other types. In my opinion, relying on external framework like React in a web-component project may contradict the original design intention.

For temporary, maybe you can declare types in your own repo. Here is an example that may helps:

type CustomElement<T> = Partial<
  T & { children: unknown } & import("react").DOMAttributes<T> &
    import("react").HTMLAttributes<T> &
    import("react").Attributes
>;

declare namespace JSX {
  interface IntrinsicElements {
    ["dock-wrapper"]: CustomElement<import("dockbar").DockWrapper>;
    ["dock-item"]: CustomElement<import("dockbar").DockItem>;
  }
}

I will continue exploring viable solution and improving them in the README.

from dockbar.

LoTwT avatar LoTwT commented on July 28, 2024

@LoTwT It seems that if I want to and types for react in this package, I have to add @types/react for devDeps. I'm not pretty sure is that appropriate. And for other frameworks, we may need some other types. In my opinion, relying on external framework like React in a web-component project may contradict(反驳) the original design intention(意图).

For temporary(临时), maybe you can declare types in your own repo. Here is a example that may helps:

type CustomElement<T> = Partial<
  T & { children: unknown } & import("react").DOMAttributes<T> &
    import("react").HTMLAttributes<T> &
    import("react").Attributes
>;

declare namespace JSX {
  interface IntrinsicElements {
    ["dock-wrapper"]: CustomElement<import("dockbar").DockWrapper>;
    ["dock-item"]: CustomElement<import("dockbar").DockItem>;
  }
}

I will continue exploring viable(可行) solution and improving them in the README.

You are right. Extra dependencies are verbose.
Displaying the type definitions prominently in the README is enough.

from dockbar.

Related Issues (7)

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.