Solid Component in React App using Web Components

Fatih Pense — Sat, 10 Jul 2021 16:51:39 +0000

I wanted to use a Solid element inside a React app. In the end, I was pleasantly surprised how smooth everything went.

This is a quick guide that highlights important steps.

Advantages

You can use the same component everywhere, even without frameworks.
Output size is very small and doesn't contain a big runtime.
All the good stuff Solid brings.

Scope

Using React component in Solid, or having children React components in this Custom Component are hard problems I won't mention.

Resources

solid-element library:
https://github.com/solidjs/solid/tree/main/packages/solid-element

It is easier to have some understanding before diving in:
https://developer.mozilla.org/en-US/docs/Web/Web_Components

Best practices:
https://developers.google.com/web/fundamentals/web-components/best-practices
"Aim to only accept rich data (objects, arrays) as properties."

Steps

1- Start with the template
npx degit solidjs/templates/ts my-app

2- Add dependencies
pnpm i solid-element

3- Change vite.config.ts

import { defineConfig } from "vite";
import solidPlugin from "vite-plugin-solid";

const path = require('path')

export default defineConfig({
  plugins: [solidPlugin()],
  build: {
    target: "esnext",
    polyfillDynamicImport: false,
    lib: {
      entry: path.resolve(__dirname, 'src/MyComponent.tsx'),
      name: 'MyLib'
    },
  },
});

4- Create Component MyComponent.tsx

import { onMount, createSignal, createEffect, For } from "solid-js";
import { createStore } from "solid-js/store";

import { customElement } from "solid-element";

const [getData, setData] = createSignal("");

interface Options {
  option1: string;
  option2: number;
}

customElement(
  "my-custom-component",
  {
    data: { getData, setData, getOtherData: null },
  },
  (
    props: {
      data: {
        // flowdata: string;
        getData: () => string;
        setData: (v: string) => string;
        getOtherData: (options: Options) => Promise<string>;
      };
    },
    { element }
  ) => {
    let internal_el;

    props.data.getOtherData = async (
      options: Options = { option1: "default", option2: 1 }
    ): Promise<string> => {
      let promise = new Promise<string>((resolve, reject) => {
        //do something
        resolve("data");
      });
      return promise;
    };

    const [state, setState] = createStore({});

    onMount(() => {
      // code
    });

    createEffect(() => {
      // getData() will be reactive here
      // you can use the passed data to do calculation / render elements
      getData();
    });

    return <div ref={internal_el}></div>;
  }
);

5- Change package.json name field:
"name": "my-custom-component"

6- Run npm run build
Now you can see the result under dist directory. That is all. You can copy my-custom-component.es.js to your React project, or use some multi-repo setup.

7- On the React side of things, you can use methods to exchange data with the Custom Component.


import "../vendor/my-custom-component.es.js";

function Component1(props) {
  const customControlRef = useRef<any>(null);

  useEffect(() => {
    customControlRef.current.data.setData(specialData);
  }, []);

  const getData2 = async (ev) => {
    await customControlRef.current.data.getOtherData();
  };

  return (
    <div>
      <my-custom-component ref={customControlRef}></my-custom-component>

      <button className="button" onClick={getData2}>
        Get some data from Custom Component
      </button>
    </div>
  );
}

8- Bonus: If you are using Typescript add this before the component code in React.

declare global {
  namespace JSX {
    interface IntrinsicElements {
      "my-custom-component": React.DetailedHTMLProps<
        React.HTMLAttributes<HTMLElement>,
        HTMLElement
      >;
    }
  }
}

Using fluentui-icons with Solid & Vite

Fatih Pense — Thu, 08 Jul 2021 20:26:20 +0000

Microsoft has a great MIT licensed icon library that contains ~1700 unique icons(regular and filled styles for each) here:
https://github.com/microsoft/fluentui-system-icons

There is no library to use for Solid at the moment. This post documents some methods to use these icons.

You should also check out Heroicons library by @amoutonbrady https://github.com/amoutonbrady/solid-heroicons

The first approach involves copying the SVG for each icon and creating components like below. Or maybe process all of SVGs to create the components, and publish a library while you are at it.

interface IFluentIconsProps {
  primaryFill?: string;
  className?: string;
  size?: number;
}

export const Settings24Regular = (iconProps: IFluentIconsProps) => {
  let { primaryFill, className, size } = iconProps;
  if (!size) {
    size = 24;
  }
  return (
    <svg
      width={size}
      height={size}
      viewBox="0 0 24 24"
      xmlns="http://www.w3.org/2000/svg"
      className={className}
      fill={primaryFill}
    >
      <path
        d="(...removed for brevity...)"
        fill="#212121"
      />
    </svg>
  );
};

The second approach involves a quick workaround that doesn't require extra work for each icon.

1- Install:
npm install @fluentui/svg-icons

2- Import the icons you want to use (note "?raw" at the end, that is important for Vite to get this SVG as text)

import Settings24Regular from "@fluentui/svg-icons/icons/settings_24_regular.svg?raw";`

3- You can add some styling with CSS. Here I'm using Solid Styled Components

const SmallIcon = styled("div")`
  svg {
    width: 40px;
    height: 40px;
    fill: rebeccapurple;
  }
  flex-shrink: 0;
`;

4- Use it!

 <SmallIcon innerHTML={Settings24Regular}></SmallIcon>