Skip to content

Commit

Permalink
use var(--anchor-max-height) if available
Browse files Browse the repository at this point in the history
When using the `anchor` prop, we try to position the anchored element
within the viewport. We use the size middleware of Floating UI to ensure
we are working in a constrained `max-width` and `max-height`.

However, if you want to limit the height of let's say a
`ComboboxOptions` then you instinctively add `max-h-60` for example. The
problem is that the `max-height` set by Floating UI will win because
it's inline styles.

You could use `!max-h-60` which makes it `!important`, but then you can
run into an issue where the max height set by the user is larger than
the available space which results in combobox options that are
unavailable.

To solve this, we want best of both worlds by ensuring we prefer the
size from the user, but constrain it with the value we know.

We now read from a `var(--anchor-max-height)` variable where you can set
your own preferred max height.

E.g.:

```ts
<Combobox>
  <ComboboxInput />
  <ComboboxOptions anchor="bottom start" className="[--anchor-gap:var(--spacing-4)] [--anchor-max-height:var(--spacing-60)]">
    …
  </ComboboxOptions>
</Combobox>
```
  • Loading branch information
RobinMalfait committed Apr 26, 2024
1 parent afc9cb6 commit 82f2075
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/@headlessui-react/src/internal/floating.tsx
Expand Up @@ -316,7 +316,7 @@ export function FloatingProvider({
Object.assign(elements.floating.style, {
overflow: 'auto',
maxWidth: `${availableWidth - padding}px`,
maxHeight: `${availableHeight - padding}px`,
maxHeight: `min(var(--anchor-max-height, 100vh), ${availableHeight - padding}px)`,
})
},
}),
Expand Down

0 comments on commit 82f2075

Please sign in to comment.