diff --git a/login-workflow/CHANGELOG.md b/login-workflow/CHANGELOG.md index 33c3347c..78737cf7 100644 --- a/login-workflow/CHANGELOG.md +++ b/login-workflow/CHANGELOG.md @@ -5,11 +5,24 @@ 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/spec/v2.0.0.html). -## v4.0.4 (Unreleased) +## v5.0.0 (Unreleased) ### Added -- Error Manager for ChangePasswordDialog ([#612](https://github.com/etn-ccis/blui-react-workflows/issues/612)) +- Okta redirect-compatible login screen. +- Error Manager for ChangePasswordDialog ([#612](https://github.com/etn-ccis/blui-react-workflows/issues/612)). +- BLUI class names for ChangePasswordDialog ([#600](https://github.com/etn-ccis/blui-react-workflows/issues/600)). +- SX style overrides on full screens ([#599](https://github.com/etn-ccis/blui-react-workflows/issues/599)). + +### Fixed + +- Reload EULA should not be tied to checkbox status ([#549](https://github.com/etn-ccis/blui-react-workflows/issues/549)). +- Updated password validation callback function ([#560]https://github.com/etn-ccis/blui-react-workflows/issues/560). + +### Changed + +- Eliminate `WorkflowCardFinishState` and introduce `EmptyStateProps` in the success screen([#552](https://github.com/etn-ccis/blui-react-workflows/issues/552)). + ## v4.0.3 (May 9, 2024) diff --git a/login-workflow/docs/components/change-password-dialog.md b/login-workflow/docs/components/change-password-dialog.md index e48ac212..0217d7a7 100644 --- a/login-workflow/docs/components/change-password-dialog.md +++ b/login-workflow/docs/components/change-password-dialog.md @@ -35,6 +35,7 @@ import { AuthContextProvider, ChangePasswordDialog } from '@brightlayer-ui/react | showSuccessScreen | `boolean` | Used to determine whether to show a success screen after the form is submitted. | | | slots | `ChangePasswordDialogSlots` | Components to use in place of the defaults. See [ChangePasswordDialogSlots](#changepassworddialogslots) | | | slotProps | `ChangePasswordDialogSlotsProps` | Props to pass to the custom slot components. See [ChangePasswordDialogSlotsProps](#changepassworddialogslotsprops) | | +| errorDisplayConfig | `ErrorManagerProps` | See [Error Management](../error-management.md) | | ### ChangePasswordDialogSlots diff --git a/login-workflow/docs/migration-guide-4-5.md b/login-workflow/docs/migration-guide-4-5.md new file mode 100644 index 00000000..9906e310 --- /dev/null +++ b/login-workflow/docs/migration-guide-4-5.md @@ -0,0 +1,33 @@ +# Migration Guide: v4.x => v5.x + +## Change Password Dialog prop update + +We have removed `errorDialogProps` from change password dialog props and added `errorDisplayConfig` of error manager prop type. + +To trigger the ErrorManager to display an error, you need to throw an error in your AuthUIAction. + +```tsx +// throw a basic error +throw new Error('My Custom Error'); + +// customize the title via the cause property +throw new Error('My Custom Error', { + cause: { + title: 'Custom Title', + errorMessage: 'My custom error message', + }, +}); + + +``` + +Refer to the [Example](../example/) application for detailed reference. diff --git a/login-workflow/package.json b/login-workflow/package.json index a294bae0..728d3f7a 100644 --- a/login-workflow/package.json +++ b/login-workflow/package.json @@ -1,6 +1,6 @@ { "name": "@brightlayer-ui/react-auth-workflow", - "version": "4.0.3", + "version": "5.0.0-beta.0", "author": "Brightlayer UI (https://github.com/brightlayer-ui)", "license": "BSD-3-Clause", "description": "Re-usable workflow components for Authentication and Registration within Eaton applications.",