Compose

▸ Compose(props): null | ReactElement<any, string | JSXElementConstructor<any>>

Composes immediate child with its props and child own props. Used to implement Shoreline composition

Parameters

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Example

function Button({ asChild, ...props }) {
  const Composition = asChild ? Compose : "button";
  return <Composition {...props} />;
}

import React from 'react'
import { Composition } from '@vtex/shoreline-components'
export default function App() { return (<>function Button({ asChild, ...props }){ const Composition = asChild ? Compose : 'button' return <Composition {...props} />}</>)}

Defined in

node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/ts5.0/index.d.ts:355