Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

emotion use css prop with custom components

In my application I have a component that I want to style with the css prop from outside.

function Component({css}:{css?: React.CSSProperties}) {
  // some stuff going on here
  return (
    <div
      css={{
        color: blue,
        ...css
      }}
    >
       // some stuff going on here
    </div>
  )
}

The background is as follows: I want to use Component in different scenarios where I have to style the container based on the surrounding layout. E.g. flex, grid or in combination with some components I have to add different margins.

Now instead of introducing many props for all possible scenarios, I want to be able to style the container from outside the component.

E.g. usages of the component could be:

function Layout() {
  return (
    // some other components
    <Component css={{margin: 12}}/>
    // some other components
  )
}

or

import {css} from "@emotion/react"

const style = css({margin: 12})

function Layout() {
  return (
    // some other components
    <Component css={style}/>
    // some other components
  )
}

or

import {css} from "@emotion/react"

const style1 = css({margin: 12})
const style2 = css({color: 'red'})

function Layout() {
  return (
    // some other components
    <Component css={[style1, style2]}/>
    // some other components
  )
}

I have the following problems:

  1. If I use css as the prop name (as in the above example) the style is not applied. If I change the name of the prop to e.g. newCss it works as expected
  2. React.CSSProperties is not the right prop type to handle all the possibilities of emotions css prop.
  3. How can I merge the different css prop possibilities (object, list) with the css prop from Component?
like image 714
Skyy2010 Avatar asked Mar 28 '26 02:03

Skyy2010


1 Answers

In fact, we don't need to use the extra props. As Ben Laniado mentioned, the official documentation states

Any component or element that accepts a className prop can also use the css prop.

https://emotion.sh/docs/css-prop#use-the-css-prop

So what we need is accepting className and css as props and add className to the component. (We don't need css to the component but need it for types)

type ComponentProps = {
  css?: SerializedStyles;
  className?: string;
};
const Component: VFC<ComponentProps> = ({ className }) => {
  return (
    <div css={{ color: blue }} className={className}>
      hello world
    </div>
  );
};
export default function App() {
  return (
    <div className="App">
      <Component css={{ margin: 12 }} />
    </div>
  );
}

This is the full working example.
https://codesandbox.io/s/react-component-accepting-emotion-css-prop-wskbh?file=/src/App.tsx

like image 141
Satoshi Onoda Avatar answered Mar 31 '26 06:03

Satoshi Onoda



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!