useOverflow API

API reference for the useOverflow composable.

Options

`container`

MaybeRefOrGetter<Element>

Container element to track. Can be a ref, getter, or MaybeRefOrGetter. When provided, useOverflow tracks this element's width automatically.

`gap`

MaybeRefOrGetter<number>

Gap between items in pixels

`reserved`

MaybeRefOrGetter<number>

Reserved space in pixels (for nav buttons, ellipsis, etc)

`itemWidth`

MaybeRefOrGetter<number>

Uniform item width in pixels. When provided, enables uniform mode where capacity is calculated as available space / itemWidth. Use this for same-width items like pagination buttons.

`reverse`

MaybeRefOrGetter<boolean>

Calculate capacity from end instead of start. Useful for breadcrumbs where trailing items take priority. Only affects variable mode (uniform mode capacity is direction-independent).