Skip to content

Faulty typings #658

@Noxdor

Description

@Noxdor

The TypeScript typings appear to be flawed for this library. The useShepherd composable function accepts the following arguments:

Image

This doesn't align with what is shown in this repo's description where, for example, { useModalOverlay: true } is being passed as an argument. I do not get any type suggestions for these configuration properties.

Besides that, the Tour object that is returned by this function seems to be incomplete. I do not get any type hints about what functions are available. addStep and start are both typed as any.

Image

The shown code does render a step, so the library is definitely working. It just doesn't provide any useful type hints.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions