Releases: qwikifiers/qwik-ui
@qwik-ui/[email protected]
Patch Changes
-
🐞🩹 modal close handler onClick$ (by @thejackshelton in #909)
-
✨ implement a beta version of the Tooltip component (by @thejackshelton in #934)
[email protected]
@qwik-ui/[email protected]
@qwik-ui/[email protected]
Patch Changes
-
Carousel (by @thejackshelton in #894)
The carousel has been refactored from the ground up, including new features, components, and QOL updates. It is still in a draft state, and development is ongoing.
Dropdown
More improvements have been made to the dropdown component, including new features, components, and QOL updates.
[email protected]
@qwik-ui/[email protected]
Minor Changes
-
Combobox v2, New Dropdown Component, and Progress bar reaches beta! (by @thejackshelton in #838)
0.5 continues our move towards a 1.0 release. It includes a few breaking changes to the Combobox in order to make sure that the components have a clear API.
Below is a migration guide of API's for the Combobox.
Combobox
The combobox has been refactored from the ground up, including new features, components, and QOL updates.
Anatomy changes
The new Combobox anatomy is as follows:
import { component$ } from '@builder.io/qwik'; import { Combobox } from '@qwik-ui/headless'; import { LuCheck } from '@qwikest/icons/lucide'; export default component$(() => { return ( <Combobox.Root> <Combobox.Label>label</Combobox.Label> <Combobox.Control> <Combobox.Input /> <Combobox.Trigger>trigger</Combobox.Trigger> </Combobox.Control> <Combobox.Popover> <Combobox.Item> <Combobox.ItemLabel>item label</Combobox.ItemLabel> <Combobox.ItemIndicator> <LuCheck /> </Combobox.ItemIndicator> </Combobox.Item> </Combobox.Popover> </Combobox.Root> ); });
Anatomy Changes
-
Combobox.Option has been renamed to Combobox.Item:
- The item is no longer restricted to a string value; any UI can be placed inside the item.
- Use the
Combobox.ItemLabel
component to display the item's label, which becomes the item's value if novalue
prop is passed to theCombobox.Item
. (required)
-
Combobox.Listbox has been deprecated.
-
Combobox.ItemLabel has been added:
- Move the string value that was once inside
Combobox.Option
intoCombobox.ItemLabel
. (required)
- Move the string value that was once inside
-
Combobox.ItemIndicator has been added:
- This component is used to render UI based on the selected state of the item. (optional)
-
Combobox.Description has been added:
- The text rendered inside the description component is displayed to screen readers as an accessible description of the combobox. (optional)
-
Combobox.ErrorMessage has been added:
- When this component is rendered, the Combobox will be marked as invalid. (optional)
-
Combobox.HiddenNativeSelect has been added:
- A native select element allows the submission of forms with the combobox. This component is visually hidden and hidden from screen readers. (optional)
-
Combobox.Group has been added:
- Used to visually group related items together. (optional)
-
Combobox.GroupLabel has been added:
- Provides an accessible name for the group. (optional)
-
Combobox.Empty has been added:
- Displays a message when there are no items to display.
- Previously, an empty popup was displayed when the combobox was empty. The new default behavior is to close the popup unless the
Combobox.Empty
component is rendered. (optional)
API Changes
Rendering Items (required)
The
optionRenderer# Changelog prop on the
Combobox.Listbox` component has been deprecated.Instead:
- pass a
<Combobox.Item />
as a child of the<Combobox.Popover />
component. - pass a
Combobox.ItemLabel
as a child of the<Combobox.Item />
component.
It should look something like this:
<Combobox.Popover> <Combobox.Item> <Combobox.ItemLabel>item label</Combobox.ItemLabel> {/* other content */} </Combobox.Item> </Combobox.Popover>
You are now in full control of how the item is rendered. Because you control the rendering of the item, there is no need for the previous API's including the data's key values.
optionDisabledKey
,optionValueKey
, andoptionLabelKey
props have been removed.There is also no need to pass an
index
prop to theCombobox.Item
component. It is handled automatically.Pass in distinct values
The
value
prop has been added to theCombobox.Item
component to allow for passing in a distinct value for the combobox.For example, identifying a user by their ID, rather than the display username.
Add your own filter
Filters are an important part of the combobox. It was a design decision in this refactor to make filtering data as easy as possible to integrate with other tools and libraries.
The
filter# Changelog prop has been replaced. Instead, items are by default filtered by the
includes` function.To opt-out of the default filter, add the
filter={false}
prop to theCombobox.Root
component, which will disable the default filter.import { component$, useSignal, useStyles$, useTask$ } from '@builder.io/qwik'; import { Combobox } from '@qwik-ui/headless'; import { LuCheck, LuChevronDown } from '@qwikest/icons/lucide'; import { matchSorter } from 'match-sorter'; export default component$(() => { useStyles$(styles); const inputValue = useSignal(''); const filteredItems = useSignal<string[]>([]); const fruits = [ 'Apple', 'Apricot', 'Bilberry', 'Blackberry', 'Blackcurrant', 'Currant', 'Cherry', 'Coconut', ]; useTask$(({ track }) => { track(() => inputValue.value); filteredItems.value = matchSorter(fruits, inputValue.value); }); return ( <Combobox.Root filter={false}> <Combobox.Label>Fruits</Combobox.Label> <Combobox.Control> <Combobox.Input bind:value={inputValue} /> <Combobox.Trigger> <LuChevronDown /> </Combobox.Trigger> </Combobox.Control> <Combobox.Popover gutter={8}> {filteredItems.value.map((fruit) => ( <Combobox.Item key={fruit}> <Combobox.ItemLabel>{fruit}</Combobox.ItemLabel> <Combobox.ItemIndicator> <LuCheck /> </Combobox.ItemIndicator> </Combobox.Item> ))} </Combobox.Popover> </Combobox.Root> ); });
The above example uses the
matchSorter
function from thematch-sorter
library to filter the items.bind:value
instead ofbind:selectedIndex
bind:value has been added in favor of what was previously used to reactively control the combobox, bind:selectedIndex.
This change was needed to create a more consistent API across components, but also keeping the state in the case of custom filters.
onChange# Changelog has been added to the
Combobox.Root` component so that you can listen to when the selected value changes.Add initial values to the combobox
The
value
prop has been added to theCombobox.Root
component to select the initial value of the combobox when it is rendered.defaultLabel
has been removed, as it does not reflect the selected state of the combobox.Input state management
bind:inputValue
(on the Root) has been replaced by using thebind:value
prop on the<Combobox.Input />
component instead.You can also now listen to when the input value changes by using the
onInput# Changelog prop on the
<Combobox.Root />` component.Passing refs to the combobox (experimental)
The combobox is the first component to support passing refs! You can now pass a ref of your own to any component inside the combobox. This is an experimental feature, and we are still working on it, use at your own risk.
const inputRef = useSignal<HTMLInputElement>(); <Combobox.Input ref={inputRef} /> <button onClick$={() => (inputRef.value?.focus())}>Focus input</button>
Multiple selections
You can now select multiple items by passing the
multiple
prop to the<Combobox.Root />
component.removeOnBackspace
When in multiple selection mode, and the
removeOnBackspace
prop has been added to theCombobox.Root
component, selected items can be removed by pressing the backspace key. (when the input is empty)Managing display values
bind:displayValue
has been added to theCombobox.Root
component to allow for grabbing the updated display values of the combobox.This allows for full control over each display item. For example, a couple of display values shown as pills.
Item indicators
The item indicator shows when the item is selected. Inside can be the UI of choice.
bind:open
instead ofbind:isListboxOpen
bind:open has been added to control the open state of the listbox, replacing bind:isListboxOpen.
onOpenChange# Changelog has been added to the
Combobox.Root` component so that you can listen to when the popup opens or closes.Focus State Management
bind:isInputFocused has been deprecated. Instead, if you decide to manage focus state using event handlers like onFocus$ and onBlur$. OR pass a ref to the
Combobox.Input
component.Placeholders
The placeholder prop has been added to the
Combobox.Root
component to allow for a custom placeholder.Environment
Like many of the latest components in Qwik UI, each function of the Combobox has been optimized to run in both SSR or CSR automatically depending on the environment.
Looping
Looping is now opt-in by default. To enable looping, add the
loop
prop to theCombobox.Root
component.Scrolling
When a scrollbar is present, the combobox will now properly scroll to the selected item. The scroll behavior can be customized using the
scrollOptions
p... -
@qwik-ui/[email protected]
Patch Changes
-
✨ new Select.ErrorMessage component (by @thejackshelton in #825)
feat: data-invalid attribute to style when the select is invalid
feat: new Select.Description component
@qwik-ui/[email protected]
Patch Changes
-
🐞🩹 select validates correctly with modular forms (by @thejackshelton in #814)
-
refactor: improved select focus navigation (by @thejackshelton in #822)
-
🐞🩹 select can now be reactively disabled (by @thejackshelton in #823)
@qwik-ui/[email protected]
Patch Changes
- ✨ accordion items can now open without a value using the
open
prop. use only in multiple mode. (by @thejackshelton in #803)