Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use var(--anchor-max-height) when using the anchor prop #3148

Merged
merged 2 commits into from Apr 29, 2024

Conversation

RobinMalfait
Copy link
Collaborator

@RobinMalfait RobinMalfait commented Apr 26, 2024

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.:

<Combobox>
  <ComboboxInput />
  <ComboboxOptions anchor="bottom start" className="[--anchor-gap:var(--spacing-4)] [--anchor-max-height:var(--spacing-60)]">
    <ComboboxOption>Option 1</ComboboxOption>
    <ComboboxOption>Option 2</ComboboxOption>
    <ComboboxOption>Option 3</ComboboxOption>
  </ComboboxOptions>
</Combobox>

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>
```
Copy link

vercel bot commented Apr 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
headlessui-react ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 26, 2024 10:17pm
headlessui-vue ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 26, 2024 10:17pm

@RobinMalfait RobinMalfait merged commit beaae6a into main Apr 29, 2024
8 checks passed
@RobinMalfait RobinMalfait deleted the feat/anchor-max-height branch April 29, 2024 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants