mirror of
https://github.com/bitwarden/browser
synced 2025-12-20 18:23:31 +00:00
feat: improve async actions docs and guards (#4215)
* docs: clarify submit handler in standalone example * docs: clarify protection against re-running actions * docs: clarify that these directives replace click and ngSubmit * docs: clarify `void` * feat: disable action directive on bitsubmit disable * docs: fix grammar * docs: change to note * feat: guard against double running bitAction
This commit is contained in:
@@ -16,14 +16,16 @@ Adding async actions to submit buttons requires the following 3 steps
|
||||
### 1. Add a handler to your `Component`
|
||||
|
||||
A handler is a function that returns a promise or an observable. Functions that return `void` are also supported which is
|
||||
useful for aborting an action.
|
||||
useful because `return;` can be used to abort an action.
|
||||
|
||||
**NOTE:**
|
||||
**NOTE:** Defining the handlers as arrow-functions assigned to variables is mandatory if the handler needs access to the parent
|
||||
component using the variable `this`.
|
||||
|
||||
- Defining the handlers as arrow-functions assigned to variables is mandatory if the handler needs access to the parent
|
||||
component using the variable `this`.
|
||||
- `formGroup.invalid` will always return `true` after the first `await` operation, event if the form is not actually
|
||||
invalid. This is due to the form getting disabled by the `bitSubmit` directive while waiting for the async action to complete.
|
||||
**NOTE:** `formGroup.invalid` will always return `true` after the first `await` operation, event if the form is not actually
|
||||
invalid. This is due to the form getting disabled by the `bitSubmit` directive while waiting for the async action to complete.
|
||||
|
||||
**NOTE:** Handlers do not need to check if any previous requests have finished because the directives have built in protection against
|
||||
users attempting to trigger new actions before the previous ones have finished.
|
||||
|
||||
```ts
|
||||
@Component({...})
|
||||
@@ -52,6 +54,8 @@ Add the `bitSubmit` directive and supply the handler defined in step 1.
|
||||
**NOTE:** The `directive` is defined using the input syntax: `[input]="handler"`.
|
||||
This is different from how submit handlers are usually defined with the output syntax `(ngSubmit)="handler()"`.
|
||||
|
||||
**NOTE:** `[bitSubmit]` is used instead of `(ngSubmit)`. Using both is not supported.
|
||||
|
||||
```html
|
||||
<form [formGroup]="formGroup" [bitSubmit]="submit">...</form>
|
||||
```
|
||||
@@ -60,6 +64,8 @@ This is different from how submit handlers are usually defined with the output s
|
||||
|
||||
Add both `bitButton` and `bitFormButton` directives to the button.
|
||||
|
||||
**NOTE:** A summary of what each directive does can be found inside the source code.
|
||||
|
||||
```html
|
||||
<button type="submit" bitButton bitFormButton>{{ "submit" | i18n }}</button>
|
||||
```
|
||||
@@ -76,21 +82,22 @@ useful for aborting an action.
|
||||
**NOTE:** Defining the handlers as arrow-functions assigned to variables is mandatory if the handler needs access to the parent
|
||||
component using the variable `this`.
|
||||
|
||||
**NOTE:** Handlers do not need to check if any previous requests have finished because the directives have built in protection against
|
||||
users attempting to trigger new actions before the previous ones have finished.
|
||||
|
||||
```ts
|
||||
@Component({...})
|
||||
class Component {
|
||||
formGroup = this.formBuilder.group({...});
|
||||
|
||||
submit = async () => {
|
||||
// not relevant for this example
|
||||
// contents of this handler are not relevant for this example
|
||||
// as this handler will not be trigger by standalone buttons using
|
||||
// `bitAction`
|
||||
}
|
||||
|
||||
// action can also return Observable instead of Promise
|
||||
handler = async () => {
|
||||
if (/* perform guard check */) {
|
||||
return;
|
||||
}
|
||||
|
||||
await this.apiService.post(/* ... */);
|
||||
};
|
||||
}
|
||||
@@ -98,7 +105,7 @@ class Component {
|
||||
|
||||
### 2. Add directive to the `form` element
|
||||
|
||||
The `bitSubmit` directive is required beacuse of its coordinating role.
|
||||
The `bitSubmit` directive is required beacuse of its coordinating role inside of a form.
|
||||
|
||||
```html
|
||||
<form [formGroup]="formGroup" [bitSubmit]="submit">...</form>
|
||||
@@ -108,6 +115,8 @@ The `bitSubmit` directive is required beacuse of its coordinating role.
|
||||
|
||||
Add `bitButton`, `bitFormButton`, `bitAction` directives to the button. Make sure to supply a handler.
|
||||
|
||||
**NOTE:** A summary of what each directive does can be found inside the source code.
|
||||
|
||||
```html
|
||||
<button type="button" bitFormButton bitButton [bitAction]="handler">Do action</button>
|
||||
<button type="button" bitFormButton bitIconButton="bwi-star" [bitAction]="handler"></button>
|
||||
|
||||
Reference in New Issue
Block a user