Skip to content

Commit 337587d

Browse files
authored
chore: update objects list template to use filter pattern (#4059)
* chore: update objects list template to use filter pattern * chore: make popovers open * chore: docs * chore: add plus icon * chore: disable a11y
1 parent 39a6b33 commit 337587d

File tree

5 files changed

+155
-118
lines changed

5 files changed

+155
-118
lines changed

packages/paste-website/src/pages/page-templates/object-details/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
export const meta = {
22
title: 'Object details',
33
description:
4-
'The Object details page template allows customers to view and take action on properties of a single object.',
4+
'The object details page template allows customers to view and take action on properties of a single object.',
55
slug: '/page-templates/object-details/',
66
};
77

@@ -46,17 +46,17 @@ export const getStaticProps = async () => {
4646
code={FullObjectDetailsExample}
4747
/>
4848

49-
## About Object details
49+
## About object details
5050

5151
Object details give customers a primarily read-only view of the properties of an object, such as a message log or sent email.
5252

53-
If the customer is primarily editing information, use the [Settings](/page-templates/settings) page instead.
53+
If the customer is primarily editing information, use the [settings](/page-templates/settings) page template instead.
5454

5555
## Accessibility
5656

5757
A well-structured [document hierarchy](https://www.w3.org/WAI/tutorials/page-structure/) helps provide efficient in-page navigation for keyboard users, assistive technologies, and mobile web users.
5858

59-
Proper hierarchy allows users to skip directly to content that is most relevant to them. This is especially important on an Object details page where there may be many different types of information and customers are more likely to skim through.
59+
Proper hierarchy allows users to skip directly to content that is most relevant to them. This is especially important on an object details page where there may be many different types of information and customers are more likely to skim through.
6060

6161
To structure a page:
6262

packages/paste-website/src/pages/page-templates/objects-list/index.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
export const meta = {
22
title: 'Objects list',
33
description:
4-
'The Objects list page template shows a list of unique items for when a customer needs to perform an action on the items.',
4+
'The objects list page template shows a list of unique items for when a customer needs to perform an action on the items.',
55
slug: '/page-templates/objects-list/',
66
};
77

@@ -45,18 +45,18 @@ export const getStaticProps = async () => {
4545
code={FullObjectsListExample}
4646
/>
4747

48-
## About Objects list
48+
## About objects list
4949

50-
An Objects list shows a list of unique items or records (objects), such as logs or contacts. The page can include [search and filtering](/patterns/filter-group) to help customers find an item they’re looking for, and bulk actions like [export](/patterns/data-export) or [delete](/patterns/delete).
50+
An objects list shows a list of unique items or records (objects), such as logs or contacts. The page can include [search and filtering](/patterns/filter) to help customers find an item they’re looking for, and bulk actions like [export](/patterns/data-export) or [delete](/patterns/delete).
5151

52-
Use an Objects list when a customer needs to:
52+
Use an objects list when a customer needs to:
5353

5454
- View objects of a single type
5555
- Find specific objects quickly so they can view more [object details](/page-templates/object-details), edit, or delete them
5656
- Create a new object of this type
5757
- Perform bulk actions on multiple objects
5858

59-
If the customer is primarily editing information, use the [Settings](/page-templates/settings) page instead.
59+
If the customer is primarily editing information, use the [settings](/page-templates/settings) page instead.
6060

6161
## Ingredients
6262

@@ -78,9 +78,9 @@ The full header should be responsive to the width of the browser window. Heading
7878

7979
### Body
8080

81-
The rest of the page follows the [Filter Group pattern](/patterns/filter-group) and uses a [Data Grid](/components/data-grid). If there’s already a primary action in the page header, make the filter button a secondary button. If there are no interactive cells, use a Table instead of a Data Grid.
81+
The rest of the page follows the [filter pattern](/patterns/filter) and uses a [Data Grid](/components/data-grid). If there are no interactive cells, use a Table instead of a Data Grid.
8282

83-
If the customer needs to examine each object in more detail, link each object to its [Object details](/page-templates/object-details) page.
83+
If the customer needs to examine each object in more detail, link each object to its [object details](/page-templates/object-details) page.
8484

8585
The body should be responsive to the width of the browser window.
8686

packages/paste-website/src/pages/page-templates/settings/index.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
export const meta = {
22
title: 'Settings',
3-
description: 'The Settings page template lets customers edit information and update simple settings.',
3+
description: 'The settings page template lets customers edit information and update simple settings.',
44
slug: '/page-templates/settings/',
55
};
66

@@ -52,7 +52,7 @@ Settings pages let customers edit information and update simple settings.
5252

5353
If a customer is creating an object or the editing process is complex and requires additional guidance or focus, use the [create](/patterns/create) pattern and [wizard](/page-templates/wizard) template instead.
5454

55-
A Settings page can be a standalone page, or you can use a Settings overview page that links to multiple Settings pages.
55+
A settings page can be a standalone page, or you can use a settings overview page that links to multiple settings pages.
5656

5757
## Ingredients
5858

@@ -62,21 +62,21 @@ A Settings page can be a standalone page, or you can use a Settings overview pag
6262

6363
### Page header
6464

65-
At the top of the page, add a page heading using the format “[Settings type] settings.” For example, “Workplace settings” or “Source settings.” Optionally, use text under the heading to explain the primary settings on the page.
65+
At the top of the page, add a page heading using the format “[settings type] settings.” For example, “Workplace settings” or “Source settings.” Optionally, use text under the heading to explain the primary settings on the page.
6666

6767
Heading and Paragraph should have a max width of `$size-70`.
6868

6969
### Body
7070

71-
Like [Object details](/page-templates/object-details), Settings should also allow a customer to easily scan for the information they’re looking to edit. Group related settings under Headings. Use sentence case for all Headings (“Billing details” not “Billing Details”).
71+
Like [object details](/page-templates/object-details), settings should also allow a customer to easily scan for the information they’re looking to edit. Group related settings under Headings. Use sentence case for all Headings (“Billing details” not “Billing Details”).
7272

7373
If a group of settings needs additional explanation, use a Paragraph under a single Heading. If a single setting needs additional explanation, use Help Text with its form field.
7474

75-
Use customer research to inform how to order sections on the Settings page.
75+
Use customer research to inform how to order sections on the settings page.
7676

7777
### Settings overview page
7878

79-
If there are too many settings to fit on a single page, split related settings into separate pages or Modals, and link to them from a Settings overview page. On a Settings overview page, use [Cards](/components/card) to group sections and surface the most relevant information with [Description Lists](components/description-list).
79+
If there are too many settings to fit on a single page, split related settings into separate pages or Modals, and link to them from a Settings overview page. On a settings overview page, use [Cards](/components/card) to group sections and surface the most relevant information with [Description Lists](components/description-list).
8080

8181
Position the page content in the center with a max width of `$size-90`.
8282

packages/paste-website/src/pages/page-templates/wizard/index.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
export const meta = {
22
title: 'Wizard',
3-
description: 'A Wizard focuses customers through a series of tasks to reach a goal.',
3+
description: 'A wizard focuses customers through a series of tasks to reach a goal.',
44
slug: '/page-templates/wizard/',
55
};
66

@@ -47,9 +47,9 @@ export const getStaticProps = async () => {
4747
code={DefaultWizardExample}
4848
/>
4949

50-
## About Wizard
50+
## About wizard
5151

52-
Use a Wizard when a customer’s goal is long or complex, and breaking it up into smaller page-by-page tasks allows the user to focus and not feel overwhelmed. A Wizard can be useful when the tasks to reach a goal are dependent on each other, and customers need to finish different tasks based on previous ones.
52+
Use a wizard when a customer’s goal is long or complex, and breaking it up into smaller page-by-page tasks allows the user to focus and not feel overwhelmed. A wizard can be useful when the tasks to reach a goal are dependent on each other, and customers need to finish different tasks based on previous ones.
5353

5454
Start by splitting the goal across multiple tasks with each page containing just one main task, for example:
5555
- One piece of information the customer needs to know
@@ -84,16 +84,16 @@ Before deciding on a page layout, make a few content and experience decisions fi
8484
- **Task content:** Decide what content and components will help a customer finish each task.
8585
- **Goal linearity and duration:** Decide whether a customer can achieve the entire goal in one session. Decide whether they need to leave Twilio to finish a task and whether they need to wait for Twilio to do something before finishing the flow.
8686

87-
There are 3 standard max-widths for the content of each Wizard page. Based on the content you need for each task, start with the smallest max-width and size up as needed:
87+
There are 3 standard max-widths for the content of each wizard page. Based on the content you need for each task, start with the smallest max-width and size up as needed:
8888
1. `size-70` (712px). If this is too small, use:
8989
2. `size-100` (1024px). If this is too small, use:
9090
3. Full-width, with a max-width of `size-70` for the Page Header.
9191

92-
Use the same max-width for each page of the Wizard if possible.
92+
Use the same max-width for each page of the wizard if possible.
9393

9494
### Default template
9595

96-
In most scenarios, you’ll take customers through a Wizard without having to change the Sidebar or Topbar.
96+
In most scenarios, you’ll take customers through a wizard without having to change the Sidebar or Topbar.
9797

9898
<StoryPreview
9999
title="Wizard page template - default with content"
@@ -103,7 +103,7 @@ In most scenarios, you’ll take customers through a Wizard without having to ch
103103

104104
#### Page header
105105

106-
At the top of each page of the Wizard, add:
106+
At the top of each page of the wizard, add:
107107
- Wizard title as [Detail Text](/components/detail-text) (optional)
108108
- Task [Heading](/components/heading)
109109
- [Paragraph](/components/paragraph) text under the heading to explain the step (optional)
@@ -122,14 +122,14 @@ There may be cases where you need to show multiple tasks on the same page becaus
122122

123123
<Callout variant='neutral' marginY="space70">
124124
<CalloutHeading as="h2">Looking for guidelines on progressive disclosures?</CalloutHeading>
125-
<CalloutText>We don’t have guidelines yet for this part of Wizard. If you need it for your work, please consider partnering with us to contribute it.</CalloutText>
125+
<CalloutText>We don’t have guidelines yet for this part of wizard. If you need it for your work, please consider partnering with us to contribute it.</CalloutText>
126126
</Callout>
127127

128128
#### Actions footer
129129

130130
Use these actions in the footer, starting from the right side of the page:
131131
- A primary, right-aligned next [Button](/components/button) to let a customer move to the next task. The Button is right-aligned to signal that the flow is moving forward. If there are more tasks, use the word “Next” followed by [ArrowForwardIcon](/components/icon). If the customer is on the last task, the Button should indicate they are finishing the goal, and not include the arrow icon.
132-
- A secondary, right-aligned Button with the word “Cancel” if customers can’t save their progress, or “Close” if they can. Follow the [confirmation pattern](/patterns/confirmation) for guidance on how to ask a customer to confirm that they want to leave a Wizard or save their progress.
132+
- A secondary, right-aligned Button with the word “Cancel” if customers can’t save their progress, or “Close” if they can. Follow the [confirmation pattern](/patterns/confirmation) for guidance on how to ask a customer to confirm that they want to leave a wizard or save their progress.
133133
- A secondary, left-aligned back Button. If there were previous tasks, use the [ArrowBackIcon](/components/icon) followed by the word “Back”. If there are no previous tasks, don’t show the Button.
134134

135135
If the task contents don’t fill the width of the page body, use a [Separator](/components/separator) above the actions with a gap of `space-50`. However this should be used sparingly because in most cases your content should fill the width of the page body.
@@ -151,11 +151,11 @@ Don’t disable any footer Buttons unless it’s immediately obvious to customer
151151
code={WizardFullPageExample}
152152
/>
153153

154-
Use the full-page Wizard template when it’s absolutely critical that a customer remains focused to finish the task.
154+
Use the full-page wizard template when it’s absolutely critical that a customer remains focused to finish the task.
155155

156-
If your app allows it, load the Wizard without a Sidebar, and replace the content in the Topbar with:
156+
If your app allows it, load the wizard without a Sidebar, and replace the content in the Topbar with:
157157

158-
- The Wizard title as a left-aligned [Heading](/components/heading)
158+
- The wizard title as a left-aligned [Heading](/components/heading)
159159
- A secondary, right-aligned Button with the word “Cancel” if customers can’t save their progress, or “Close” if they can. Follow the [confirmation pattern](/patterns/confirmation) for guidance on how to ask a customer to confirm that they want to leave a Wizard or save their progress.
160160

161161
If your app doesn’t allow loading a page without the navigation frame, [collapse the Sidebar](/components/sidebar#compact-push-sidebar) and follow the [default Wizard template](#default-template).
@@ -166,11 +166,11 @@ At the top of the page, add the Task [Heading](/components/heading) and if neede
166166

167167
#### Body
168168

169-
Follow the [default Wizard template](#default-template).
169+
Follow the [default wizard template](#default-template).
170170

171171
#### Actions footer
172172

173-
Follow the [default Wizard template](#default-template), but don’t include a close button in the footer.
173+
Follow the [default wizard template](#default-template), but don’t include a close button in the footer.
174174

175175
### When to use Progress Steps
176176

@@ -180,7 +180,7 @@ Only use [Progress Steps](/components/progress-steps) when necessary. Some scena
180180
- A goal takes a long time to finish.
181181
- A customer is trying a feature out or going through more of an exploratory flow. Progress Steps can help them understand if they want to complete the steps.
182182

183-
If the customer’s journey through a Wizard is relatively linear, continuous, and short, don’t use Progress Steps.
183+
If the customer’s journey through a wizard is relatively linear, continuous, and short, don’t use Progress Steps.
184184

185185
When in doubt, start by not using Progress Steps, and add it in once it’s clear the experience suffers without it.
186186

@@ -193,7 +193,7 @@ Match Progress Steps labels to task headings for each page. If you need to use P
193193

194194
#### With the default template
195195

196-
Place Progress Steps above the Wizard title.
196+
Place Progress Steps above the wizard title.
197197

198198
<StoryPreview
199199
title="Wizard page template - default header with progress steps"

0 commit comments

Comments
 (0)