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

Documentation lists prop types as any #12986

Open
sambostock opened this issue Dec 13, 2024 · 0 comments
Open

Documentation lists prop types as any #12986

sambostock opened this issue Dec 13, 2024 · 0 comments
Labels
Bug Something is broken and not working as intended in the system. untriaged

Comments

@sambostock
Copy link
Contributor

Summary

The documentation for <Page> and other components lists the type of many props as any. <PageActions> has the same issue. There may be others.

For the purposes of this issue, secondaryActions will be used as an example.

Expected behavior

secondaryActions should be typed as something like MenuActionDescriptor[] | ReactNode, making it clear to consumers what they can provide as props.

Actual behavior

secondaryActions is typed as any.

Image

Meanwhile, actionGroups is correctly typed as MenuGroupDescriptor[].

Steps to reproduce

Look at the documentation for <Page>, and others.

Are you using React components?

None

Polaris version number

No response

Browser

No response

Device

No response

@sambostock sambostock added Bug Something is broken and not working as intended in the system. untriaged labels Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something is broken and not working as intended in the system. untriaged
Projects
None yet
Development

No branches or pull requests

1 participant