@solid-primitives/props

@solid-primitives/props

Library of primitives focused around component props.

• combineProps - Reactively merges multiple props objects together while smartly combining some of Solid's JSX/DOM attributes.
• filterProps - Create a new props object with only the property names that match the predicate.
• createProps - Provides controllable props signals like knobs/controls for simple component testing.

Installation

npm install @solid-primitives/props
# or
yarn add @solid-primitives/props

SSR Support

If you are using solid-start with SSR, you may see this error comming form the @solid-primitives/props package.

TypeError: web.template is not a function

To prevent this, add "@solid-primitives/props" entry to noExternal field in your vite config, like so:

export default defineConfig({
  plugins: [solid()],
  ssr: {
    // It allows Vite to preprocess the package
    noExternal: ["@solid-primitives/props"]
  }
});

combineProps

A helper that reactively merges multiple props objects together while smartly combining some of Solid's JSX/HTML attributes.

Event handlers (onClick, onclick, onMouseMove, onSomething), and refs (props.ref) are chained.

class, className, classList and style are combined.

For all other props, the last prop object overrides all previous ones. Similarly to Solid's mergeProps.

How to use it

import { combineProps } from "@solid-primitives/props";

const MyButton: Component<ButtonProps> = props => {
  // primitives of a lot of headless ui libraries will provide props to spread
  const { buttonProps } = createButton();
  // they can be combined with user's props easily
  const combined = combineProps(props, buttonProps);

  return <button {...combined} />;
};

// component consumer can provide button props
// they will be combined with those provided by createButton() primitive
<MyButton style={{ margin: "24px" }} />;

Chaining of event listeners

Every function/tuple property with on___ name get's chained. That could potentially include properties that are not actually event-listeners – such as only or once. Hence you should remove them from the props (with splitProps).

Chained functions will always return void. If you want to get the returned value from a callback, you have to split those props and handle them yourself.

Warning: The types for event-listeners often won't correctly represent the values. Chaining is meant only for DOM Events spreading to an element.

const combined = combineProps(
  {
    onClick: e => {},
    onclick: e => {}
  },
  {
    onClick: [(n, e) => {}, 123]
  }
);
// combined.onClick() will call all 3 of the functions above

For better reference of how exactly combineProps works, see the TESTS

Additional helpers

A couple of lower-lever helpers that power combineProps:

stringStyleToObject

const styles = stringStyleToObject("margin: 24px; border: 1px solid #121212");
styles; // { margin: "24px", border: "1px solid #121212" }

combineStyle

const styles = combineStyle("margin: 24px; border: 1px solid #121212", {
  margin: "2rem",
  padding: "16px"
});
styles; // { margin: "2rem", border: "1px solid #121212", padding: "16px" }

DEMO

https://codesandbox.io/s/combineprops-demo-ytw247?file=/index.tsx

filterProps

A helper that creates a new props object with only the property names that match the predicate.

An alternative primitive to Solid's splitProps that will split the props eagerly, without letting you change the omitted keys afterwards.

The predicate is run for every property read lazily — any signal accessed within the predicate will be tracked, and predicate re-executed if changed.

How to use it

Params:

• props — The props object to filter.
• predicate — A function that returns true if the property should be included in the filtered object.

Returns A new props object with only the properties that match the predicate.

import { filterProps } from "@solid-primitives/props";

const MyComponent = props => {
  const dataProps = filterProps(props, key => key.startsWith("data-"));

  return <div {...dataProps} />;
};

createPropsPredicate

Creates a predicate function that can be used to filter props by the prop name dynamically.

The provided predicate function get's wrapped with a cache layer to prevent unnecessary re-evaluation. If one property is requested multiple times, the predicate will only be evaluated once.

The cache is only cleared when the keys of the props object change. (when spreading props from a singal) This also means that any signal accessed within the predicate won't be tracked.

import { filterProps, createPropsPredicate } from "@solid-primitives/props";

const MyComponent = props => {
  const predicate = createPropsPredicate(props, key => key.startsWith("data-"));
  const dataProps = filterProps(props, predicate);

  return <div {...dataProps} />;
};

createProps

Primitive that provides controllable props signals like knobs/controls for simple component testing

How to use it

You can either create a single prop:

// Second argument can be initialValue for boolean, number, string:
const [string, setString, stringField] = createControlledProp("stringValue", "test");
// Arrays or enums can be provided in an options object:
const [language, setLanguage, languageField] = createControlledProp(
  "language",
  { initialValue: "en", options: ["de", "en", "fr", "it"] as const }
  // If you want your array to be able to influence the setter/getter types, use `as const`.
);
enum Currency {
  AUD,
  GBP,
  EUR,
  USD,
  CHF,
  JPY,
  CNY
}
const [currency, setCurrency, currencyField] = createControlledProp("currency", {
  initialValue: Currency.USD,
  options: Currency
});

return { languageField(); };

or multiple props in one call:

enum Test { One, Two, Three };
const languages = ['de', 'en', 'fr', 'it'] as const;
const [props, fields] = createControlledProps({
  boolean: true,
  number: 42,
  string: 'text',
  array: { initialValue: 'en', options: languages },
  enum: { initialValue: Test.Three, options: Test }
});

props == {
  boolean: Accessor<boolean>,
  setBoolean: Setter<boolean>,
  number: Accessor<number>,
  setNumber: Setter<number>,
  string: Accessor<string>,
  setString: Setter<string>,
  array: Accessor<string>,
  setArray: Setter<string>,
  enum: Accessor<Test>,
  setEnum: Setter<Test>
};

fields == JSX.Element[];

Demo

TODO

Changelog

See CHANGELOG.md