SolidJS•14mo ago

What's the most idiomatic way of forwarding an onClick event handler?

Given a Button component that wraps a <button>, what's the best way to forward the onClick handler? Seems handlers can be functions or tuples. When passing the prop directly to the button,

<button onClick={props.onClick}>...</button>

<button onClick={props.onClick}>...</button>

the linter complains that props.onClick is reactive, but handlers are not This is how I'm doing it currently,

export function Option(
  props: ParentProps<{
    onClick: JSX.HTMLElementTags["button"]["onClick"];
  }>,
) {
  const clickHandler: JSX.EventHandlerUnion<HTMLButtonElement, MouseEvent> = (
    e,
  ) => {
    if (!props.onClick) return;

    if (typeof props.onClick === "function") return props.onClick(e);

    props.onClick[0](props.onClick[1], e);
  };
  return (
    <button
      type="button"
      onClick={clickHandler}
    >
      {props.children}
    </button>
  );
}

export function Option(
  props: ParentProps<{
    onClick: JSX.HTMLElementTags["button"]["onClick"];
  }>,
) {
  const clickHandler: JSX.EventHandlerUnion<HTMLButtonElement, MouseEvent> = (
    e,
  ) => {
    if (!props.onClick) return;

    if (typeof props.onClick === "function") return props.onClick(e);

    props.onClick[0](props.onClick[1], e);
  };
  return (
    <button
      type="button"
      onClick={clickHandler}
    >
      {props.children}
    </button>
  );
}

10 Replies

Jules•14mo ago

I use this method with no trouble, or linter errors, thus far, though I have no idea if it is the most idiomatic solution:

export const Button = (props: {
  class?: string;
  onClick?: (event: MouseEvent) => void;
  children?: JSX.Element | string;
}) => {
  // much of the functionality omited for brevity
  return (
    <button onClick={props.onClick} class={cn('btn', styles, props.class)}>{props.children}</button>
  );
};

export const Button = (props: {
  class?: string;
  onClick?: (event: MouseEvent) => void;
  children?: JSX.Element | string;
}) => {
  // much of the functionality omited for brevity
  return (
    <button onClick={props.onClick} class={cn('btn', styles, props.class)}>{props.children}</button>
  );
};

aryzingOP•14mo ago

Is the suggestion code above processed by Solid's ESLint plugin? An error is reported when reproducing the above code on a file processed by Solid's ESLint plugin,

import { VoidProps } from "solid-js";

export function Option(
  props: VoidProps<{
    text: string;
    onClick?: (event: MouseEvent) => void;
  }>,
) {
  return (
    <button type="button" onClick={props.onClick}>
      {props.text}
    </button>
  );
}

import { VoidProps } from "solid-js";

export function Option(
  props: VoidProps<{
    text: string;
    onClick?: (event: MouseEvent) => void;
  }>,
) {
  return (
    <button type="button" onClick={props.onClick}>
      {props.text}
    </button>
  );
}

the error,

The reactive variable 'props.onClick' should be wrapped in a function for reactivity. This includes event handler bindings on native elements, which are not reactive like other JSX props. eslint(solid/reactivity)

The reactive variable 'props.onClick' should be wrapped in a function for reactivity. This includes event handler bindings on native elements, which are not reactive like other JSX props. eslint(solid/reactivity)

Linter error info: https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/reactivity.md

bigmistqke•14mo ago

https://playground.solidjs.com/anonymous/ca60dce9-cc78-4ebc-b9b8-876566afc9b7

Solid Playground

Quickly discover what the solid compiler will generate from your JSX template

bigmistqke•14mo ago

I initially thought it was a false positive bc the linter is quite aggressive but in this case the linter is correct, if you don't wrap the prop in a function it will not re-assign it if the prop ever updates. pretty unexpected behavior imo

REEEEE•14mo ago

event handlers are not reactive afaik

bigmistqke•14mo ago

you know if this is mentioned anywhere in the old/new docs?

REEEEE•14mo ago

https://www.solidjs.com/docs/latest/api#on___oncapture___:~:text=Events%20are%20never%20rebound%20and%20the%20bindings%20are%20not%20reactive%2C%20as%20it%20is%20expensive%20to%20attach%20and%20detach%20listeners.%20Since%20event%20handlers%20are%20called%20like%20any%20other%20function%20each%20time%20an%20event%20fires%2C%20there%20is%20no%20need%20for%20reactivity%3B%20shortcut%20your%20handler%20if%20desired.

SolidJS

Solid is a purely reactive library. It was designed from the ground up with a reactive core. It's influenced by reactive principles developed by previous libraries.

vaalha•14mo ago

https://github.com/solidjs-community/solid-primitives/tree/main/packages/props#combineProps works great for this

GitHub

solid-primitives/packages/props at main · solidjs-community/solid-p...

A library of high-quality primitives that extend SolidJS reactivity. - solidjs-community/solid-primitives

Jules•14mo ago

Yeah strangely it is - I don't know why I don't see the same error, am using plugin:solid/typescript

Gaming

Programming

What's the most idiomatic way of forwarding an onClick event handler?