johanneslumpe / styled-props Goto Github PK

When defining media queries due to using Object.keys on the passed-in media query object, the resulting media queries can appear out of order. Instead of using the keys from the passed-in object we should use Object.keys on theme.breakpoints and then cache the resulting value and re-use it across all function calls.

Certain css rules allow arbitrary values, e.g. length values: 10px, 10%, calc() etc. Since these can only be typed as string in TypeScript, to still provide auto-completion for all other values, we should allow interfaces to define multiple props, each with their own types, e.g.:

interface IVerticalAlignProps {
  verticalAlign: 'baseline' | 'sub' | 'super' | 'text-top' | 'text-bottom' | 'middle' | 'top' | 'bottom';
  verticalAlignRaw: string;
};

This allows users to define props in a way that still gives them the required auto-completions for basic values, but allows for custom string value as well. Additionally it makes it easy to grep for usages of *Raw to audit a code base for invalid/unnecessary usages of these "arbitrary" values.

We should use https://github.com/mdn/data/blob/master/css/definitions.json to group helper functions together in sub directories instead of throwing all of them into the main index file.

If props are not prefixed, it becomes harder to distinguish between a component-level prop and a style-prop. It also makes it fairly involved to grep for style-prop usage across an app. By always prefixing all interface values with $, we can create an easy to follow convention which will minimize prop collisions and facilitate discoverability via Intellisense.