Usage

Those templates dependencies are maintained via pnpm via pnpm up -Lri.

This is the reason you see a pnpm-lock.yaml. That being said, any package manager will work. This file can be safely be removed once you clone a template.

$ npm install # or pnpm install or yarn install

Learn more on the Solid Website and come chat with us on our Discord

Available Scripts

In the project directory, you can run:

npm run dev or npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

npm run build

Builds the app for production to the dist folder. It correctly bundles Solid in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

Deployment

You can deploy the dist folder to any static host provider (netlify, surge, now, etc.)

How to use

SolidJS component

In order to use the components as SolidJS components in a SolidJS package, follow this example on how to use ActionButtons.

import { ActionButtons } from '@brainfish-ai/solid-components'; // import component
import styles from '@brainfish-ai/solid-components/styles?inline'; // import styles

...
// use it as per normal
<ActionButtons actions={props.searchIntent.actions} />

Using it as part of WebComponent

To use it as part of a web component, the styles will need to be injected into the ShadowDOM:

import { ActionButtons } from '@brainfish-ai/solid-components'; // import component
import styles from '@brainfish-ai/solid-components/styles?inline'; // import styles

...
// use it as per normal
<ActionButtons actions={props.searchIntent.actions} />

Web Component

In order to use the components as web components in an environment that doesn't use SolidJS, eg. ReactJS, do the following:

// create a wrapper component for the web component.
import type { ActionButtonsProps } from '@brainfish-ai/solid-components';
import React, { useEffect, useRef } from 'react';
declare global {
  namespace JSX {
    interface IntrinsicElements {
      'action-buttons': React.DetailedHTMLProps<
        React.HTMLAttributes<HTMLElement>,
        HTMLElement
      > & { class?: string };
    }
  }
}
type ActionButtonsElement = HTMLElement & ActionButtonsProps;
const ActionButtons: React.FC<ActionButtonsProps> = ({ ...actions }) => {
  const ref = useRef<ActionButtonsElement | null>(null);
  useEffect(() => {
    // Dynamically import the web components
    (async () => {
      await import('@brainfish-ai/solid-components/web-components');
    })();
    // No cleanup function is needed for this effect
  }, []); // Empty dependency array means this effect runs once on mount
  useEffect(() => {
    if (!ref.current) {
      return;
    }
    Object.assign(ref.current, actions);
  }, [actions]);
  return <action-buttons ref={ref} />;
};
export default ActionButtons;