BREAKING: New stable version v25.0.0 (#837)

Co-authored-by: Frankie Yan <[email protected]> Co-authored-by: Henning Muszynski <[email protected]> Co-authored-by: Ricardo Amaral <[email protected]> Co-authored-by: Ernesto García <[email protected]> Co-authored-by: Seva Zaikov <[email protected]> Co-authored-by: Paweł Grimm <[email protected]> Co-authored-by: Pedro Alves <[email protected]> Co-authored-by: Natalie Mclaren <[email protected]>
Doist · Aug 13, 2024 · 6cb179a · 6cb179a
1 parent bdf867b
commit 6cb179a
Show file tree

Hide file tree

Showing 56 changed files with 2,559 additions and 2,967 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,74 @@
 
 Reactist follows [semantic versioning](https://semver.org/) and doesn't introduce breaking changes (API-wise) in minor or patch releases. However, the appearance of a component might change in a minor or patch release so keep an eye on redesigns and make sure your app still looks and feels like you expect it.
 
+# v25.0.0
+
+-   [BREAKING] Upgrade Ariakit from legacy package to the newer @ariakit/react
+-   [BREAKING] Remove unsupported `onPointerEnterCapture` and `onPointerLeaveCapture` props from `heading`-, `input`-, and `textarea`-based components.
+-   [BREAKING] Removed the `ButtonLink` component.
+-   [BREAKING] `Button` no longer accepts props that render it as an icon-only button.
+-   [BREAKING] Use an explicit `render` prop for composition, instead of the `as` prop (in the menu, modal, tabs, toasts and tooltip components).
+-   [BREAKING] `TabPanel`'s prop `render` is renamed to `renderMode`.
+-   [Feat] Introduce a new `IconButton` component.
+-   [Feat] The `Button` and `IconButton` component can be rendered as a link using the `render={<Link to="…" />} prop.
+
+# v25.0.0-beta.3
+
+-   [Fix] Allow more props to be forwarded to the `Tab` component.
+-   [Fix] Properly fix CSS build in tsdx config.
+-   [Chore] Upgrade to `@ariakit/[email protected]`.
+
+# v25.0.0-beta.2
+
+-   [Fix] Pass `onClick` to the `Tab` component.
+
+# v25.0.0-beta.1
+
+-   [BREAKING] Use an explicit `render` prop for composition, instead of the `as` prop (in the menu, modal, tabs, toasts and tooltip components).
+-   [BREAKING] `TabPanel`'s prop `render` is renamed to `renderMode`.
+
+# v25.0.0-beta
+
+-   [BREAKING] Removed the `ButtonLink` component.
+-   [BREAKING] `Button` no longer accepts props that render it as an icon-only button.
+-   [Feat] Introduce a new `IconButton` component.
+-   [Feat] The `Button` and `IconButton` component can be rendered as a link using the `render={<Link to="…" />} prop.
+
+# v24.2.0-beta
+
+-   [Fix] Include changes from [v23.3.0](#v2330) in the beta release
+
+# v24.1.5-beta
+
+-   [Fix] Include changes from [v23.2.2](#v2322) in the beta release
+
+# v24.1.4-beta
+
+-   [Fix] Include changes from [v23.2.1](#v2321) in the beta release
+
+# v24.1.3-beta
+
+-   [Fix] Remove unsupported `onPointerEnterCapture` and `onPointerLeaveCapture` props from `heading`-, `input`-, and `textarea`-based components.
+-   Normally, this would be considered a breaking change, but the v24 version is still pre-release and already contains breaking changes.
+
+# v24.1.2-beta
+
+-   [Fix] Reset anchor rect after context menu is closed.
+-   [Fix] Revert earlier attempt to auto-close menus when they lose focus.
+
+# v24.1.1-beta
+
+-   [Fix] It was possible to leave a tooltip in a state in which it remained visible all the time. This release fixes the issue.
+-   [Fix] Auto-close menus when they lose focus to elements other than their own content or their sub-menus.
+
+# v24.1.0-beta
+
+-   [Feat] Include changes from [v23.2.0](#v2320) in the beta release
+
+# v24.0.0-beta
+
+-   [BREAKING] Upgrade Ariakit from legacy package to the newer @ariakit/react
+
 # v23.3.0
 
 -   [Feat] Add `warning` as a `tone` option for `Badge`.

diff --git a/README.md b/README.md
@@ -88,36 +88,55 @@ This boots up a development server with hot reloading on http://localhost:6006.
 
 ## Inside your application
 
-For the second development mode you can leverage `npm link`. First run:
+For the second development mode you can leverage `npm start:yalc`. First, make sure you have `yalc` installed globally:
+
+```shell
+npm install -g yalc
+```
+
+Then, in the reactist repository run:
 
 ```sh
-npm run start
+npm run start:yalc
 ```
 
-this will update the build artifacts whenever you change something.
+this will publish Reactist to `yalc` and watch for changes.
 
-In your real application you need to first delete the current _@doist/reactist_ dependency and then link to your local one.
+In your host application you can then link to your local Reactist version:
 
 ```sh
 cd ~/your-app
-# delete current reactist dependency
-rm -rf ./node_modules/@doist/reactist
-
-# link local reactist version
-npm link ../reactist
+yalc add @doist/reactist
 ```
 
-The relative path to reactist may need to be changed to match your local environment.
-
-To undo the changes and switch back to the reactist version from npm do the following:
+To undo the changes and switch back to the reactist version from npm, do the following:
 
 ```sh
 cd ~/your-app
-# first remove linked reactist dependency
-rm -rf ./node_modules/@doist/reactist
+# restore the original reactist version
+yalc remove @doist/reactist
+# re-install reactist from npm
+npm install
+```
+
+For convenience, you can add a `dev:reactist` script in your host application to automate the process of adding and removing the local Reactist version:
+
+```json5
+{
+    // ...
+    scripts: {
+        // ...
+        'predev:reactist': 'yalc add @doist/reactist',
+        'dev:reactist': 'npm run dev', // or whatever your development script is
+        'postdev:reactist': 'yalc remove @doist/reactist && npm i',
+    },
+}
+```
 
-# re-install reactist from npm (-E avoids updating the version / package-lock.json)
-npm install -E @doist/reactist
+Then, to develop against Reactist, just run:
+
+```sh
+npm run dev:reactist
 ```
 
 ## Development tips and tricks