This package contains a set of utility functions and React hooks designed to simplify common tasks and enhance your development experience. Below is an overview of each helper function and hook, along with usage examples.
npm install @piplup/utils
or
yarn add @piplup/utils
or
pnpm add @piplup/utils
Removes all falsey values from an array.
import { compact } from '@piplup/utils';
const result = compact([0, 1, false, 2, '', 3]);
// => [1, 2, 3]
Executes a series of functions sequentially with the same arguments.
import { execSequentially } from '@piplup/utils';
const log1 = (message: string) => console.log(`Log1: ${message}`);
const log2 = (message: string) => console.log(`Log2: ${message}`);
const executeLogs = execSequentially(log1, log2);
executeLogs('Hello');
// Output:
// Log1: Hello
// Log2: Hello
Checks if an object has a property with the specified key.
import { hasOwnProperty } from '@piplup/utils';
const obj = { key: 'value' };
if (hasOwnProperty(obj, 'key')) {
console.log(obj.key); // Output: 'value'
}
Sets a React ref or callback ref to a specified value.
import { setRef } from '@piplup/utils';
const ref = React.createRef<HTMLDivElement>();
setRef(ref, document.createElement('div'));
Creates a function that forwards an instance to multiple refs.
import * as React from 'react';
import { forkRef } from '@piplup/utils';
type TextInputProps = React.InputHTMLAttributes<HTMLInputElement>;
function TextInputComponent(props: TextInputProps, ref?: React.Ref<HTMLInputElement>) {
const internalRef = React.useRef<HTMLInputElement>(null);
// Combine internalRef and ref received from parent component
const handleInputRef = React.useMemo(() => forkRef(internalRef, ref), []);
return (
<input
placeholder="Type something here"
{...props}
ref={handleInputRef} // Pass the combined ref to the input
/>
);
}
const TextFieldInput = React.forwardRef(TextInputComponent);
export default TextFieldInput;
Returns a stable callback function that always refers to the latest version of the passed function.
import { useEventCallback } from '@piplup/utils';
const MyComponent = () => {
const handleClick = useEventCallback(() => {
console.log('Clicked!');
});
return <button onClick={handleClick}>Click me</button>;
};
A hook for listening to events in react.
import { useEventListener } from '@piplup/utils';
const MyComponent = () => {
useEventListener('resize', () => {
console.log('Window resized');
});
return <div>Resize the window</div>;
};
Combines multiple refs into a single ref callback.
import { useForkRef } from '@piplup/utils';
const MyComponent = () => {
const ref1 = React.useRef<HTMLDivElement>(null);
const ref2 = React.useRef<HTMLDivElement>(null);
const forkedRef = useForkRef(ref1, ref2);
return <div ref={forkedRef}>Combined refs</div>;
};
A hook that uses useLayoutEffect
on the client side and useEffect
on the server side.
import { useIsomorphicEffect } from '@piplup/utils';
const MyComponent = () => {
useIsomorphicEffect(() => {
console.log('Effect runs on the client side');
}, []);
return <div>Check the console</div>;
};
A hook for reading value stored in localStorage
import { useLocalStorage, setItem, removeItem } from '@piplup/utils';
const MyComponent = () => {
const [value, setValue] = useLocalStorage('myKey', 'initialValue');
return (
<div>
<p>Stored value: {value}</p>
<button onClick={() => setItem('myKey', 'newValue')}>Set New Value</button>
<button onClick={() => removeItem('myKey')}>Remove Value</button>
</div>
);
};