Skip to content

Commit 792d5aa

Browse files
committed
Update changelog
1 parent 6043966 commit 792d5aa

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

CHANGELOG.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,51 @@
22

33
All notable changes to `nova-settings-tool` will be documented in this file.
44

5+
## 1.0 – 2019-09-29
6+
7+
This is a major release. Upgrading will only take a few minutes and mostly just involves restructuring the config file, but this release is a major departure from previous versions of the package in a few ways, and therefore it **is not backwards compatible.**
8+
9+
#### Breaking changes
10+
11+
##### Completely restructure configuration file to reduce boilerplate and nesting
12+
13+
The top-level `panels` array containing panels, which in turn contained settings, has been replaced with a single `settings` array. The structure of each setting has remained mostly the same, and the panel that a setting belongs to is now specified directly in that setting. Panels are computed based on the unique values of all settings' `panel` keys.
14+
15+
Within individual settings:
16+
17+
- the `name` key has been renamed to `label`
18+
- `description` has been renamed to `help` and now accepts any valid HTML
19+
- `link` has been removed because `help` accepts HTML
20+
- all keys are now optional except `key`
21+
22+
The top-level `navigation` key in the config file has been renamed to `sidebar-label`.
23+
24+
##### Rename config file from `settings.php` to `nova-settings-tool.php`
25+
26+
The package's config file has been renamed to avoid possible conflicts. Fixes [#8](https://github.com/bakerkretzmar/nova-settings-tool/issues/8).
27+
28+
##### Change package namespace from `SettingsTool` to `NovaSettingsTool`
29+
30+
In your `NovaServiceProvider.php`, and anywhere else you're importing the tool, update your imports:
31+
32+
```diff
33+
- use Bakerkretzmar\SettingsTool\SettingsTool;
34+
+ use Bakerkretzmar\NovaSettingsTool\SettingsTool;
35+
```
36+
37+
##### Remove support for assigning default values to settings
38+
39+
This package doesn't affect the behaviour of your app, it just provide's a nice interface for managing settings in Nova—so setting something like `'default' => 'true'` on a toggle, as was previously possible, _wouldn't actually set a default value for the setting_, it would just change the way the setting was initially _displayed_, which could be misleading. Reverts [a4ad702](https://github.com/bakerkretzmar/nova-settings-tool/commit/a4ad702f29b9229e4d55f5150cb2deba47079932) and closes [#17](https://github.com/bakerkretzmar/nova-settings-tool/issues/17).
40+
41+
#### Other changes and improvements
42+
43+
- Add `number` and `select` setting types
44+
- Add support for settings file on a custom disk
45+
- Add ability to set a placeholder value on `text` and `textarea` settings
46+
- Simplify interface and consolidate save action
47+
- Adjust styles to more closely match Nova’s
48+
- Add bucketloads of tests
49+
550
## 0.3.3 – 2019-06-17
651

752
- Add support for setting Toggle to be on by default

0 commit comments

Comments
 (0)