babel-plugin-solid-undestructure

This Babel plugin allows you to destructure your props in your Solid components without losing reactivity.

The plugin will "un-destructure" your props at build time, so the code you pass into the Solid compiler will not have destructured props at runtime. Instead the props will be accessed the normal way with props.someProp.

Note
This plugin is compatible with Solid 1.5

Usage with examples:

// Use the `Component` type to mark components that will be transformed by the plugin
import { Component } from 'solid-js'
const MyComp: Component<...> = ({ a, b, c }) => {a; b; c;};

//  ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓  The above code will compile to
import { Component } from 'solid-js'
const MyComp: Component<...> = props => {props.a; props.b; props.c;}



// You can use a compile time function instead of using the `Component` type (needed for vanilla JS)
import { component } from 'babel-plugin-solid-undestructure'
const MyComp = component(({ a, b, c }) => {a; b; c;})

//  ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
const MyComp = props => {props.a; props.b; props.c;}



// Default props using `mergeProps`
import { Component } from 'solid-js'
const MyComp: Component<...> = (
  { a = 1, b = 2, c = 3 } = defaultProps
) => {a; b; c;}

//  ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
import { Component, mergeProps } from 'solid-js'
const MyComp: Component<...> = props => {
  props = mergeProps(defaultProps, { a: 1, b: 2, c: 3 }, props);
  props.a; props.b; props.c;
}


// Rename props
import { Component } from 'solid-js'
const MyComp: Component<...> = ({ a: d, b: e, c: f }) => {d; e; f;}

//  ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
import { Component, mergeProps } from 'solid-js'
const MyComp: Component<...> = props => {props.a; props.b; props.c;}



// Rest element destructuring using `splitProps`
import { Component } from 'solid-js'
const MyComp: Component<...> = ({ a, b, c, ...other }) => {a; b; c; other;}

//  ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
import { Component, splitProps } from 'solid-js'
const MyComp: Component<...> = props => {
  let other;
  [props, other] = splitProps(props, ["a", "b", "c"]);
  props.a; props.b; props.c; other;
}

See also undestructure-example (or Open in Stackblitz).

Warning
This plugin doesn't have any known bugs at the moment but it's still not ready for production use.

Component type annotation

When this option is enabled (it is enabled by default), the plugin transforms all arrow function components which are part of a variable declaration with a Component type annotation.

The type annotation must be a direct reference to the Solid Component type import, or an annotation of the form Solid.Component where Solid is a reference to the default import of Solid.

In both cases you can use the 'import as' syntax.

Examples:

import { Component } from 'solid-js'

const MyComponent: Component = // ...

import Solid from 'solid-js'

const MyComponent: Solid.Component = // ...

import { Component as ComponentAlias } from 'solid-js'

const MyComponent: ComponentAlias = // ...

This example won't work:

import { Component } from 'solid-js'

type ComponentAlias = Component

const MyComponent: ComponentAlias = // ...

In this last example, MyComponent won't be transformed.

Compile time function annotation (needed for vanilla JS)

This option can be used if you are using vanilla JS or you don't want to rely on types to manipulate runtime behavior like the type annotation does. When this option is enabled (it is enabled by default), the plugin transforms all component that are wrapped in the component compile-time function provided by this plugin.

The component compile-time function must be a direct reference to the component named export from babel-plugin-solid-undestructure

You can also use the 'import as' syntax.

Examples:

import { component } from 'babel-plugin-solid-undestructure'

const MyComponent = component(/* your component goes here. */)

import { component as c } from 'babel-plugin-solid-undestructure'

const MyComponent = c(/* your component goes here. */)

This example won't work:

import { component } from 'babel-plugin-solid-undestructure'

const c = component

const MyComponent = c(/* your component goes here. */)

In this last example, MyComponent won't be transformed.

Configuring Vite

Install the plugin with

npm i -D babel-plugin-solid-undestructure

In your Vite config, import undestructurePlugin from babel-plugin-solid-undestructure

import { undestructurePlugin } from "babel-plugin-solid-undestructure"

TS with Type annotation support

If your'e working with TypeScript code and you want to use the Component type annotation, add this to the top of the plugin list in your Vite config:

...undestructurePlugin("ts")

With this configuration you can use both the Component type and the component compile time function to annotate components.

TS or vanilla JS, no type annotation support

In your Vite config, find the your vite-plugin-solid initialization (in the default Solid template it will be imported as solidPlugin).

The first argument this initialization function takes, is the options object.

Add this field to the initializer options:

babel: {
	plugins: [undestructurePlugin("vanilla-js")]
} 

With this configuration you can use both the Component type and the component compile time function to annotate components.

Features under consideration

• A pragma to annotate components
• Add option to automatically apply the transformation to every function annotated with a type with a Component suffix
• Nested component support
• Nested destructuring
• Destructure CTF (probably not but maybe)
• Add option to automatically apply the transformation to every function assigned to an identifier that starts with a capital letter and (probably not but maybe)

If you want a feature to be added to this plugin, whether it's on this list or not, please open a feature request or tell me in this discussion.

Other cool plugins for Solid:

• https://github.com/orenelbaum/babel-plugin-reactivars-solid - A Svelte-like "reactive variables" plugin for Solid that lets you pass reactive variables (getter + setter) around in a concise way (also made by me).
• https://github.com/LXSMNSYC/babel-plugin-solid-labels - Solid labels is more of an all in one plugin. It has Svelte-like reactive variables, prop destructuring (like this plugin) and more.
• https://github.com/LXSMNSYC/solid-sfc - An experimental SFC compiler for SolidJS.