Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 2.47 KB

README.md

File metadata and controls

68 lines (47 loc) · 2.47 KB
Raw

overflow-cue

A react hook that takes a set of horizontal overflowing items, such as tabs, and ensures an item is cropped appropriately to indicate the container is scrollable.

Homepage

https://chadspencer.dev/overflowCue/

Usage

The hook first determines if the items are overflowing their container on load and upon resizing. If they are overflwoing it will count the maximum number of items that can be visible and sets all the item widths to ensure the first overflowing item gets visually chopped so the user knows the container is scrollable without the need for a scrollbar or other visual cue.

import { useOverflowCue } from 'overflow-cue';

const container = useOverflowCue(padding, buffer, selector);

The padding param is required and should be set to the horiztonal padding value of the item. An optional buffer number can be set to give more fine-tuned control over how much of the cropped text is shown. Lastly, an optional selector can be used to target a nested element that should receive the padding adjustments. This selector must be a valid CSS selector.

The hook must be assigned via use of a ref, therefore it can only be applied to a functional component when using forwardRef. If you are consuming a functional component that you cannot add forwardRef to, you must use a wrapper element to attach the ref to and style that container accordingly.

Note: When the item text length is short there are occasional scenarios where the cropped text won't show properly. This happens when the total horizontal padding is greater than the text length of an item. In these situations, reduce the horizontal padding of the items.

Parameters

useBottomScrollListener(
  padding: number
  buffer?: number
  selector?: string
);

Example

import { useOverflowCue } from 'overflow-cue';

const tabs = useOverflowCue(20, 4);

return (
  <nav ref="tabs">
    <a href="">Item 1</a>
    <a href="">Item 2</a>
    <a href="">Item 3</a>
    <a href="">Item 4</a>
    <a href="">Item 5</a>
  </nav>
);

Package Contents

The package contains the following directories and files:

package.json
CHANGELOG.md
README.md
/dist
  └───index.js - 0.36 KB
  └───cue.js - 2 KB

Dependencies

overflow-cue does not have any dependencies. However, it does make use of React Hooks so it does have a peer dependency of "react": ">=16.8.0".