Releases: pklaschka/xd-dialog-helper
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
The first officially stable release, v1.0.0
Migration Guide from pre-v1.0.0 versions
Mostly, there should be no breaking changes (but many additional options and improvements) in v1.0, since it mostly consists of an internal restructuring.
However, with the release of the new version, the types have moved to a
types namespace inside the xd-dialog-helper module.
This means that instead of writing
dialogHelper.showDialog('dialog', 'My dialog', [{
id: 123,
type: dialogHelper.TEXT_INPUT,
label: 'Good morning'
}]);
we have to write:
dialogHelper.showDialog('dialog', 'My dialog', [{
id: 123,
type: dialogHelper.types.TEXT_INPUT,
label: 'Good morning'
}]);
Also, the type constant previously were aliases for numeric constants representing the type. This is no longer the case (to support custom types), which is why numeric values are no longer possible for the type field.
v1.0.0 Beta 0
The first Beta of v1.0.0 of the xd-dialog-helper
. You can obtain it by using npm install xd-dialog-helper@next
.
While I've now reached 100 % coverage with unit tests – see https://coveralls.io/github/pklaschka/xd-dialog-helper, please note that this is still a Beta version and it might not be wise to use it in production quite yet. I do, however, think that the final v1.0.0
could get released later this week or next week, meaning you can already use the Beta to migrate and release your plugin relatively soon.
Migration Guide from pre-v1.0.0 versions
Mostly, there should be no breaking changes (but many additional options and improvements) in v1.0, since it mostly consists of an internal restructuring.
However, with the release of the new version, the types have moved to a
types
namespace inside the xd-dialog-helper
module.
This means that instead of writing
dialogHelper.showDialog('dialog', 'My dialog', [{
id: 123,
type: dialogHelper.TEXT_INPUT,
label: 'Good morning'
}]);
we have to write:
dialogHelper.showDialog('dialog', 'My dialog', [{
id: 123,
type: dialogHelper.types.TEXT_INPUT,
label: 'Good morning'
}]);
Please note: The old way is still available (but marked as deprecated) in the alpha- and beta versions of v1.0. It will, however, get removed with the full release of the new version.
Also, the type constant previously were aliases for numeric constants representing the type. This is no longer the case (to support custom types), which is why numeric values are no longer possible for the type
field.
v0.9.5
Fixed issues and improvements:
- Fixed a few issues with the
onValidation()
callback function - Added dialog actions (
close()
andcancel()
) as parameters to theonBeforeShow()
callback function to support closing (i.e. accepting or canceling) the dialog with custom code
Breaking changes:
- Changes parameters passed into
onBeforeShow()
callback function
v0.9.4
v0.9.3
Fixed issues and improvements:
- #10 Corrected behavior of dialog when submitted via pressing enter on macOS
- #7 Made
contents
andoptions
optional parameters ofDialogHelper.showDialog(...)
- #1 Added input validation function (ok button gets disabled when a validation function gets specified and returns
false
) - #12 Added version number to dialog-helper.js to make reporting issues easier when using the standalone version
(possibly breaking) Changes:
n/a