Skip to content

Instantly share code, notes, and snippets.

@newswim
Created August 4, 2017 22:42
Show Gist options
  • Save newswim/fa916c66477ddd5952f7d6548e6a0605 to your computer and use it in GitHub Desktop.
Save newswim/fa916c66477ddd5952f7d6548e6a0605 to your computer and use it in GitHub Desktop.
Wrapping Ant Design components with Styled Components
import { Link } from 'react-router-dom'
import { Badge, Col, Menu } from 'antd'
const StyledBadge = styled(Badge)`
.ant-badge-count {
background-color: #7ECBBF;
color: white;
box-shadow: 0 0 0 1px #d9d9d9 inset;
}
`
const StyledLink = styled(Link)`
border: 1px solid #fff;
margin-top: 5px;
transition: background-color .3s ease;
border-radius: 2px;
&:hover {
background-color: #78bdb8;
}
`
const MobileCol = styled(Col)`
.ant-popover-inner-content {
padding: 0;
}
`
const StyledMenu = styled(Menu)`
background: transparent;
border-bottom: none;
display: flex;
justify-content: flex-end;
.ant-menu-submenu-horizontal > .ant-menu {
margin-top: -2px;
}
.ant-menu-item:hover {
border-bottom: 2px solid #B2D235;
}
.about-dropdown {
border-bottom: none;
&:hover {
border-bottom: none;
}
li:hover {
border-bottom: none;
}
}
.ant-menu-item-group-list {
padding: 0 0 10px 0;
}
`
@sorsaffari
Copy link

@muco-rolle I'm afraid I don't have much to share with you just yet. I think in a month or two, I'll have more to say

@hansfpc
Copy link

hansfpc commented Dec 20, 2019

