Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without stress and the added benefits of TypeScript
npm install --save styled-components styled-components-ts
Getting Started
// Import react, styledComponents and styledComponentsTS
import * as React from 'react'
import styledComponents from 'styled-components'
import styledComponentsTS from 'styled-components-ts'
// Create an interface for the component
export interface MyImageProps {
size: number
borderColor?: string
borderSize?: number
}
// Create a styled component with our props interface
const MyImage = styledComponentsTS<MyImageProps>(styledComponents.img) `
width: ${props => props.size}px;
height: ${props => props.size}px;
border: ${props => props.borderSize || '4px'} solid ${props => props.borderColor || 'black'}
`
export default MyImageNow we have all the typescript goodies for MyImage like type checking and auto-complete.
import MyImage from './MyImage'
<MyImage size={300} borderColor="blue" borderSize={10} />We can also extend our components and add new props with ease.
// Import react, styledComponents and styledComponentsTS
import * as React from 'react'
import styledComponents from 'styled-components'
import styledComponentsTS from 'styled-components-ts'
// Import our image and it's props
import MyImage, { MyImageProps } from './MyImage'
// Create an interface for the component that extends the base image props
export interface ExpandedImageProps extends MyImageProps {
backgroundColor?: string
}
// Create a styled component with our props interface that extends MyImage
const ExpandedImage = styledComponentsTS<ExpandedImageProps>(MyImage.extend)`
background-color: ${props => props.backgroundColor || 'unset'};
`
export default ExpandedImageUsing styled-components v4+?
If you're using a version of styled-components greater than 4.0.0 you do not need this library. See below for example usage:
const Button = styled.div<{ selected?: boolean }>`
background: ${props => props.selected ? 'red' : 'blue'};
`
// or
interface IButton {
selected?: boolean
}
const Button = styled.div<IButton>`
background: ${props => props.selected ? 'red' : 'blue'};
`For more information please see https://github.com/styled-components/styled-components