Package requires `@githubprimer/octicons-react`

[jxnblk]

After installing @primer/components, a missing module error states that @githubprimer/octicons-react can't be resolved. I'm guessing this is either meant to be a hard or peer dependency. If it is a peer dependency, I would expect to see it listed in the install instructions on https://primer.style/components

[shawnbot]

Yep, you're right! We have it declared as external in our rollup config, so anyone who's using the ESM bundle will need to install it as a peer dependency. Sorry about that!

[colebemis]

We could probably add @primer/octicons-react to the install documentation as part of this pull #476

[mxstbr]

This was done to solve #454, but if the package is still required in the code (no matter which specific package) all of the icons will still be bundled in any app that uses @primer/components. I think we can revert the PR that marked the package as a peer dependency, as the only thing that changed was that it's now harder to install @primer/components, but #454 was not actually resolved, right?

Ideally the StyledOcticon component would not included in the main bundle somehow, for example by distributing individual bundles for each component (ref #456).

[emplums]

Hmmm, I could be down to bundle each component separately if we still include one bundle that's got everything. I don't want all users to have to do this:

import Flex from '@primer/components/Flex`
import Box from '@primer/components/Box`
import {Relative} from '@primer/components/Position`
import StyledOcticon from '@primer/components/StyledOcticon`
import BorderBox from '@primer/componentsBorderBox`
import UnderlineNav from '@primer/components/UnderlineNav`

That'll get real ugly real quick if a file is using a bunch of components at once.

[emplums]

I'm going to revert the peerDep PR for now until we get this figured out

[mxstbr]

I agree with that, I just wish there was a way to selective include certain Octicons without having to bundle all of them. 😕

[shawnbot]

I feel you, @mxstbr. I wish tree shaking worked as advertised!