@ringcentral/spring-base

Core utilities and hooks for Spring UI.

Note: If you already use @ringcentral/spring-ui, these utilities are re-exported there. You can import them directly from @ringcentral/spring-ui (recommended), or from @ringcentral/spring-base if you only use the base package.

Installation

Using yarn:

yarn add @ringcentral/spring-base

Using npm:

npm i @ringcentral/spring-base

Usage

// If your app already installs @ringcentral/spring-ui (recommended)
import { twMerge } from '@ringcentral/spring-ui';

// Or, when using the package directly
import { twMerge } from '@ringcentral/spring-base';

Utilities

twMerge

Merge Tailwind classes with Spring UI class groups.

import { twMerge } from '@ringcentral/spring-base';

twMerge('typography-label', 'typography-detailBold');
// => 'typography-detailBold'

Example Hook

import * as React from 'react';
import { useDebounce } from '@ringcentral/spring-base';

function Search({ onQuery }: { onQuery: (q: string) => void }) {
  const [value, setValue] = React.useState('');
  const debounced = useDebounce(value, 300);
  React.useEffect(() => onQuery(debounced), [debounced, onQuery]);
  return <input value={value} onChange={e => setValue(e.target.value)} />;
}

License

MIT