reactjs - styled-components TSX: How to generate a transient prop version of a prop interface - Stack Overflow

admin管理员组

文章数量:1344621

I'm trying to fix a piece of TSX code that shares a prop interface between a React component and a styled <div>, because the styled <div> generates warnings like this:

Warning: React does not recognize the aA prop on a DOM element. If you intentionally want it to appear in the DOM as a custom attribute, spell it as lowercase aa instead. If you accidentally passed it from a parent component, remove it from the DOM element.

The code looks something like this:

// Comp.tsx
interface Props {
  aA: boolean;
  bB: string;
  cC: '1' | '2';
}

const StyledDiv = styled.div<Props>`
  background: ${({ aA }) => aA ? 'black' | 'white'};
  // ...
`;

const Comp = ({ aA, bB, cC}: Props) => {
  if (aA) {
   // do something
  } else {
   // do something else
  }

  return <StyledDiv aA={aA} bB={bB} cC={cC}>{/*...*/}</StyledDiv>;
};

export default Comp;

// StyledComp.tsx
const StyledComp = styled(Comp)<{ dD: string, eE: number }>`
  // ...
`;

export default StyledComp;

What's the optimal way to go about this? I'm thinking of creating another interface DivProps that mirrors Props, but with transient props:

interface DivProps {
  $aA: boolean;
  $bB: string;
  $cC: '1' | '2';
}

const StyledDiv = styled.div<DivProps>`
  background: ${({ $aA }) => $aA ? 'black' | 'white'};
  // ...
`;

I don't like the idea very much because I'd have to update both Props and DivProps if there's any changes in the future. But if this is the only solution, then please let me know as well. Thanks!

I'm trying to fix a piece of TSX code that shares a prop interface between a React component and a styled <div>, because the styled <div> generates warnings like this:

Warning: React does not recognize the aA prop on a DOM element. If you intentionally want it to appear in the DOM as a custom attribute, spell it as lowercase aa instead. If you accidentally passed it from a parent component, remove it from the DOM element.

The code looks something like this:

// Comp.tsx
interface Props {
  aA: boolean;
  bB: string;
  cC: '1' | '2';
}

const StyledDiv = styled.div<Props>`
  background: ${({ aA }) => aA ? 'black' | 'white'};
  // ...
`;

const Comp = ({ aA, bB, cC}: Props) => {
  if (aA) {
   // do something
  } else {
   // do something else
  }

  return <StyledDiv aA={aA} bB={bB} cC={cC}>{/*...*/}</StyledDiv>;
};

export default Comp;

// StyledComp.tsx
const StyledComp = styled(Comp)<{ dD: string, eE: number }>`
  // ...
`;

export default StyledComp;

What's the optimal way to go about this? I'm thinking of creating another interface DivProps that mirrors Props, but with transient props:

interface DivProps {
  $aA: boolean;
  $bB: string;
  $cC: '1' | '2';
}

const StyledDiv = styled.div<DivProps>`
  background: ${({ $aA }) => $aA ? 'black' | 'white'};
  // ...
`;

I don't like the idea very much because I'd have to update both Props and DivProps if there's any changes in the future. But if this is the only solution, then please let me know as well. Thanks!

• reactjs
• typescript
• styled-components
• typescript-types

Share Improve this question Follow edited yesterday ghybs 53.5k66 gold badges8787 silver badges114114 bronze badges asked yesterday tearfurtearfur 9777 bronze badges

Add a comment  | 

2 Answers 2

Sorted by: Reset to default 1

That is the use case for the shouldForwardProp option of .withConfig() method:

This is a more dynamic, granular filtering mechanism than transient props. It's handy in situations where multiple higher-order components are being composed together and happen to share the same prop name. shouldForwardProp works much like the predicate callback of Array.filter. A prop that fails the test isn't passed down to underlying components, just like a transient prop.

In your case:

const StyledDiv = styled.div.withConfig({
  shouldForwardProp: (prop) => !["aA", "bB", "cC"].includes(prop)
})<Props>`
  background: ${({ aA }) => aA ? 'black' : 'white'};
  // ...
`;

---

A more general solution would be to setup a global shouldForwardProp thanks to the StyleSheetManager:

import isPropValid from '@emotion/is-prop-valid';
import { StyleSheetManager } from 'styled-components';


function MyApp() {
    return (
        <StyleSheetManager shouldForwardProp={shouldForwardProp}>
            {/* other providers or your application's JSX */}
        </StyleSheetManager>
    )
}


// This implements the default behavior from styled-components v5
function shouldForwardProp(propName, target) {
    if (typeof target === "string") {
        // For HTML elements, forward the prop if it is a valid HTML attribute
        return isPropValid(propName);
    }
    // For other elements, forward all props
    return true;
}

See also:

• https://styled-components/docs/faqs#shouldforwardprop-is-no-longer-provided-by-default
• Custom props not being passed through a React component with extended styles

---

If you are ready to change the API of your StyledDiv to use the $ sign for transient props, but you just want to avoid having to manually maintain the DivProps interface, you can automatically generate it thanks to TypeScript Mapped Types and Key Remapping:

type DivProps = {
  [Key in keyof Props as `$${Key}`]: Props[Key];
};

const StyledDiv2 = styled.div<DivProps>`
  background: ${({ $aA }) => ($aA ? 'black' : 'white')};
  // ...
`;

const Comp = ({ aA, bB, cC }: Props) => {
  // ...
  return (
    <>
      <StyledDiv aA={aA} bB={bB} cC={cC}>
        {/*...*/}
      </StyledDiv>
      <StyledDiv2 $aA={aA} $bB={bB} $cC={cC}>
        {/*...*/}
      </StyledDiv2>
    </>
  );
};

Demo: https://stackblitz/edit/react-ts-4dablowz?file=App.tsx

I would say that your suggestion of having a "duplicate" DivProps is actually the right way to go, this is what I would call "accidental duplication".

The thing is that there are good reasons for those two types to differ:

• Props describes the props of Comp, so you should use the props and the types that make the most sense for someone using your Comp component,
• DivProps describes the transient props used by the styled component itself, so you should use the props and types that make the most sense for someone writing the CSS.

It might be that those will be mostly the same in some cases, but not necessarily. Maybe you want an additional prop to Comp that is used to switch between different styled components? Maybe you want to send a boolean isSelected to Comp that will then be transformed into a backgroundColor? Maybe your styled component is reusable outside of Comp and takes more props that you just want to hardcode to specific values inside Comp.

There are many reasons why you would want them to differ, so trying to reuse the same type would actually prevent you from improving the API of your components in the future.

本文标签： reactjsstyledcomponents TSX How to generate a transient prop version of a prop interfaceStack Overflow