Skip to content

Commit

Permalink
Add upgrade guide
Browse files Browse the repository at this point in the history
  • Loading branch information
andyexeter committed Aug 22, 2024
1 parent 64a75f2 commit 3bfc5b7
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
16 changes: 15 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

All notable changes to this project will be documented in this file.

## v6.0.0

* Refactored all jQuery code to vanilla JavaScript/TypeScript. jQuery is no longer required.
* Collections are now initialized with a data attribute containing json config set within PHP code.
This means that the collection type can now be initialized without any JavaScript. See
the [collection docs](/docs/collections.md) for more info
* The JavaScript/Typescript code is now published as an [NPM module](https://www.npmjs.com/package/@palmtree/form) and
can be imported into your project.
See the [Vite, Webpack and other bundlers docs](/docs/vite-webpack-and-other-bundlers.md) for more info. You can also
use the [unpkg CDN](https://unpkg.com/@palmtree/[email protected]/dist/palmtree-form.pkgd.min.js) to get the full pacakge:

```html
<script src="https://unpkg.com/@palmtree/[email protected]/dist/palmtree-form.pkgd.min.js"></script>
```

## v5.0.1 - 2024-07-09

* Updated UMD in JS code for Vite support. In Vite production builds, `module.exports` is defined but `require` is not.
Expand Down Expand Up @@ -50,7 +65,6 @@ All notable changes to this project will be documented in this file.
Added functionality to render fields individually with a new `renderField` method. Among other things, this allows
developers to fully utilise Bootstrap's grid system by rendering fields in different columns.


## v4.2 - 2022-02-16

Added support for Bootstrap 5. This was achieved by:
Expand Down
2 changes: 2 additions & 0 deletions docs/vite-webpack-and-other-bundlers.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ import '@palmtree/form/recaptcha';
```

Each of the above imports has side effects, namely adding `DOMContentLoaded` event listeners to the document to initialize the relevant features.

[Return to index](index.md)

0 comments on commit 3bfc5b7

Please sign in to comment.