forked from qwikifiers/qwik-ui
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
222c33d
commit a48542e
Showing
14 changed files
with
426 additions
and
408 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,145 @@ | ||
--- | ||
'@qwik-ui/headless': minor | ||
--- | ||
|
||
## 100% Lazy execution | ||
|
||
The entire Qwik UI library does not execute code until interaction. Your components are HTML, until the user decides to interact with them. | ||
|
||
## Bundling improvements | ||
|
||
We have reduced the bundle size significantly of the headless library. If you are a Qwik library author, please refer to [this issue](https://github.com/QwikDev/qwik/issues/5473) 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. | ||
|
||
```tsx | ||
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. | ||
|
||
```tsx | ||
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: | ||
|
||
```tsx | ||
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. | ||
|
||
![component autocomplete](image-1.png) | ||
|
||
### 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 <Component>, like <Accordion> are now <Accordion.Root />** | ||
|
||
> Except for <Modal> and <Popover>, 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](https://github.com/qwikifiers/qwik-ui/issues/700) 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. | ||
|
||
```tsx | ||
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-showing and popover-closing classes have been deprecated. Please use the `data-open` and ``data-closing` attributes instead. | ||
|
||
- The `data-open`, `data-closing`, and `data-closed` data attributes have been added to the popover. | ||
|
||
#### <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. | ||
|
||
```css | ||
.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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
'@qwik-ui/headless': minor | ||
--- | ||
|
||
### Modal API Changes | ||
|
||
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<boolean>; | ||
- 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@qwik-ui/headless': patch | ||
--- | ||
|
||
fix: popover API programmatic behavior works correctly |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@qwik-ui/styled': patch | ||
--- | ||
|
||
FEAT new styled select component |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
'@qwik-ui/headless': minor | ||
--- | ||
|
||
### Select API Changes | ||
|
||
- `<SelectOption />` has been renamed to `<Select.ItemLabel />`. | ||
- `<Select.Value />` has been renamed to `<Select.DisplayValue />`. | ||
|
||
### `<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: | ||
|
||
```tsx | ||
<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:displayValue` 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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
--- | ||
'@qwik-ui/styled': minor | ||
--- | ||
|
||
## tailwind.config.cjs | ||
|
||
Now uses tailwindcss-animate | ||
|
||
```ts | ||
plugins: [ | ||
require('tailwindcss-animate'), | ||
... | ||
], | ||
``` | ||
|
||
Instead of manually defined animations through a custom plugin like | ||
|
||
```ts | ||
plugins: [ | ||
plugin(function ({ addUtilities }) { | ||
addUtilities({ | ||
'.appear': { | ||
opacity: 1, | ||
}, | ||
'.disappear': { | ||
opacity: 0, | ||
}, | ||
}); | ||
}), | ||
]; | ||
``` | ||
|
||
## Modal refactor | ||
|
||
### Modal.Panel | ||
|
||
The Panel now uses tailwindcss-animate and comes built-in with 5 `position` variant props | ||
|
||
```tsx | ||
export const panelVariants = cva( | ||
[ | ||
'fixed w-full bg-background p-6 text-foreground transition-all backdrop:brightness-50 backdrop:backdrop-blur-sm', | ||
'data-[closing]:duration-300 data-[open]:duration-300 data-[open]:animate-in data-[closing]:animate-out', | ||
'backdrop:data-[closing]:duration-300 backdrop:data-[open]:duration-300 backdrop:data-[open]:animate-in backdrop:data-[closing]:animate-out backdrop:data-[closing]:fade-out backdrop:data-[open]:fade-in', | ||
], | ||
{ | ||
variants: { | ||
position: { | ||
center: | ||
'max-w-lg rounded-base shadow-lg data-[state=closed]:fade-out data-[state=open]:fade-in data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[state=open]:slide-in-from-bottom-2 backdrop:data-[closing]:fade-out backdrop:data-[open]:fade-in', | ||
top: 'inset-x-0 top-0 mt-0 rounded-b-base border-b data-[closing]:slide-out-to-top data-[open]:slide-in-from-top', | ||
bottom: | ||
'inset-x-0 bottom-0 mb-0 rounded-t-base border-t data-[closing]:slide-out-to-bottom data-[open]:slide-in-from-bottom', | ||
left: 'inset-y-0 left-0 ml-0 h-full max-w-sm rounded-r-base border-r data-[closing]:slide-out-to-left data-[open]:slide-in-from-left', | ||
right: | ||
'inset-y-0 right-0 mr-0 h-full max-w-sm rounded-l-base border-l data-[closing]:slide-out-to-right data-[open]:slide-in-from-right', | ||
}, | ||
}, | ||
defaultVariants: { | ||
position: 'center', | ||
}, | ||
}, | ||
); | ||
|
||
type PanelProps = PropsOf<typeof HeadlessModal.Panel> & | ||
VariantProps<typeof panelVariants>; | ||
|
||
const Panel = component$<PanelProps>(({ position, ...props }) => { | ||
return ( | ||
<HeadlessModal.Panel {...props} class={cn(panelVariants({ position }), props.class)}> | ||
<Slot /> | ||
</HeadlessModal.Panel> | ||
); | ||
}); | ||
``` | ||
|
||
over previous tailwind.config.js home-made plugin | ||
|
||
```tsx | ||
'.appear': { | ||
opacity: 1, | ||
}, | ||
'.disappear': { | ||
opacity: 0, | ||
}, | ||
``` | ||
|
||
to avoid re-inventing the wheel. | ||
|
||
### Modal.Title | ||
|
||
Title now holds `text-lg font-semibold` classes. | ||
|
||
### Modal.Description | ||
|
||
Description now holds `text-muted-foreground` class. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@qwik-ui/styled': patch | ||
--- | ||
|
||
Styled button now uses `transition-all` for every variant shared class |
Oops, something went wrong.