Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update panOnScrollMode docs. #385

Open
1 task done
hayleigh-dot-dev opened this issue May 9, 2024 · 0 comments
Open
1 task done

Update panOnScrollMode docs. #385

hayleigh-dot-dev opened this issue May 9, 2024 · 0 comments

Comments

@hayleigh-dot-dev
Copy link
Contributor

Code of Conduct

Which site are you suggesting a change for?

reactflow.dev

What content is affected by this change?

/api-reference/react-flow#pan-on-scroll

What part(s) of the article would you like to see updated?

These docs use a string union "free" | "horizontal" | "vertical" as the type, but internally we're using a PanOnScrollMode enum. Enums are nominal in typescript so attempting to set things as a string directly, although valid javascript, won't type check.

We should update the documentation and also add the enum to the documented types.

Additional information

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant