Skip to content

Commit

Permalink
Update docs w/ more instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
nie7321 committed Mar 5, 2024
1 parent c6a295f commit e7151da
Show file tree
Hide file tree
Showing 3 changed files with 1,688 additions and 1,415 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/).

## Unreleased
## [v0.15.0 - 2024-03-05]
### Breaking Change
- The `ResourceInterface::submissions` method signature now includes an optional `$context` parameter. To migrate, ensure that all custom resources classes incorporate the new parameter.

### Added
- Support for non-scalar option values in the `Select` component.

## [v0.14.1 -2024-02-29]
## [v0.14.1 - 2024-02-29]
### Fixes
- Fixes the check to ensure Quill is the default Textarea editor.

Expand Down
11 changes: 11 additions & 0 deletions docs/upgrading.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Upgrading

## v0.15.0
This version changes the `ResourceInterface::submissions()` method signature. There is a new parameter, `$context`:

```php
public static function submissions(int $limit, int $skip, string $key, string $needle, ?array $context = []): array;
```

If you have implemented this interface, you should update your implementations.

The `ResourceController` stub has been updated to pass the request headers as context. You can [review the updated stub](https://github.com/NIT-Administrative-Systems/dynamic-forms/blob/develop/stubs/DynamicFormsResourceController.stub) and adopt it as-is if you have not changed it, or [check the diff](https://github.com/NIT-Administrative-Systems/dynamic-forms/commit/c6a295f13aea332a3a384f8a36faf21e1a459c43#diff-6fece68af8c7cc8d9a0016ee539fa9315ee6c9ef07e7827093f4cbd9d09deb01) and apply the changes manually.

## v0.8.0
This version adds support for the Hidden component. There should not be any BC breaks.

Expand Down
Loading

0 comments on commit e7151da

Please sign in to comment.