Skip to content

Latest commit

 

History

History
79 lines (64 loc) · 2 KB

complete-example.md

File metadata and controls

79 lines (64 loc) · 2 KB

Complete Example

reactToWebComponent also works with React components that utilize external libraries like Material-Ui:

import { Button } from "@mui/material"
import { ThemeProvider, createTheme } from "@mui/material/styles"

interface GreetingProps {
  name: string
  description: string
  colorMode?: "light" | "dark" | undefined
  buttonVariant?: "contained" | "text" | "outlined" | undefined
}

export const Greeting = ({
  name,
  description,
  colorMode = "light",
  buttonVariant = "text",
}: GreetingProps) => {
  const themeMode = createTheme({
    palette: {
      mode: colorMode,
    },
  })

  return (
    <ThemeProvider theme={themeMode}>
      <main>
        <h1>Hello, {name}</h1>
        <p>{description}</p>
        <Button variant={buttonVariant}>This is the button</Button>
      </main>
    </ThemeProvider>
  )
}

const WebGreeting = reactToWebComponent(Greeting, {
  props: {
    name: "string",
    description: "string",
    colorMode: "string",
    buttonVariant: "string",
  },
})

customElements.define("web-greeting", WebGreeting)
<body>
  <h1>Greeting Demo</h1>

  <web-greeting name="Sven" description="How do you do?"></web-greeting>
</body>

Using reactToWebComponent with a few provided attributes, while also not filling out the colorMode or buttonVariant. This will cause the component to render with Theme Provider's Light Theme, and with the text variant for Material UI's Button Component

If we access those attributes (colorMode and buttonVariant):

<body>
  <h1>Greeting Demo</h1>

  <web-greeting
    name="Sven"
    description="How do you do?"
    color-mode="dark"
    button-variant="contained"
  >
  </web-greeting>
</body>

The Theme Provider will use the Dark Theme instead, and the Button Component wiill use the contained variant.

Thus, using reactToWebComponent you can interact with React Components using Third Party Libraries with ease.