You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository is currently being migrated. It's locked while the migration is in progress.
Copy file name to clipboardExpand all lines: src/_patterns/help-users-to/update-prefilled-information.md
+20-19Lines changed: 20 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,33 +46,35 @@ Refer to the related ["Help users to... Know when their information is prefilled
46
46
47
47
#### Prefilled information the user can't update
48
48
Here's how to communicate that users can't update certain information online:
49
-
***Omit the edit link in cards with uneditable information.**
50
-
***Include instructions for how to update uneditable information.** Under the card with the uneditable information, display a note starting with the bolded word “Note:” followed by directions to help users find out how to update this information by phone or another way. These directions will vary by form or type of information. You’ll need to confirm that the directions are accurate for updating that specific type of information. See the Content considerations section for more guidance.
49
+
***Omit the edit link in the [Card component]({{ site.baseurl }}/components/card) with uneditable information.**
50
+
***Include instructions for how to update uneditable information.** Under the [Card]({{ site.baseurl }}/components/card) with the uneditable information, display a note starting with the bolded word "Note:" followed by directions to help users find out how to update this information by phone or another way. These directions will vary by form or type of information. You'll need to confirm that the directions are accurate for updating that specific type of information. See the [Content considerations section](#content-considerations) on this page for more guidance.
51
51
52
52
#### Prefilled information the user can update
53
53
Here's how to communicate that users can update certain information online:
54
54
55
-
**Display editable prefilled information in a card with an edit link.** Display prefilled information in a card component with a link to edit the information. This information may include contact information, such as phone number, email address, or mailing address.
55
+
**Display editable prefilled information in a Card - status with an edit link.** Display prefilled information in a [Card - status]({{ site.baseurl }}/components/card/card-status) with a link to edit the information. This information may include contact information, such as phone number, email address, or mailing address.
56
56
57
57
{% include component-example.html class="x2" alt="Cards that show contact info with links to edit if needed." file="/images/patterns/help-users-to/update-prefilled-information/editable-prefill-contact-info.png" %}
58
58
59
59
When the user updates this information, there are two potential pathways.
60
60
61
61
##### If we automatically save changes to the user's profile
62
62
63
-
**In most cases, when users update information that can be edited in their profile**, we should save the changes should be saved to both the form or tool and the profile. An informationalalert will indicate where we'll save the changes.
63
+
**In most cases, when users update information that can be edited in their profile**, the changes should be saved to both the form or tool and the profile. An [Alert - informational]({{ site.baseurl }}/components/alert) will indicate where we'll save the changes.
64
64
65
65
For developer documentation on saving information changes to the profile, consult [How to create the contact info Array Data](https://depo-platform-documentation.scrollhelp.site/developer-docs/va-forms-library-how-to-create-the-contact-info-ar).
66
66
67
67
{% include component-example.html class="x2" alt="A page for users to update their mailing address. Above the fields is an informational alert stating, 'Any changes you make will also be reflected on your profile.'" file="/images/patterns/help-users-to/update-prefilled-information/edit-save-to-profile.png" %}
68
68
69
-
##### If we let the user choose whether to save changes to their profile
69
+
##### If we let the user choose whether to save changes to their mailing address
70
70
71
-
**In certain cases, users may need more control over where we save the changes.** Instead of displaying an informational alert at the top of the page, display a question with radio button response options asking the user where they want to save their changes. Learn more about these cases in the “communicate where changes will save” section below.
71
+
**For mailing addresses only, users may need more control over where we save the changes.** Instead of displaying an informational alert at the top of the page, display a question at the bottom of the page asking the user where they want to save their changes. Learn more about these cases in the [communicate where changes will save section](#communicate-when-and-where-well-save-updates-to-prefilled-information) on this page.
72
72
73
-
Consider using this variation for information that may change frequently. For example, when reordering medical supplies, users may want to provide a temporary mailing address. But they may not want to save this temporary mailing address to save to their profile.
73
+
**Note:** Phone number and email address updates always save to both the form and the user's profile. Only mailing address updates can be saved to the form only.
74
74
75
-
After the form fields the person is updating, include this question:
75
+
Consider using this variation for mailing addresses that may change frequently. For example, when reordering medical supplies, users may want to provide a temporary mailing address. But they may not want this temporary mailing address to save to their profile.
76
+
77
+
After the mailing address fields the person is updating, include this question:
76
78
77
79
>Do you want to update this information in your profile? (*Required)
78
80
>
@@ -86,30 +88,29 @@ The radio options should be:
86
88
87
89
##### If we let the user choose which piece of information they want to use for the form
88
90
89
-
In certain cases, users may need to choose which piece of information they want to use on the form. An example of this is if you prefill the user’s mobile and home telephone numbers, but the form only asks for a primary phone number. In these instances, after the user confirms their prefilled information, display a question with radio button response options asking the user which option they want to use on the form.
91
+
In certain cases, users may need to choose which piece of information they want to use on the form. An example of this is if you prefill the user’s mobile and home telephone numbers, but the form only asks for a primary phone number. In these instances, after the user confirms their prefilled information, display a question asking the user which information they want to use on the form.
90
92
91
93
{% include component-example.html class="x2" alt="A page for users to choose their primary phone number.'" file="/images/patterns/help-users-to/update-prefilled-information/primary-phone.png" %}
92
94
93
95
#### Prefilled information that is missing and required
94
96
95
-
There may be instances where some information that would usually be prefilled is missing from the database, but is also required by the form itself. In those instances, we show a statuscard that uses a colored tag to indicate that the information is missing. The card will also have the word "(\*Required)" next to the field heading text to indicate the user needs to provide that information. The link secondary action link for this card would say "Add [item]" rather than "Edit [item]".
97
+
There may be instances where some information that would usually be prefilled is missing from the database, but is also required by the form itself. In those instances, we show a [Card - status]({{ site.baseurl }}/components/card/card-status) that uses a Status tag to indicate that the information is missing. The card will also have the word "(\*Required)" next to the field heading text to indicate the user needs to provide that information. The secondary action link for this card would say "Add [item]" rather than "Edit [item]".
96
98
97
99
{% include component-example.html class="x2" alt="A page showing users they have missing and required information they will need to add." file="/images/patterns/help-users-to/update-prefilled-information/missing-prefilled-info.png" %}
98
100
99
-
If the user does not provide the required missing information and selects the "Continue" button to try and move forward, they'll get the same page with that statuscard in an error state and red error text telling them what information they need to provide. Once they select "Add" and provide the information on an edit page, they will be redirected back to this screen and can continue through the form.
101
+
If the user does not provide the required missing information and selects the "Continue" button to try and move forward, they'll get the same page with that [Card - status]({{ site.baseurl }}/components/card/card-status) in an error state and red error text telling them what information they need to provide. Once they select "Add" and provide the information on an edit page, they will be redirected back to this screen and can continue through the form.
100
102
101
103
{% include component-example.html class="x2" alt="A page with a status card in an error state for missing required information the user must add." file="/images/patterns/help-users-to/update-prefilled-information/card-with-missing-info-error-state.png" %}
102
104
103
105
#### Communicate when and where we'll save updates to prefilled information
104
106
105
-
**Inform users where we saved the changes.** Display a successalert informing the user “We’ve saved these changes to this form and your profile.” or “We’ve saved these changes to this form only.” Place this alert at the top of the page, below the stepper. Use a standard alert if the user made the changes on a form step page. Use a slimalert if the user made the changes on the final review page.
107
+
**Inform users where we saved the changes.** Display an [Alert - success]({{ site.baseurl }}/components/alert) informing the user "We've saved these changes to this form and your profile." or "We've saved these changes to this form only." Place this alert at the top of the page, below the stepper. Use an [Alert]({{ site.baseurl }}/components/alert) if the user made the changes on a form step page. Use an [Alert - success - slim]({{ site.baseurl }}/components/alert) if the user made the changes on the final review page.
@@ -123,23 +124,23 @@ Explain the steps the user needs to take to update this information. These instr
123
124
124
125
### Alert informing the user we'll save changes to their profile
125
126
126
-
Inform the user that their changes will save to their profile before they make the changes. If your form does not save changes to their profile, use a radio buttonquestion instead (example in the Radio button section).
127
+
Inform the user that their changes will save to their profile before they make the changes. If your form does not save changes to their profile, use a [Radio button]({{ site.baseurl }}/components/form/radio-button) to ask a question instead ([example in the Radio button section](#radio-button)).
127
128
128
129
{% include component-example.html class="x2" alt="An informational alert with a bolded header saying 'Any changes you make will also be reflected on your profile.'" file="/images/patterns/help-users-to/update-prefilled-information/alert-about-where-information-will-save.png" %}
129
130
130
131
### Success alert
131
132
132
-
Inform users that we saved their change to the form and their their profile. If we only saved the change to the form, the alert should read "We saved these changes to this form only."
133
+
Inform users that we saved their change to the form and their profile. If we only saved the change to the form, the alert should read "We saved these changes to this form only."
133
134
134
135
{% include component-example.html class="x2" alt="A success alert with the header 'We've updated your mailing address' and the body text 'We've made these changes to this form and your profile.'" file="/images/patterns/help-users-to/update-prefilled-information/success-alert.png" %}
135
136
136
-
If the user made the change on the final review page, display the slim success alert on the review page, immediately after the header of the section where they made the change.
137
+
If the user made the change on the final review page, display the [Alert - success - slim]({{ site.baseurl }}/components/alert) on the review page, immediately after the header of the section where they made the change.
137
138
138
139
{% include component-example.html class="x2" alt="A slim success alert with the text 'Address successfully updated on this form.'" file="/images/patterns/help-users-to/update-prefilled-information/slim-success-alert.png" %}
139
140
140
141
### Radio button
141
142
142
-
In cases where the information might change frequently (like a temporary mailing address), ask the user if they want to save their changes to their profile. Inform the user of the implications of this decision.
143
+
In cases where the mailing address might change frequently (like a temporary mailing address), ask the user if they want to save their changes to their profile. Inform the user of the implications of this decision.
143
144
144
145
{% include component-example.html class="x2" alt="A required radio button field asking the user if they also want to update this information in their profile." file="/images/patterns/help-users-to/update-prefilled-information/radio-button.png" %}
145
146
@@ -165,7 +166,7 @@ Here's an example that tells people to call the VA benefits hotline:
165
166
### Error messages
166
167
If the information can’t be saved onto profile, but can be used for the form
167
168
168
-
>Warning alert: We can’t update your information in your profile. But you can continuing filling out this [form/application] and update your profile information later.
169
+
>Warning alert: We can't update your information in your profile. But you can continue filling out this [form/application] and update your profile information later.
169
170
170
171
171
172
If the information can’t be saved for profile or for the form
0 commit comments