fix: restore color prop for StyledOcticon

primer · Jan 7, 2022 · 3bd0a9d · 3bd0a9d
1 parent eb5b3ad
commit 3bd0a9d
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 30 deletions.
diff --git a/docs/content/StyledOcticon.md b/docs/content/StyledOcticon.md
diff --git a/docs/content/StyledOcticon.mdx b/docs/content/StyledOcticon.mdx
@@ -0,0 +1,78 @@
+---
+description: Use StyledOcticon to render an Octicon as a component.
+title: StyledOcticon
+status: Alpha
+source: https://github.com/primer/react/blob/main/src/StyledOcticon.tsx
+componentId: styled_octicon
+---
+
+## Example
+
+```jsx live
+<>
+  <StyledOcticon icon={CheckIcon} size={32} color="success.fg" sx={{mr: 2}} />
+  <StyledOcticon icon={XIcon} size={32} color="danger.fg" />
+</>
+```
+
+## Props
+
+<PropsTable>
+  <PropsTableRow
+    name="ariaLabel"
+    type="string"
+    description="Specifies the aria-label attribute, which is read verbatim by screen readers "
+  />
+  <PropsTableRow
+    name="icon"
+    type="Component"
+    description={
+      <>
+        Checks the input by default in uncontrolled modeName of the <Link href="https://primer.style/octicons/">Octicon component</Link> used in the 
+      </>
+    }
+  />
+  <PropsTableRow
+    name="color"
+    type="string"
+    description={
+      <>
+        Sets an override color for the Octicon. Compatible with colors from the <Link href="https://primer.style/primitives/colors">Primer color system</Link>." 
+      </>  
+    }
+  />
+  <PropsTableRow
+    name="size"
+    defaultValue="16"
+    type="number"
+    description="Sets the uniform `width` and `height` of the SVG element"    
+  />
+  <PropsTableRow 
+    name="verticalAlign"
+    defaultValue="text-bottom"
+    type="string"
+    description="Sets the `vertical-align` CSS property"
+  />
+  <PropsTableSxRow />
+
+</PropsTable>
+
+## Status
+
+<ComponentChecklist
+  items={{
+    propsDocumented: true,
+    noUnnecessaryDeps: true,
+    adaptsToThemes: true,
+    adaptsToScreenSizes: false,
+    fullTestCoverage: false,
+    usedInProduction: true,
+    usageExamplesDocumented: true,
+    designReviewed: false,
+    a11yReviewed: false,
+    stableApi: false,
+    addressedApiFeedback: false,
+    hasDesignGuidelines: false,
+    hasFigmaComponent: false
+  }}
+/>
diff --git a/src/StyledOcticon.tsx b/src/StyledOcticon.tsx
@@ -4,14 +4,14 @@ import styled from 'styled-components'
 import sx, {SxProp} from './sx'
 import {ComponentProps} from './utils/types'
 
-type OcticonProps = {icon: React.ElementType} & IconProps
+type OcticonProps = {icon: React.ElementType; color?: string} & IconProps
 
 function Octicon({icon: IconComponent, ...rest}: OcticonProps) {
   return <IconComponent {...rest} />
 }
 
 const StyledOcticon = styled(Octicon)<SxProp>`
-  ${sx}
+  ${({color, sx: sxProp}) => sx({sx: {color, ...sxProp}})}
 `
 
 StyledOcticon.defaultProps = {