Skip to content

Commit 3171f4f

Browse files
RobinMalfaitRobinMalfait
authored
add changelog (#232)
* update docs * add CHANGELOG
1 parent e9c9292 commit 3171f4f

File tree

3 files changed

+151
-27
lines changed

3 files changed

+151
-27
lines changed

‎CHANGELOG.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased - React]
9+
10+
### Fixes
11+
12+
- Ensure that you can't use Enter to invoke the Switch
13+
- Fix outside click refocus bug ([#114](https://github.com/tailwindlabs/headlessui/pull/114))
14+
- Prevent scrolling when refocusing items
15+
- Ensure `Switch` has `type="button"` ([#192](https://github.com/tailwindlabs/headlessui/pull/192))
16+
- Fix `useId()` hook returning `undefined` on the client
17+
- Fix `disabled` not working when inside a disabled fieldset ([#202](https://github.com/tailwindlabs/headlessui/pull/202))
18+
- Trigger "outside click" behaviour on mousedown ([#212](https://github.com/tailwindlabs/headlessui/pull/212))
19+
- Ensure the `active` MenuItem is scrolled into view
20+
- Ensure valid Menu accessibility tree ([#228](https://github.com/tailwindlabs/headlessui/pull/228))
21+
22+
### Added
23+
24+
- Add Transition events (`beforeEnter`, `afterEnter`, `beforeLeave` and `afterLeave`) ([#57](https://github.com/tailwindlabs/headlessui/pull/57))
25+
- Add render features + render strategy (`static` and `unmount={true | false}`) ([#106](https://github.com/tailwindlabs/headlessui/pull/106))
26+
- Also changes the API of Transition component.
27+
- We will now always render a `div` by default (unless you change this using the `as={...}` prop).
28+
- The render function prop doesn't expose a `ref` anymore.
29+
- Adds `unmount` prop to the `Transition` and `Transition.Child` components.
30+
- Add displayName to all contexts ([#175](https://github.com/tailwindlabs/headlessui/pull/175))
31+
- Add `disabled` prop to `Listbox` itself, instead of the `Listbox.Button` ([#229](https://github.com/tailwindlabs/headlessui/pull/229))
32+
33+
## [Unreleased - Vue]
34+
35+
### Fixes
36+
37+
- Ensure that you can't use Enter to invoke the Switch
38+
- Fix outside click refocus bug ([#114](https://github.com/tailwindlabs/headlessui/pull/114))
39+
- Prevent scrolling when refocusing items
40+
- Ensure `Switch` has `type="button"` ([#192](https://github.com/tailwindlabs/headlessui/pull/192))
41+
- Added `emits` property to Vue components ([#199](https://github.com/tailwindlabs/headlessui/pull/199))
42+
- Fix `disabled` not working when inside a disabled fieldset ([#202](https://github.com/tailwindlabs/headlessui/pull/202))
43+
- Trigger "outside click" behaviour on mousedown ([#212](https://github.com/tailwindlabs/headlessui/pull/212))
44+
- Ensure the `active` MenuItem is scrolled into view
45+
- Ensure valid Menu accessibility tree ([#228](https://github.com/tailwindlabs/headlessui/pull/228))
46+
47+
### Added
48+
49+
- Add render features + render strategy (`static` and `unmount={true | false}`) ([#106](https://github.com/tailwindlabs/headlessui/pull/106))
50+
- Add `disabled` prop to `Listbox` itself, instead of the `ListboxButton` ([#229](https://github.com/tailwindlabs/headlessui/pull/229))
51+
52+
## [@headlessui/react@v0.2.0] - 2020-10-06
53+
54+
- Add `Listbox` component
55+
- Add `Switch` component
56+
57+
## [@headlessui/vue@v0.2.0] - 2020-10-06
58+
59+
- Add `Listbox` component
60+
- Add `Switch` component
61+
62+
## [@headlessui/react@v0.1.3] - 2020-09-29
63+
64+
- Fix outside click behaviour. If you had multiple menu's, when menu 1 is open, menu 2 is closed and you click on menu button 2 it will open both menu's. This is now fixed.
65+
- Ensure when using keyboard navigation we prevent the default behaviour.
66+
67+
## [@headlessui/vue@v0.1.3] - 2020-09-29
68+
69+
- Fix an issue where you couldn't click on menu items that were links.
70+
- Fix outside click behaviour. If you had multiple menu's, when menu 1 is open, menu 2 is closed and you click on menu button 2 it will open both menu's. This is now fixed.
71+
- Ensure when using keyboard navigation we prevent the default behaviour.
72+
73+
## [@headlessui/react@v0.1.2] - 2020-09-25
74+
75+
- Add tests for `onClick` handling that wasn't working properly in @headlessui/vue to ensure behavior stays the same in this library
76+
- Don't pass `disabled` prop through to children, only add `aria-disabled`
77+
78+
## [@headlessui/vue@v0.1.2] - 2020-09-25
79+
80+
- Fix issue where button `MenuItem` instances didn't properly fire click events
81+
- Don't pass `disabled` prop through to children, only add `aria-disabled`
82+
83+
## [@headlessui/react@v0.1.1] - 2020-09-24
84+
85+
- Initial release
86+
87+
## [@headlessui/vue@v0.1.1] - 2020-09-24
88+
89+
- Initial release
90+
91+
[unreleased - react]: https://github.com/tailwindlabs/headlessui/compare/@headlessui/[email protected]
92+
[unreleased - vue]: https://github.com/tailwindlabs/headlessui/compare/@headlessui/[email protected]
93+
[@headlessui/[email protected]]: https://github.com/tailwindlabs/headlessui/compare/@headlessui/[email protected]...@headlessui/[email protected]
94+
[@headlessui/[email protected]]: https://github.com/tailwindlabs/headlessui/compare/@headlessui/[email protected]...@headlessui/[email protected]
95+
[@headlessui/[email protected]]: https://github.com/tailwindlabs/headlessui/compare/@headlessui/[email protected]...@headlessui/[email protected]
96+
[@headlessui/[email protected]]: https://github.com/tailwindlabs/headlessui/compare/@headlessui/[email protected]...@headlessui/[email protected]
97+
[@headlessui/[email protected]]: https://github.com/tailwindlabs/headlessui/compare/@headlessui/[email protected]...@headlessui/[email protected]
98+
[@headlessui/[email protected]]: https://github.com/tailwindlabs/headlessui/compare/@headlessui/[email protected]...@headlessui/[email protected]
99+
[@headlessui/[email protected]]: https://github.com/tailwindlabs/headlessui/releases/tag/@headlessui/[email protected]
100+
[@headlessui/[email protected]]: https://github.com/tailwindlabs/headlessui/releases/tag/@headlessui/[email protected]

‎packages/@headlessui-react/README.md‎

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -328,17 +328,21 @@ function MyComponent({ isShowing }) {
328328

329329
##### Props
330330

331-
| Prop | Type | Description |
332-
| ----------- | ------------------------------------- | ------------------------------------------------------------------------------------- |
333-
| `as` | String Component _(Default: `'div'`)_ | The element or component to render in place of the `Transition.Child` itself. |
334-
| `appear` | Boolean _(Default: `false`)_ | Whether the transition should run on initial mount. |
335-
| `unmount` | Boolean _(Default: `true`)_ | Whether the element should be `unmounted` or `hidden` based on the show state. |
336-
| `enter` | String _(Default: '')_ | Classes to add to the transitioning element during the entire enter phase. |
337-
| `enterFrom` | String _(Default: '')_ | Classes to add to the transitioning element before the enter phase starts. |
338-
| `enterTo` | String _(Default: '')_ | Classes to add to the transitioning element immediately after the enter phase starts. |
339-
| `leave` | String _(Default: '')_ | Classes to add to the transitioning element during the entire leave phase. |
340-
| `leaveFrom` | String _(Default: '')_ | Classes to add to the transitioning element before the leave phase starts. |
341-
| `leaveTo` | String _(Default: '')_ | Classes to add to the transitioning element immediately after the leave phase starts. |
331+
| Prop | Type | Description |
332+
| ------------- | ------------------------------------- | ------------------------------------------------------------------------------------- |
333+
| `as` | String Component _(Default: `'div'`)_ | The element or component to render in place of the `Transition.Child` itself. |
334+
| `appear` | Boolean _(Default: `false`)_ | Whether the transition should run on initial mount. |
335+
| `unmount` | Boolean _(Default: `true`)_ | Whether the element should be `unmounted` or `hidden` based on the show state. |
336+
| `enter` | String _(Default: '')_ | Classes to add to the transitioning element during the entire enter phase. |
337+
| `enterFrom` | String _(Default: '')_ | Classes to add to the transitioning element before the enter phase starts. |
338+
| `enterTo` | String _(Default: '')_ | Classes to add to the transitioning element immediately after the enter phase starts. |
339+
| `leave` | String _(Default: '')_ | Classes to add to the transitioning element during the entire leave phase. |
340+
| `leaveFrom` | String _(Default: '')_ | Classes to add to the transitioning element before the leave phase starts. |
341+
| `leaveTo` | String _(Default: '')_ | Classes to add to the transitioning element immediately after the leave phase starts. |
342+
| `beforeEnter` | Function | Callback which is called before we start the enter transition. |
343+
| `afterEnter` | Function | Callback which is called after we finished the enter transition. |
344+
| `beforeLeave` | Function | Callback which is called before we start the leave transition. |
345+
| `afterLeave` | Function | Callback which is called after we finished the leave transition. |
342346

343347
##### Render prop arguments
344348

@@ -1150,14 +1154,16 @@ function MyListbox() {
11501154
| Prop | Type | Default | Description |
11511155
| ---------- | ------------------- | --------------------------------------- | -------------------------------------------------------- |
11521156
| `as` | String \| Component | `React.Fragment` _(no wrapper element_) | The element or component the `Listbox` should render as. |
1157+
| `disabled` | Boolean | `false` | Enable/Disable the `Listbox` component. |
11531158
| `value` | `T` | | The selected value. |
11541159
| `onChange` | `(value: T): void` | | The function to call when a new option is selected. |
11551160

11561161
##### Render prop object
11571162

1158-
| Prop | Type | Description |
1159-
| ------ | ------- | ----------------------------------- |
1160-
| `open` | Boolean | Whether or not the listbox is open. |
1163+
| Prop | Type | Description |
1164+
| ---------- | ------- | --------------------------------------- |
1165+
| `open` | Boolean | Whether or not the listbox is open. |
1166+
| `disabled` | Boolean | Whether or not the listbox is disabled. |
11611167

11621168
#### Listbox.Button
11631169

@@ -1180,9 +1186,10 @@ function MyListbox() {
11801186

11811187
##### Render prop object
11821188

1183-
| Prop | Type | Description |
1184-
| ------ | ------- | ----------------------------------- |
1185-
| `open` | Boolean | Whether or not the listbox is open. |
1189+
| Prop | Type | Description |
1190+
| ---------- | ------- | --------------------------------------- |
1191+
| `open` | Boolean | Whether or not the listbox is open. |
1192+
| `disabled` | Boolean | Whether or not the listbox is disabled. |
11861193

11871194
#### Listbox.Label
11881195

@@ -1196,6 +1203,13 @@ function MyListbox() {
11961203
| ---- | ------------------- | ------- | -------------------------------------------------------------- |
11971204
| `as` | String \| Component | `label` | The element or component the `Listbox.Label` should render as. |
11981205

1206+
##### Render prop object
1207+
1208+
| Prop | Type | Description |
1209+
| ---------- | ------- | --------------------------------------- |
1210+
| `open` | Boolean | Whether or not the listbox is open. |
1211+
| `disabled` | Boolean | Whether or not the listbox is disabled. |
1212+
11991213
#### Listbox.Options
12001214

12011215
```jsx

‎packages/@headlessui-vue/README.md‎

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -975,16 +975,18 @@ export default {
975975

976976
##### Props
977977

978-
| Prop | Type | Default | Description |
979-
| --------- | ------------------- | --------------------------------- | -------------------------------------------------------- |
980-
| `as` | String \| Component | `template` _(no wrapper element_) | The element or component the `Listbox` should render as. |
981-
| `v-model` | `T` | | The selected value. |
978+
| Prop | Type | Default | Description |
979+
| ---------- | ------------------- | --------------------------------- | -------------------------------------------------------- |
980+
| `as` | String \| Component | `template` _(no wrapper element_) | The element or component the `Listbox` should render as. |
981+
| `v-model` | `T` | | The selected value. |
982+
| `disabled` | Boolean | `false` | Enable/Disable the `Listbox` component. |
982983

983984
##### Slot props
984985

985-
| Prop | Type | Description |
986-
| ------ | ------- | ----------------------------------- |
987-
| `open` | Boolean | Whether or not the listbox is open. |
986+
| Prop | Type | Description |
987+
| ---------- | ------- | --------------------------------------- |
988+
| `open` | Boolean | Whether or not the listbox is open. |
989+
| `disabled` | Boolean | Whether or not the listbox is disabled. |
988990

989991
#### ListboxButton
990992

@@ -1003,9 +1005,10 @@ export default {
10031005

10041006
##### Slot props
10051007

1006-
| Prop | Type | Description |
1007-
| ------ | ------- | ----------------------------------- |
1008-
| `open` | Boolean | Whether or not the listbox is open. |
1008+
| Prop | Type | Description |
1009+
| ---------- | ------- | --------------------------------------- |
1010+
| `open` | Boolean | Whether or not the listbox is open. |
1011+
| `disabled` | Boolean | Whether or not the listbox is disabled. |
10091012

10101013
#### ListboxLabel
10111014

@@ -1019,6 +1022,13 @@ export default {
10191022
| ---- | ------------------- | ------- | ------------------------------------------------------------- |
10201023
| `as` | String \| Component | `label` | The element or component the `ListboxLabel` should render as. |
10211024

1025+
##### Slot props
1026+
1027+
| Prop | Type | Description |
1028+
| ---------- | ------- | --------------------------------------- |
1029+
| `open` | Boolean | Whether or not the listbox is open. |
1030+
| `disabled` | Boolean | Whether or not the listbox is disabled. |
1031+
10221032
#### ListboxOptions
10231033

10241034
```vue

0 commit comments

Comments
 (0)