Get Started #

Installation #

You can use the package manager which you like, such as npm, yarn or pnpm:

$ npm install @soliduse/core --save
# or
$ yarn add @soliduse/core --save
# or
$ pnpm install @soliduse/core --save

Usage #

After installation, you can use the functions you want in your SolidJS components.

For example, if you want to listen to the click event outside an element, you can use the useClickOutside function:

// App.tsx
let ref: HTMLElement;
function App() {
  onMount(() => {
    useClickOutside(ref, () => {
      console.log('click outside the button');
    });
  });

  return (
    <div data-testid="app">
      <button ref={ref}>Button</button>
      <span>Hello World</span>
    </div>
  );
}

Using the useClickOutside function will register a click event listener on window, which will check the target of the click event internally. If the target of the click event is ref, the callback will not be fired, otherwise, it will be fired.