lxsmnsyc / solid-sfc

Experimental SFC compiler for SolidJS

solid-sfc

An experimental SFC syntax for SolidJS, extends solid-labels

Install

npm install solid-sfc

yarn add solid-sfc

pnpm add solid-sfc

Usage

Basic example

// Required for files that do not end in `.solid.(t|j)sx?`
'use solid-sfc';

let count = $signal(0);
let message = $memo(`Count: ${count}`);

effect: {
  console.log(message);
};

// Export default is synonymous to "return".
export default <h1>{message}</h1>;

<solid:fragment>, <solid:slot> and <solid:children>

If a component accepts a property that renders an element, you can use <solid:fragment> to render that property's element for the component to receive. <solid:fragment> has a single attribute, name which is used to define the fragment's key in the props of that component.

<solid:suspense>
  <solid:fragment name="fallback">
    <h1>Loading...</h1>
  </solid:fragment>
  <Profile />
</solid:suspense>

Which is equivalent to

<Suspense fallback={<h1>Loading</h1>}>
  <Profile />
</Suspense>

You can use <solid:slot> to render the received fragment on the component's side. <solid:slot> also has the name attribute to pick from the props.

/* Example.solid.jsx */
export default <solid:slot name="example" />

/* ParentExample.solid.jsx */
import Example from './Example.solid';

export default (
  <Example>
    <solid:fragment name="example">
      <h1>Hello World</h1>
    </solid:fragment>
  </Example>
);

$props

$props is a compile-time function that provides access to the component's props.

const props = $props();

export default <h1>{props.message}</h1>;

For Typescript, you can pass a type for the generic parameter:

interface Props {
  message: string;
}

const props = $props<Props>();

export default <h1>{props.message}</h1>;

$view

For TypeScript to infer SFCs correctly, you can $view on the render part of the code.

// Message.solid.tsx
interface Props {
  message: string;
}

const props = $props<Props>();

export default $view<Props>(<h1>{props.message}</h1>);

// App.solid.tsx
import Message from './Message.solid';

export default <Message message="Hello World" />

Tooling

TypeScript

/// <reference types="babel-plugin-solid-sfc" />

License

MIT © lxsmnsyc