Version Packages

[github-actions[bot]]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@qwik-ui/headless@0.4.0

Minor Changes

• Bundling improvements (by @thejackshelton in #737)

  We have reduced the bundle size significantly of the headless library. If you are a Qwik library author, please refer to this issue as it may impact your bundle size as well.

  Dot notation

  The biggest change of v0.4 is the addition of dot notation to the API. Also known as "namespaced components".

  This includes our largest breaking change to Qwik UI yet. We hope it is the largest ever, and want to ensure a much smoother transition going forward. Before we can do that, we need to make sure the API's are consistent across the library.

  The component API's have been updated to use dot notation.

  We believe that dot notation will significantly improve the developer experience. Below are some of the benefits of dot notation.

  Simple Imports

  In previous versions, imports needed to be defined for each component.

  import { Collapsible, CollapsibleTrigger, CollapsibleContent } from '@qwik-ui/headless';

  While this is trivial with three components, it can be a pain with the more "pieces" a component has.

  import {
    Combobox,
    ComboboxControl,
    ComboboxIcon,
    ComboboxInput,
    ComboboxLabel,
    ComboboxListbox,
    ComboboxOption,
    ComboboxPopover,
    ComboboxTrigger,
    ResolvedOption,
  } from '@qwik-ui/headless';

  In v0.4, the new import syntax is the following:

  import { Collapsible, Combobox } from '@qwik-ui/headless';

  TypeScript Autocomplete

  The searchability of available components has also been improved. You can now use the autocomplete feature to find a specific sub-component.

  

  Improved legibility

  For longer component names, the dot notation is arguably more legible. For example, Combobox.Listbox vs. ComboboxListbox.

  Migration Cheat Sheet

  As an easier way to migrate, we've created a mini cheat sheet below. If you have any questions, or need help migrating, don't hesistate to reach out to us on Discord.

  Components named , like are now <Accordion.Root />

  Except for and , which is now <Modal.Panel /> and <Popover.Panel /> respectively.

  With new root components, the main props have been moved to the root component. (for example, props previously on the Popover and Modal panels).

  Ex:

  <Modal bind:show> -> <Modal.Root bind:show>

  For further reference, read the RFC on dot notation.

  Popover Refactor

  Based on feedback we have received from the community, we have also improved the developer experience of the Popover component.

  import { component$ } from '@builder.io/qwik';
  import { Popover } from '@qwik-ui/headless';
  
  export default component$(() => {
    return (
      <Popover.Root gutter={4}>
        <Popover.Trigger class="popover-trigger">Click me</Popover.Trigger>
        <Popover.Panel class="popover-panel">
          I am anchored to the popover trigger!
        </Popover.Panel>
      </Popover.Root>
    );
  });

  • By default, the popover is now anchored to its trigger. The API surface should also be simpler.
  • A new hover prop has also been introduced on the root, useful for things like tooltips.
  • Programmatically toggling the popover is still possible, make sure to put the same id on the <Popover.Root /> that is passed to the usePopover hook. Refer to the docs for more info.

  <Popover.Root />

  There is a new root compomnent. Configurable props have been moved to the root component.

  Deprecated Props

  • You no longer need to style the popover open state with :popover-open. Instead, use the data-open attribute for it to style across browsers.

  .popover-panel[data-open] {
    background: green;
  }

  • You no longer need to pass a popovertarget prop to the <Popover.Trigger /> component. Same with an id prop on the <Popover.Panel /> component.
  • The placement prop has been deprecated, and combined with the floating prop.

  For example, floating="right will now float the popover to the right.

  Opting out of the floating library

  To opt-out of the floating library, set the floating={false} on the <Popover.Root /> component.

  May 2024, Chrome will be adding support for the CSS anchor API. This will allow us to remove the floating UI library entirely when that gains more support across browsers.

  Docs Improvements

  A couple of docs improvements have been made:

  • The docs have been updated to reflect the new API.
  • The headless docs no longer include styles in the examples. There is an example CSS section in each component page. If you do not find one, please open an issue on GitHub.
  • Part of the Accordion and Modal docs have been simplified
  • The examples now include icons from the qwikest/icons package rather than an abstract component you could not use.

• Modal API Changes (by @thejackshelton in #734)

  In a previous release, the following components have been deprecated:

  • ModalHeader
  • ModalContent
  • ModalFooter

  These components were native header, div, and footer elements and did nothing special under the hood. We are deprecating them in order to simplify the API and make it more consistent with the rest of the components.

  The new components are:

  <Modal.Root>

  This is the main container of the modal, and now holds the major props and configuration. Examples include:

  • 'bind:show'?: Signal;
  • closeOnBackdropClick?: boolean;
  • alert?: boolean;
  • onShow$?: QRL<() => void>;
  • onClose$?: QRL<() => void>;

  <Modal.Panel>

  Previously <Modal /> the modal panel is the dialog element that is rendered on top of the page. Its props have since been moved to the <Modal.Root /> component, please refer to the docs for more information.

  <Modal.Trigger>

  The modal now comes with a default trigger, which will open the modal when clicked.

  <Modal.Title>

  This computes the accessible name from the string children of the modal.

  <Modal.Description>

  This computes the accessible description from the string children of the modal.

  <Modal.Close>

  This is a button that closes the modal when clicked.

• Select API Changes (by @thejackshelton in #724)

  • <SelectOption /> has been renamed to <Select.ItemLabel />.
  • <Select.Value /> has been renamed to <Select.DisplayText />.

  <Select.Item />

  A new component that allows for customize of the list item.

  <Select.ItemIndicator />

  This component is used to render an icon or other visual element that is displayed next to the <Select.ItemLabel /> whenever an item is selected.

  Multi-select

  To opt-in to the multi-select mode, set the multiple prop to true. Please refer to the Multiple Selections section in the docs for more information.

  The previous API did not allow for customization of list items. The new API introduces a couple new components:

      <Select.Item>
        <Select.ItemLabel>My Display Option!</Select.ItemLabel>
        <Select.ItemIndicator>
          {/* anything goes here */}
        </Select.ItemIndicator>
      <Select.Item>

  You can now put anything you'd like in your <Select.Item />, just like a normal li tag!

  There is a new reactive signal called bind:displayText that can be used to read the value of the display text. There is a new docs example that shows this in action with item pills.

  bind syntax

  We have been exploring more with the bind syntax. bind:x is a convention based on bind:value and bind:checked, where a signal is passed and two way data binding is enabled.

  This is much more performant than previous two way data binding, thanks to signals.

  As a general note:

  name -> initial value

  anything that does not start with bind: is a static value.

  bind:name -> reactive signal

  anything that starts with bind: is a reactive signal.

  If you find yourself curious to explore the bind syntax more, try typing bind: on a root component in Qwik UI, you should see a list of available things you can reactively customize!

• Deprecated Components (by @thejackshelton in #733)

  In 0.4, we have deprecated the following headless components:

  • Drawer
  • Breadcrumb
  • Action Button
  • Button Group
  • Toast
  • Tooltip
  • Card
  • Badge
  • Spinner
  • Rating
  • Checkbox

  Most of these components were in a pre-alpha state, duplicates from the styled kit, or were not yet ready for production use. They were lying around in the codebase for a while, and we have gained many insights since then on creating accessible, unstyled, and performant components.

  You can expect the Toast and the Tooltip to come back with a much more polished form in a future release.

Patch Changes

• 🐞🩹 popover API programmatic behavior works correctly (by @thejackshelton in #730)