Nice (:

@BolaNaguib
Copy link

hey, would like to know how did it go?

@jorisw
Copy link

jorisw commented Apr 23, 2020

This is working great for me. Just importing antd and not loading its LESS stylesheets, then wrapping the imported component in styled(), looks like the way to go for us.

@lucascurti
Copy link

The problem I'm facing with this approach is that after wrapping the Ant Design components with styled I'm missing several methods from the original Component. For example, I missed Modal.info, Modal.useModal, etc.

@randriamazaoro
Copy link

randriamazaoro commented May 11, 2020

Just for contribution, I ran into some troubles when trying to override a component's base class. If you want to override a base class property just wrap the styles in triple & just like this:
const NewButton = styled(Button)' &&& { background: red; } ';

If you don't, the changes you want to do will just be ignored

@adam-s
Copy link

adam-s commented May 18, 2020

Normally, when nested a Menu.SubMenu will be selected when a child Menu.Item is selected. However, this does not happen when when wrapped with a Styled Component (emotion in my case). This is because the children of elements are tightly coupled with parent in Ant Design.

The Ant Design logic in rc-menu utils uses this code to see if the child is one of an Ant Design menu element.

  React.Children.forEach(children, (c: React.ReactElement) => {
    if (c) {
      const construct = c.type as (
        | typeof MenuItemGroup
        | typeof MenuItem
        | typeof SubMenu);
      if (
        !construct ||
        !(
          construct.isSubMenu ||
          construct.isMenuItem ||
          construct.isMenuItemGroup
        )
      ) {
        return;
      }
      if (keys.indexOf((c as any).key) !== -1) {
        ret.find = true;
      } else if (c.props.children) {
        loopMenuItemRecursively(c.props.children, keys, ret);
      }
    }
  });

The problem here when recursively iterating of the tree is that it is looking for type MenuSubMenu but will find instead

type:
$$typeof: Symbol(react.forward_ref)
defaultProps: undefined
displayName: "SubMenuStyled"
render: ƒ render(props, ref)
withComponent: ƒ (nextTag, nextOptions)
__emotion_base: ƒ Menu()
__emotion_forwardProp: undefined
__emotion_real: {$$typeof: Symbol(react.forward_ref), displayName: "SubMenuStyled", defaultProps: undefined, __emotion_real: {…}, render: ƒ, …}
__emotion_styles: (2) ["label:MenuStyled;", {…}]

therefore not adding the functionality to manage classes added and removed.

My solution is not worry about individual components for each menu component but instead create a parent wrapper with nested (less / scss) styles.

const MenuStyled = styled(Menu)`
  .ant-menu-item-group {
    .ant-menu-item-group-title {
      color: pink;
    }
  }
  
  .ant-menu-submenu {
    .ant-menu-submenu-selected {
      color: green;
    }
  }
  
  .ant-menu-item {
    background: blue;
  }
`;

@rrdls
Copy link

rrdls commented Jun 16, 2020

In this approach, are you overriding the style of the Ant Design itself? Or just taking advantage of the html structure?

@kozak-iz-kh
Copy link

I use the less approach to override default (global theme styles) only once in the config file, and then use styled components to create a parent wrapper as adam-s mentioned above.

@kozak-iz-kh
Copy link

In this approach, are you overriding the style of the Ant Design itself? Or just taking advantage of the html structure?

Not sure about what do you mean under "just taking advantage of the html structure".

But, that way Ant design styles will be overriden.

@abhilashiic
Copy link

Overriding antd component using styled-component is working fine.
But it is not working on Modal

const StyledModal = styled(Modal)`
   .ant-modal-content {
        border-radius: 1rem;
    }
`

But there is not appearing styled-component created class.

@jorisw
Copy link

jorisw commented Aug 28, 2020

Double check whether you're targeting the right element.

@pranjalsuyal
Copy link

The problem I'm facing with this approach is that after wrapping the Ant Design components with styled I'm missing several methods from the original Component. For example, I missed Modal.info, Modal.useModal, etc.

Hey did anyone find any way to encounter this issue ?

@lucascurti
Copy link

lucascurti commented Nov 6, 2020

The problem I'm facing with this approach is that after wrapping the Ant Design components with styled I'm missing several methods from the original Component. For example, I missed Modal.info, Modal.useModal, etc.

Hey did anyone find any way to encounter this issue ?

You can use hoist-non-react-statics

hoistNonReactStatics(MyModal, AntModal);

@shashankKeshava
Copy link

shashankKeshava commented Dec 16, 2020

This is working great for me. Just importing antd and not loading its LESS stylesheets, then wrapping the imported component in styled(), looks like the way to go for us.

@jorisw Is this solution still working for you? I have installed "antd": "^4.9.4", which is overriding all custom styles.

const StyledTitle = styled(Search)`
	.ant-input-group-wrapper {
		width: 60%;
	}
`;

Also, the className is not being recognized
image

@GabeCabrera
Copy link

Just for contribution, I ran into some troubles when trying to override a component's base class. If you want to override a base class property just wrap the styles in triple & just like this:
const NewButton = styled(Button)' &&& { background: red; } ';

If you don't, the changes you want to do will just be ignored

This worked for me, I'm a little unfamiliar with using that type of selector. Why does this work? is this essentially just the same thing as directly using the class selector but in this case you don't need the actual class name?

@johnkingzy
Copy link

Here is a starter kit for NextJS 🔗 Ant Design 🔗 Styled-Component ⚡️ + Typescript

@indrajitbnikam
Copy link

Overriding antd component using styled-component is working fine.
But it is not working on Modal

const StyledModal = styled(Modal)`
   .ant-modal-content {
        border-radius: 1rem;
    }
`

But there is not appearing styled-component created class.

This won't work as modal is usually at root level. Just go to developer tools and try to understand where this modal is in the DOM. If it is at root then you might have to add styles in global styles probably.

@abhilashiic
Copy link

abhilashiic commented Sep 29, 2021 via email

@akashennn
Copy link

Amazing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment