Skip to content

Commit ae4a135

Browse files
committed
scaffold IA for locations pattern doc update
1 parent f4c6fdb commit ae4a135

File tree

7 files changed

+68
-20
lines changed

7 files changed

+68
-20
lines changed
Lines changed: 68 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,44 @@
11
---
2-
name: Locations
2+
name: Resource picking
33
keywords:
44
- breakpoint
55
- locations
66
- location picker
7-
- location list
7+
- segment picker
8+
- picker
9+
- segments
10+
- segementation
11+
- customer segments
12+
- searchable list
13+
- single select
14+
- multiselect
15+
- multi-select
16+
- multi select
817
---
918

10-
# Locations
19+
# Resource picking
1120

12-
The number of locations a merchant has can range dramatically, and the location experience should adapt to that number. Using progressive disclosure, we can introduce features as merchants need them.
21+
Resource picking experiences let merchants browse, find, and select items in a list to perform an action. The picking feature can help them navigate to a new page, filter an index table, or input one or more values in a form.
1322

1423
---
1524

1625
## Principles
1726

1827
- **Leverage shared foundations.** By starting with available components and patterns, we keep design and development simple. Shared foundations also help guarantee familiar experiences for our merchants.
19-
- **Use progressive disclosure.** This is at the core of designing location experiences. As merchants add locations, patterns should gradually offer more features. For example:
20-
- A small number of locations (1–10) doesn’t need text search, sorting, and filtering.
21-
- A larger number of locations (11 or more) requires patterns like text search, sorting, filtering, and pagination.
28+
- **Use progressive disclosure.** This is at the core of designing resource picking experiences. As merchants add resources, patterns should gradually offer more features. For example:
29+
- Lists with a small number of resources (1–10) doesn’t need text search, sorting, and filtering.
30+
- Lists with a larger number of resources (11 or more) require patterns like text search, sorting, filtering, and pagination.
2231

2332
---
2433

2534
## Foundational patterns
2635

27-
When building a location experience, leverage components and patterns that offer:
36+
When building a resource picking experience, leverage components and patterns that offer:
2837

2938
- Easy access to known complex data (text search by location name, city, province, etc.)
3039
- Access to incomplete or unfamiliar data (filter contextual to the surface area)
3140
- The ability to organize and browse data (sort contextual to the surface area)
32-
- Pagination (load additional locations via infinite scrolling)
41+
- Pagination (load additional resources via infinite scrolling)
3342

3443
Sometimes existing solutions don’t fit your use case. They are a great place to start, but don’t be afraid to create a new solution for your merchant’s unique situation. If you do create something new, it’s important to document that solution and share it back to the system.
3544

@@ -41,19 +50,25 @@ Progressive disclosure means we introduce advanced features only when needed. Th
4150

4251
To scale the experience consistently, we want to establish specific points for introducing new functionality.
4352

44-
While there are many ways to treat locations, two common patterns that use progressive disclosure are the location picker and the location list.
53+
While there are many ways to treat a resource depending on the use case, two common resources that use progressive disclosure across their picking experiences are locations and customer segments.
54+
55+
## Case studies
4556

46-
### Location picker
57+
### Locations
58+
59+
The number of locations a merchant has can range dramatically, and the location experience should adapt to that number. Using progressive disclosure, we can introduce features as merchants need them.
4760

48-
The location picker allows a merchant to select any location they have added in the admin.
61+
#### Popover list
4962

50-
![1 location](/images/foundations/patterns/locations/[email protected])
63+
The location picker popover allows a merchant to select any location they have added in the admin.
64+
65+
![1 location](/images/foundations/patterns/resource-picking/[email protected])
5166

5267
#### 1 location
5368

5469
When a merchant only has one location, the button that opens the location picker should be hidden. There’s no need to access the experience when they can’t switch locations.
5570

56-
![2–10 locations](/images/foundations/patterns/locations/[email protected])
71+
![2–10 locations](/images/foundations/patterns/resource-picking/[email protected])
5772

5873
#### 2–10 locations
5974

@@ -65,7 +80,7 @@ In the location picker:
6580
- Show “All locations” at the top of the list.
6681
- List all other locations in alphabetical order. Each location item shows the location name only.
6782

68-
![11 or more locations](/images/foundations/patterns/locations/[email protected])
83+
![11 or more locations](/images/foundations/patterns/resource-picking/[email protected])
6984

7085
#### 11 or more locations
7186

@@ -76,22 +91,22 @@ When a merchant has 11 or more locations:
7691
- Directly below the search, show a section with the 5 most recently used locations. If there are none, show the first 5 locations from the full list.
7792
- Below recently used locations, show an option to view all locations. Clicking this will show the inactive search state, displaying the full list of locations.
7893

79-
### Location list
94+
#### Location list
8095

8196
The location list allows merchants to view all locations they have added in the admin.
8297

83-
![1–10 locations list](/images/foundations/patterns/locations/[email protected])
98+
![1–10 locations list](/images/foundations/patterns/resource-picking/[email protected])
8499

85-
#### 1–10 locations
100+
##### 1–10 locations
86101

87102
When a merchant has 1–10 locations, show all locations in a simple list. As notated in the image above:
88103

89104
1. Each list item should include the location name and address
90105
2. The indicator at the bottom shows the total number of locations
91106

92-
![11 or more locations list](/images/foundations/patterns/locations/[email protected])
107+
![11 or more locations list](/images/foundations/patterns/resource-picking/[email protected])
93108

94-
#### 11 or more locations
109+
##### 11 or more locations
95110

96111
When a merchant has 11 or more locations:
97112

@@ -104,3 +119,36 @@ Notated in the image above, location list functionality at this level includes:
104119
2. **Sort**. This will be contextual to the use case (alphabetical sort, date created, date edited, etc.).
105120
3. **Filter**. This is also contextual to the use case. For example, merchants could filter by subscription type.
106121
4. **Pagination**. Allow the merchant to load and view additional sets of locations. Trigger loading with a “Load more” button.
122+
123+
### Customer segments
124+
125+
The number of locations a merchant has can range dramatically, and the location experience should adapt to that number. Using progressive disclosure, we can introduce features as merchants need them.
126+
127+
#### Popover list
128+
129+
The location picker popover allows a merchant to select any location they have added in the admin.
130+
131+
![1 location](/images/foundations/patterns/resource-picking/[email protected])
132+
133+
#### 1 - 10 segments
134+
135+
When a merchant only has one location, the button that opens the location picker should be hidden. There’s no need to access the experience when they can’t switch locations.
136+
137+
![2–10 locations](/images/foundations/patterns/resource-picking/[email protected])
138+
139+
#### 11 or more segments
140+
141+
When a merchant has 11 or more locations:
142+
143+
- Apply the same features as 2–10 locations.
144+
- Add text search at the top of the location picker. This allows merchants to search for locations by specific criteria (location name, city, province, postal code, address, etc.).
145+
- Directly below the search, show a section with the 5 most recently used locations. If there are none, show the first 5 locations from the full list.
146+
- Below recently used locations, show an option to view all locations. Clicking this will show the inactive search state, displaying the full list of locations.
147+
148+
## Implementation
149+
150+
Something something searchable listbox.
151+
152+
Something something segment picking for example
153+
154+
Tabbed code examples

0 commit comments

Comments
 (0)