Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

TypeScript and ThemeProvider support for props

See original GitHub issue

When using a component it’s good to ensure that no one can provide a value that the component can’t accept. My VsCode autosuggested: <PadBox padding="xlXXl" />

And typescript doesn’t yell. How can we make Bedrock typesafe?

Issue Analytics

State:
Created 2 years ago
Comments:13 (8 by maintainers)

Top GitHub Comments

1reaction

httpetecommented, Mar 31, 2021

xlXXl is coming from: https://github.com/Bedrock-Layouts/Bedrock/blob/922d8708104061e261d53ace8ddf3a05f9c1cb78/packages/spacing-constants/src/index.tsx and isn’t one of the valid options for PadBox.

I guess you could first make sure that each component returns the types for each prop, that happen to match to the themeProvider keys… But better would be to get the typing from styled-components (Which is possible) https://styled-components.com/docs/advanced#via-withtheme-higherorder-component

But maybe option 1 is fine and proper. You can integrate storybook to read the Interfaces and document them automatically based on that, which would help your long term maintenance and accuracy issues.

1reaction

Jarvis1010commented, Mar 31, 2021

Ah I see how can we scope them to only the provided values in the theme provider. I’m going to need to look into this.