-
Notifications
You must be signed in to change notification settings - Fork 2
IS-5161 Expand HaapiStepper UI components list in README #162
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
Draft
aleixsuau
wants to merge
1
commit into
integration/IS-5161/login-web-app
Choose a base branch
from
feature/IS-5161/expand-haapi-stepper-ui-components-list
base: integration/IS-5161/login-web-app
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -114,6 +114,19 @@ Because the `HaapiStepperStepUI` handles all possible HAAPI authentication flows | |
|
|
||
| Check out [the HaapiStepperStepUI documentation and usage examples](./feature/steps/HaapiStepperStepUI.tsx). | ||
|
|
||
| ### ViewName built-in UIs | ||
|
|
||
| Some HAAPI viewNames (`step.metadata.viewName`) need a UI that the generic step rendering can't deliver well. For example, the **BankID** screen needs to render a spinner while the polling status is `pending`, and lifts the QR code above the actions. | ||
|
|
||
| To handle this kind of view, the library ships **viewName built-in UIs** that automatically take over when the matching `step.metadata.viewName` arrives from the server. | ||
|
|
||
| #### The `enableViewNameBuiltInUIs` prop | ||
|
|
||
| `<HaapiStepperStepUI>` accepts a | ||
| `enableViewNameBuiltInUIs?: HaapiStepperViewNameBuiltInUI[] | boolean` prop that opts in to which viewName built-in UIs are active. It is **opt-in**: when the prop is omitted (or `false`), no viewName built-in UIs are applied and every step renders through the generic render pipeline. Pass `true` to enable all known built-ins, or an array of built-in view names (`HaapiStepperViewNameBuiltInUI[]`) to pin a specific subset. | ||
|
|
||
| Check out documentation and usage examples in [`HaapiStepperStepUI`](./feature/steps/HaapiStepperStepUI.tsx), and the test use cases in [`HaapiStepperStepUI.spec.tsx`](./feature/steps/HaapiStepperStepUI.spec.tsx) (`describe('ViewName built-in UIs Rendering')`) for more details. | ||
|
|
||
|
|
||
|
|
||
| ## HAAPI Stepper UI Components | ||
|
|
@@ -128,12 +141,20 @@ The HAAPI Stepper UI components are the UI representation of the main HAAPI enti | |
|
|
||
| Check out documentation and usage examples in the links below: | ||
|
|
||
| * [HaapiStepperFormUI](./feature/actions/form/HaapiStepperFormUI.tsx) | ||
| * [HaapiStepperSelectorUI](./feature/actions/selector/HaapiStepperSelectorUI.tsx) | ||
| * [HaapiStepperClientOperationUI](./feature/actions/client-operation/HaapiStepperClientOperationUI.tsx) | ||
| * [HaapiStepperMessagesUI](./ui/messages/HaapiStepperMessagesUI.tsx) | ||
| * [HaapiStepperLinksUI](./ui/links/HaapiStepperLinksUI.tsx) | ||
| * [HaapiStepperLinkUI](./ui/links/HaapiStepperLinkUI.tsx) | ||
| * [HaapiStepperStepUI](./feature/steps/HaapiStepperStepUI.tsx) | ||
| * [HaapiStepperActionsUI](./ui/actions/HaapiStepperActionsUI.tsx) | ||
| * [HaapiStepperFormUI](./feature/actions/form/HaapiStepperFormUI.tsx) | ||
| * [HaapiStepperFormFieldUI](./feature/actions/form/fields/HaapiStepperFormFieldUI.tsx) | ||
| * [HaapiStepperTextFormFieldUI](./feature/actions/form/fields/HaapiStepperTextFormFieldUI.tsx) | ||
| * [HaapiStepperPasswordFormFieldUI](./feature/actions/form/fields/HaapiStepperPasswordFormFieldUI.tsx) | ||
| * [HaapiStepperCheckboxFormFieldUI](./feature/actions/form/fields/HaapiStepperCheckboxFormFieldUI.tsx) | ||
| * [HaapiStepperSelectFormFieldUI](./feature/actions/form/fields/HaapiStepperSelectFormFieldUI.tsx) | ||
| * [HaapiStepperSelectorUI](./feature/actions/selector/HaapiStepperSelectorUI.tsx) | ||
| * [HaapiStepperClientOperationUI](./feature/actions/client-operation/HaapiStepperClientOperationUI.tsx) | ||
| * [HaapiStepperMessagesUI](./ui/messages/HaapiStepperMessagesUI.tsx) | ||
| * [HaapiStepperMessageUI](./ui/messages/HaapiStepperMessageUI.tsx) | ||
| * [HaapiStepperLinksUI](./ui/links/HaapiStepperLinksUI.tsx) | ||
| * [HaapiStepperLinkUI](./ui/links/HaapiStepperLinkUI.tsx) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
|
|
||
| ### CSS Customization | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems unrelated to this PR and duplicated from #150.