Export themeGet

[colebemis]

Exports the get function as themeGet. Exporting themeGet will make it easier for people to use the Primer theme with styled-components.

Usage

import {themeGet} from '@primer/components'
import styled from 'styled-components'

const Example = styled.div`
  color: ${themeGet('colors.gray.7')};
`

Creating components in this way allows users to override theme values with ThemeProvider if necessary.

Merge checklist

• Changed base branch to release branch
• Tested in Chrome
• Tested in Firefox
• Tested in Safari
• Tested in Edge

[nicholaai]

Why not export as get instead of themeGet? Renaming to themeGet might lead to confusion, as get is a replacement for @styled-system/theme-get's themeGet

[shawnbot]

Just spit-balling... would this API be better?

import {theme} from '@primer/components'
export default styled.div`
  color: ${theme.get('colors.gray.7')};
`

Or would you expect theme.get('colors.gray.7') to actually return a value rather than a function? 🤔

[colebemis]

@shawnbot Just spit-balling... would this API be better?

That's interesting idea. Although, I do like the idea of the theme being a serializable object. I'd also kind of expect theme.get('colors.gray.7') to return a value.

@nicholaai Why not export as get instead of themeGet? Renaming to themeGet might lead to confusion, as get is a replacement for @styled-system/theme-get's themeGet

I called the export themeGet because you can think of Primer's themeGet function as a replacement for Styled System's themeGet. You can use Primer's themeGet in all the same places you can use Styled System's themeGet. The only is difference is that Primer's themeGet uses Primer's theme values as a built-in fallback values.

I also think the name get could easily be confused with lodash's get function.

[shawnbot]

That's interesting idea. Although, I do like the idea of the theme being a serializable object. I'd also kind of expect theme.get('colors.gray.7') to return a value.

Yeah, agreed. I like it the way you've got it, but would love @emplums to weigh in too.

[emplums]

This looks good to me, I like they API you've got here @colebemis

Can you change the base branch to the 13.2.0 release please?