Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated package version and changelog #624

Merged
merged 8 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions login-workflow/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)).


KomalGDhere-eaton marked this conversation as resolved.
Show resolved Hide resolved
## v4.0.3 (May 9, 2024)

Expand Down
1 change: 1 addition & 0 deletions login-workflow/docs/components/change-password-dialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
33 changes: 33 additions & 0 deletions login-workflow/docs/migration-guide-4-5.md
Original file line number Diff line number Diff line change
@@ -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',
},
});

<ChangePasswordDialog
{...otherProps}
errorDisplayConfig={{
mode: 'message-box',
messageBoxConfig: {
dismissible: true,
position: 'top',
},
}}
>
```

Refer to the [Example](../example/) application for detailed reference.
2 changes: 1 addition & 1 deletion login-workflow/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@brightlayer-ui/react-auth-workflow",
"version": "4.0.3",
"version": "5.0.0-beta.0",
"author": "Brightlayer UI <[email protected]> (https://github.com/brightlayer-ui)",
"license": "BSD-3-Clause",
"description": "Re-usable workflow components for Authentication and Registration within Eaton applications.",
Expand Down
Loading