@sebgroup/green-core 3.31.0 → 3.32.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/components/dropdown/dropdown.component.d.ts +1 -0
- package/components/dropdown/dropdown.component.js +23 -4
- package/components/form-summary/summary.component.d.ts +3 -0
- package/components/form-summary/summary.component.js +17 -16
- package/custom-elements.json +11806 -11785
- package/gds-element.js +1 -1
- package/generated/locales/da.d.ts +5 -0
- package/generated/locales/da.js +5 -0
- package/generated/locales/de.d.ts +5 -0
- package/generated/locales/de.js +5 -0
- package/generated/locales/fi.d.ts +5 -0
- package/generated/locales/fi.js +5 -0
- package/generated/locales/fr.d.ts +5 -0
- package/generated/locales/fr.js +5 -0
- package/generated/locales/it.d.ts +5 -0
- package/generated/locales/it.js +5 -0
- package/generated/locales/nl.d.ts +5 -0
- package/generated/locales/nl.js +5 -0
- package/generated/locales/no.d.ts +5 -0
- package/generated/locales/no.js +5 -0
- package/generated/locales/sv.d.ts +5 -0
- package/generated/locales/sv.js +5 -0
- package/generated/mcp/alert/guidelines.md +105 -0
- package/generated/mcp/alert/index.json +1 -0
- package/generated/mcp/avatar/guidelines.md +40 -0
- package/generated/mcp/avatar/index.json +1 -0
- package/generated/mcp/badge/guidelines.md +56 -0
- package/generated/mcp/badge/index.json +1 -0
- package/generated/mcp/blur/guidelines.md +3 -0
- package/generated/mcp/blur/index.json +1 -0
- package/generated/mcp/breadcrumbs/guidelines.md +35 -0
- package/generated/mcp/breadcrumbs/index.json +1 -0
- package/generated/mcp/button/guidelines.md +83 -0
- package/generated/mcp/button/index.json +1 -0
- package/generated/mcp/calendar/guidelines.md +3 -0
- package/generated/mcp/calendar/index.json +1 -0
- package/generated/mcp/card/guidelines.md +78 -0
- package/generated/mcp/card/index.json +1 -0
- package/generated/mcp/card-pattern-01/guidelines.md +52 -0
- package/generated/mcp/card-pattern-01/index.json +1 -0
- package/generated/mcp/checkbox/guidelines.md +91 -0
- package/generated/mcp/checkbox/index.json +1 -0
- package/generated/mcp/coachmark/guidelines.md +8 -0
- package/generated/mcp/coachmark/index.json +1 -0
- package/generated/mcp/components.json +47 -1
- package/generated/mcp/context-menu/guidelines.md +33 -0
- package/generated/mcp/context-menu/index.json +1 -0
- package/generated/mcp/datepicker/guidelines.md +44 -0
- package/generated/mcp/datepicker/index.json +1 -0
- package/generated/mcp/details/guidelines.md +24 -0
- package/generated/mcp/details/index.json +1 -0
- package/generated/mcp/dialog/guidelines.md +35 -0
- package/generated/mcp/dialog/index.json +1 -0
- package/generated/mcp/div/guidelines.md +3 -0
- package/generated/mcp/div/index.json +1 -0
- package/generated/mcp/divider/guidelines.md +24 -0
- package/generated/mcp/divider/index.json +1 -0
- package/generated/mcp/dropdown/guidelines.md +96 -0
- package/generated/mcp/dropdown/index.json +1 -0
- package/generated/mcp/fab/guidelines.md +27 -0
- package/generated/mcp/fab/index.json +1 -0
- package/generated/mcp/filter-chips/guidelines.md +47 -0
- package/generated/mcp/filter-chips/index.json +1 -0
- package/generated/mcp/flex/guidelines.md +1 -0
- package/generated/mcp/flex/index.json +1 -0
- package/generated/mcp/form-summary/angular.md +8 -0
- package/generated/mcp/form-summary/api.md +7 -0
- package/generated/mcp/form-summary/guidelines.md +39 -0
- package/generated/mcp/form-summary/index.json +1 -0
- package/generated/mcp/form-summary/react.md +8 -0
- package/generated/mcp/grid/guidelines.md +3 -0
- package/generated/mcp/grid/index.json +1 -0
- package/generated/mcp/icons.json +1 -1
- package/generated/mcp/index.json +1 -1
- package/generated/mcp/input/guidelines.md +127 -0
- package/generated/mcp/input/index.json +1 -0
- package/generated/mcp/link/guidelines.md +43 -0
- package/generated/mcp/link/index.json +1 -0
- package/generated/mcp/list/guidelines.md +16 -0
- package/generated/mcp/list/index.json +1 -0
- package/generated/mcp/list-item-pattern-01/guidelines.md +49 -0
- package/generated/mcp/list-item-pattern-01/index.json +1 -0
- package/generated/mcp/menu-button/guidelines.md +39 -0
- package/generated/mcp/menu-button/index.json +1 -0
- package/generated/mcp/pagination/guidelines.md +24 -0
- package/generated/mcp/pagination/index.json +1 -0
- package/generated/mcp/popover/guidelines.md +3 -0
- package/generated/mcp/popover/index.json +1 -0
- package/generated/mcp/progress/guidelines.md +42 -0
- package/generated/mcp/progress/index.json +1 -0
- package/generated/mcp/radio/guidelines.md +74 -0
- package/generated/mcp/radio/index.json +1 -0
- package/generated/mcp/rich-text/guidelines.md +3 -0
- package/generated/mcp/rich-text/index.json +1 -0
- package/generated/mcp/segmented-control/guidelines.md +31 -0
- package/generated/mcp/segmented-control/index.json +1 -0
- package/generated/mcp/select/guidelines.md +29 -0
- package/generated/mcp/select/index.json +1 -0
- package/generated/mcp/signal/guidelines.md +14 -0
- package/generated/mcp/signal/index.json +1 -0
- package/generated/mcp/slider/guidelines.md +86 -0
- package/generated/mcp/slider/index.json +1 -0
- package/generated/mcp/spinner/guidelines.md +6 -0
- package/generated/mcp/spinner/index.json +1 -0
- package/generated/mcp/switch/guidelines.md +41 -0
- package/generated/mcp/switch/index.json +1 -0
- package/generated/mcp/table/guidelines.md +169 -0
- package/generated/mcp/table/index.json +1 -0
- package/generated/mcp/tabs/guidelines.md +64 -0
- package/generated/mcp/tabs/index.json +1 -0
- package/generated/mcp/text/guidelines.md +3 -0
- package/generated/mcp/text/index.json +1 -0
- package/generated/mcp/textarea/guidelines.md +73 -0
- package/generated/mcp/textarea/index.json +1 -0
- package/generated/mcp/theme/guidelines.md +3 -0
- package/generated/mcp/theme/index.json +1 -0
- package/generated/mcp/tokens.json +1 -1
- package/generated/mcp/tooltip/guidelines.md +107 -0
- package/generated/mcp/tooltip/index.json +1 -0
- package/generated/mcp/video/guidelines.md +3 -0
- package/generated/mcp/video/index.json +1 -0
- package/generated/react/form-summary/index.d.ts +6 -1
- package/generated/react/index.d.ts +4 -4
- package/generated/react/index.js +4 -4
- package/package.json +1 -1
- package/utils/helpers/custom-element-scoping.js +1 -1
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# FAB
|
|
2
|
+
|
|
3
|
+
Floating action button persists across screens for constant access to features that needs to be accessible at all times.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
### Usage
|
|
9
|
+
|
|
10
|
+
The FAB is a high-visibility button used to promote a **key action** on a screen. It typically floats above the content, anchored to a corner (usually bottom-right or bottom-center on mobile).
|
|
11
|
+
|
|
12
|
+
Use the FAB when a single, standout action is needed such as "Add", "Create", or "Start". It should never compete with other primary actions and should be used **sparingly** to avoid visual clutter.
|
|
13
|
+
|
|
14
|
+
### Variants
|
|
15
|
+
|
|
16
|
+
The FAB can be adapted based on layout and context:
|
|
17
|
+
|
|
18
|
+
* **FAB** – A circular button with an icon (e.g. a plus sign for “Add”)
|
|
19
|
+
|
|
20
|
+
* **Extended FAB** – A wider button with both an icon and a label (e.g. “Add item”). Useful when more clarity is needed.
|
|
21
|
+
|
|
22
|
+
### Do’s and don’ts
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## UX Guidelines
|
|
26
|
+
|
|
27
|
+
### Writing UX text for FAB's
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Filter chips
|
|
2
|
+
|
|
3
|
+
Filter chips allow users to narrow down the data they want to see on the page.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
### States
|
|
9
|
+
|
|
10
|
+
The filter chip component comes in two states, "enabled" - can be selected and "selected" - can be unselected.
|
|
11
|
+
|
|
12
|
+
- **Enabled** – The default state, displaying only a label. Use this variant when presenting available filter options.
|
|
13
|
+
- **Selected** – When selected, the chips updates to show a checkmark icon alongside the label, indicating an active filter. The selected filter can be unselected.
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
If a user has accounts in three countries, only those three countries should be shown as filter chips. If they have accounts in just one country, there's no need to show a country filter at all.
|
|
20
|
+
|
|
21
|
+
To improve clarity and support informed decisions, display the number of results each selected filter will return. This gives users immediate feedback on how their choices are narrowing or broadening the data set.
|
|
22
|
+
|
|
23
|
+
### Sizes
|
|
24
|
+
|
|
25
|
+
The filter chips comes in two sizes:
|
|
26
|
+
|
|
27
|
+
- **Large** (default)
|
|
28
|
+
- **Small**
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Removable filter chips
|
|
33
|
+
|
|
34
|
+
If the purpose is to display an already applied filter that can be removed, use a **Button** with a trailing remove icon. This pattern clearly communicates that the filter is active and that the available action is to remove it, rather than change its selection state.
|
|
35
|
+
|
|
36
|
+
### Do's and don'ts
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
## UX Guidelines
|
|
40
|
+
|
|
41
|
+
### Writing UX text for filter chips
|
|
42
|
+
|
|
43
|
+
### Avoid the & sign
|
|
44
|
+
|
|
45
|
+
### Do not mix word classes
|
|
46
|
+
|
|
47
|
+
### Do's and don'ts
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# Flex
|
|
@@ -15,3 +15,11 @@ Use the component in your Angular templates:
|
|
|
15
15
|
<!-- content -->
|
|
16
16
|
</gds-form-summary>
|
|
17
17
|
```
|
|
18
|
+
|
|
19
|
+
## Event Handling
|
|
20
|
+
|
|
21
|
+
Events are emitted using Angular output syntax. Event names are converted from kebab-case to camelCase:
|
|
22
|
+
|
|
23
|
+
| Web Component Event | Angular Output | Handler Example |
|
|
24
|
+
|---------------------|----------------|-----------------|
|
|
25
|
+
| `gds-control-focus` | `gdsControlFocus` | `(gdsControlFocus)="handler($event)"` |
|
|
@@ -14,6 +14,13 @@
|
|
|
14
14
|
| `syncFirstRender` | `boolean` | `-` | Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`. This guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and run the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM is projected. Note: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the element needs to be measured synchronously after being added to the DOM. |
|
|
15
15
|
|
|
16
16
|
|
|
17
|
+
## Events
|
|
18
|
+
|
|
19
|
+
| Name | Type | Description |
|
|
20
|
+
|------|------|-------------|
|
|
21
|
+
| `gds-control-focus` | `CustomEvent<any>` | Fired when an item in the summary is clicked, before focus moves to the related control. The detail object contains the control. Can be cancelled with event.preventDefault() to handle focus yourself. |
|
|
22
|
+
|
|
23
|
+
|
|
17
24
|
## Slots
|
|
18
25
|
|
|
19
26
|
| Name | Description |
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Form summary
|
|
2
|
+
|
|
3
|
+
Form summary shows all form errors in one place.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
Form summary works automatically when placed in a form with form controls from Green Core. It has two update modes, `default` and `reactive`. In the default mode, a `refresh()` method needs to be called for the component to update and reflect the current state of the form. In the `reactive` mode, it will update on the fly as soon as the status of a control in the form changes. The `reactive` mode requires less setup to use, but the `default` mode allows for more control over the behavior.
|
|
11
|
+
|
|
12
|
+
#### Fieldset labels
|
|
13
|
+
|
|
14
|
+
To reflect the structure of the form, the summary content can be grouped using fieldset labels. These act as headings for related fields and help users quickly understand how the information is organized. By mirroring the same grouping as in the form, it becomes easier to recognize and review the content, improving both clarity and confidence before submission.
|
|
15
|
+
|
|
16
|
+
### Accessibility
|
|
17
|
+
|
|
18
|
+
Semantically, the form summary is represented as a navigation region containing an unordered list of links.
|
|
19
|
+
|
|
20
|
+
### Compatibility
|
|
21
|
+
|
|
22
|
+
Form summary is mainly intended for use with form controls from Green Core, but it also works with generic native form controls by using data-attributes.
|
|
23
|
+
|
|
24
|
+
### Usage
|
|
25
|
+
|
|
26
|
+
For long forms which are dynamically submitted (meaning the page does not reload), place the form summary at the bottom of the form, close to the submit button, so that it appears in view for the user without scrolling.
|
|
27
|
+
|
|
28
|
+
For long forms which are server-side driven (page reloads when submitting), place the form summary at the top so that it will be the first thing the user sees when the page reloads.
|
|
29
|
+
|
|
30
|
+
Short forms, where all controls are easily in view without scrolling, form summary is generally not necessary, since all the errors are already in view.
|
|
31
|
+
|
|
32
|
+
### Do's and don'ts
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
## UX Guidelines
|
|
36
|
+
|
|
37
|
+
### Writing UX text for form summaries
|
|
38
|
+
|
|
39
|
+
### Multiple fields with same name
|
|
@@ -15,3 +15,11 @@ Use the component as a React JSX element:
|
|
|
15
15
|
{/* content */}
|
|
16
16
|
</GdsFormSummary>
|
|
17
17
|
```
|
|
18
|
+
|
|
19
|
+
## Event Handling
|
|
20
|
+
|
|
21
|
+
Events are handled using React event handler props. Event names are converted from kebab-case to camelCase with an "on" prefix:
|
|
22
|
+
|
|
23
|
+
| Web Component Event | React Handler Prop | Handler Example |
|
|
24
|
+
|---------------------|--------------------|-----------------|
|
|
25
|
+
| `gds-control-focus` | `onGdsControlFocus` | `onGdsControlFocus={handler}` |
|
package/generated/mcp/icons.json
CHANGED
package/generated/mcp/index.json
CHANGED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# Input
|
|
2
|
+
|
|
3
|
+
An input lets users enter and edit text or numerical values in forms.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
### Variants
|
|
9
|
+
|
|
10
|
+
To be able to use forms in all context's we provide two versions of input fields.
|
|
11
|
+
|
|
12
|
+
- **Default**
|
|
13
|
+
- Coming soon **Floating label** (label inside): Can only be used in specific contexts. Limited features due to accessibility. Read more about how to use the Floating label on the UX text page [Input field floating label](https://seb.io/component/input/ux-text#input-field-floating-label-5)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
#### Sizes
|
|
18
|
+
|
|
19
|
+
The input field comes in two sizes.
|
|
20
|
+
|
|
21
|
+
- **Large**
|
|
22
|
+
- **Small**: used in tables and in some special cases where the space is very limited.
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Types
|
|
27
|
+
|
|
28
|
+
The input component supports different input types, including text entry and file selection.
|
|
29
|
+
|
|
30
|
+
### Features
|
|
31
|
+
|
|
32
|
+
#### Label
|
|
33
|
+
|
|
34
|
+
All input fields must have a label to ensure clarity and accessibility. Labels help users understand the purpose of the field, including those using assistive technologies.
|
|
35
|
+
|
|
36
|
+
#### Optional field indicator
|
|
37
|
+
|
|
38
|
+
We only ask for required information. If some fields are optional, we let users know by adding "(optional)" in brackets next to the field label.
|
|
39
|
+
|
|
40
|
+
#### Support text
|
|
41
|
+
|
|
42
|
+
Use this to explain how to fill in the field, for example how to count or what to include.
|
|
43
|
+
|
|
44
|
+
### Contextual help
|
|
45
|
+
|
|
46
|
+
If the label and support text are not enough to explain a field, we can use the info icon. Clicking the icon shows additional support text between the label support and the field.
|
|
47
|
+
|
|
48
|
+
- Use a tooltip if space is limited.
|
|
49
|
+
- Use a modal for large amounts of text.
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### Leading icon
|
|
54
|
+
|
|
55
|
+
A leading icon visually reinforces the purpose of the field, helping users to understand what type of information is needed. For example: search fields or card number.
|
|
56
|
+
|
|
57
|
+
#### Clearable
|
|
58
|
+
|
|
59
|
+
To make it easy for users to clear a field, an x-icon button can be placed at the end of the field. This is commonly used in search/filter forms.
|
|
60
|
+
|
|
61
|
+
#### Badge
|
|
62
|
+
|
|
63
|
+
Use it to show what the unit input value is.
|
|
64
|
+
|
|
65
|
+
For example: EUR
|
|
66
|
+
|
|
67
|
+
#### Error message
|
|
68
|
+
|
|
69
|
+
Used to indicate that a selection must be made from the dropdown or that there is an error with the selected option.
|
|
70
|
+
|
|
71
|
+
#### Character counter
|
|
72
|
+
|
|
73
|
+
For fields with a character limit, a counter can be added to show users how many characters they have left.
|
|
74
|
+
|
|
75
|
+
The counter starts with the maximum allowed characters. As the user types, the remaining characters decrease. When the limit is nearly reached, the counter turns yellow. When or if the user exceeds the limit, the counter turns red.
|
|
76
|
+
|
|
77
|
+
If the user ignores this and attempts to submit, an error message will appear indicating that the maximum character limit has been reached.
|
|
78
|
+
|
|
79
|
+
#### Dynamic information
|
|
80
|
+
|
|
81
|
+
(Not available for Floating label variant) Used to perform comparative calculations next to the field.
|
|
82
|
+
|
|
83
|
+
#### Placeholder
|
|
84
|
+
|
|
85
|
+
Avoid using placeholder text (also known as watermark), as it can confuse users into thinking the field is already filled with data. Instructions should not be placed in the field, as they disappear once the user starts typing. Instead, use support text to guide users on what should be entered.
|
|
86
|
+
|
|
87
|
+
### Read only
|
|
88
|
+
|
|
89
|
+
The read only state displays the entered value together with its label. Have no visual cues associated with text entry, such as an active input cursor or editable states. Long content should remain readable and should not be unnecessarily truncated.
|
|
90
|
+
[More about the read only pattern](https://seb.io/patterns/read-only)
|
|
91
|
+
|
|
92
|
+
### Do’s and dont’s
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
## UX Guidelines
|
|
96
|
+
|
|
97
|
+
### Input field default
|
|
98
|
+
|
|
99
|
+
### Labels
|
|
100
|
+
|
|
101
|
+
### Single-word or complete sentence
|
|
102
|
+
|
|
103
|
+
### Write the time period in the label
|
|
104
|
+
|
|
105
|
+
### Avoid fixed text inside the field
|
|
106
|
+
|
|
107
|
+
### Display the currency with a badge
|
|
108
|
+
|
|
109
|
+
### Placeholder text
|
|
110
|
+
|
|
111
|
+
### Labels do’s and dont’s
|
|
112
|
+
|
|
113
|
+
### Error message
|
|
114
|
+
|
|
115
|
+
### Input field floating label
|
|
116
|
+
|
|
117
|
+
### Do’s and dont’s input field floating label
|
|
118
|
+
|
|
119
|
+
### Default or floating label?
|
|
120
|
+
|
|
121
|
+
### Search field
|
|
122
|
+
|
|
123
|
+
### Label support text for search field
|
|
124
|
+
|
|
125
|
+
### Give ideas with examples
|
|
126
|
+
|
|
127
|
+
### Search feedback
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Link
|
|
2
|
+
|
|
3
|
+
A link navigates users to other pages or sections of content.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
### Usage
|
|
9
|
+
|
|
10
|
+
Use links for navigation whether it’s within the same page, across pages, or to external sites. A good link is easy to recognize, descriptive, and accessible. It should clearly communicate where it will take the user, even when read out of context (for example, by a screen reader). Avoid using links for actions such as submitting forms or opening modals use buttons instead.
|
|
11
|
+
|
|
12
|
+
### Variants
|
|
13
|
+
|
|
14
|
+
#### Leading icon
|
|
15
|
+
|
|
16
|
+
Use when an icon helps reinforce the meaning of the link (e.g., a document or download icon before the text).
|
|
17
|
+
|
|
18
|
+
#### Trailing icon
|
|
19
|
+
|
|
20
|
+
Use for links that lead to another page or outside the current application, such as external websites.
|
|
21
|
+
|
|
22
|
+
#### Text decoration
|
|
23
|
+
|
|
24
|
+
Used when a stronger visual indication is needed for example, in long bodies of text or when links need to stand out clearly from surrounding content.
|
|
25
|
+
|
|
26
|
+
### Do’s and don’ts
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
## UX Guidelines
|
|
30
|
+
|
|
31
|
+
### Writing UX text for links
|
|
32
|
+
|
|
33
|
+
### Only include necessary words
|
|
34
|
+
|
|
35
|
+
### Placing links
|
|
36
|
+
|
|
37
|
+
### Links within text
|
|
38
|
+
|
|
39
|
+
### Link outside of the text
|
|
40
|
+
|
|
41
|
+
### Links before a form component
|
|
42
|
+
|
|
43
|
+
### Add items to a list
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# List
|
|
2
|
+
|
|
3
|
+
A list arranges related list items in a consistent vertical layout.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
### List item
|
|
9
|
+
|
|
10
|
+
A List item is a semantic container with no predefined internal layout. It provides a single content slot, allowing patterns or custom layouts to be projected into each item.
|
|
11
|
+
|
|
12
|
+
### Accessibility
|
|
13
|
+
|
|
14
|
+
The List component uses semantic list markup to communicate the relationship between list items, improving navigation and accessibility for assistive technologies.
|
|
15
|
+
|
|
16
|
+
### Do's and don'ts
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# List item pattern 01
|
|
2
|
+
|
|
3
|
+
List item Pattern 01 provides a predefined layout for displaying structured information in a list.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
### When to use
|
|
9
|
+
|
|
10
|
+
Use Pattern 01 when displaying structured information that users need to scan, compare or interact with. Common examples include:
|
|
11
|
+
|
|
12
|
+
### Layout examples
|
|
13
|
+
|
|
14
|
+
### Interaction
|
|
15
|
+
|
|
16
|
+
Pattern 01 supports both static and interactive list items.
|
|
17
|
+
|
|
18
|
+
Depending on the use case, a list item can be:
|
|
19
|
+
|
|
20
|
+
- **Static** – displays information without interaction.
|
|
21
|
+
- **Selectable** – allows users to select one or more items.
|
|
22
|
+
- **Navigational** – takes users to another view or destination.
|
|
23
|
+
- **Selectable and navigational** – supports both selection and navigation within the same item.
|
|
24
|
+
|
|
25
|
+
Use the same interaction pattern consistently throughout a list to create a predictable user experience.
|
|
26
|
+
|
|
27
|
+
### Slots
|
|
28
|
+
|
|
29
|
+
List item pattern 01 is built around three slots that help organise content in a consistent and predictable way.
|
|
30
|
+
|
|
31
|
+
#### Lead slot
|
|
32
|
+
|
|
33
|
+
Use for icons, avatars, or custom leading content. When `selectable` is enabled, it shows a checkbox.
|
|
34
|
+
|
|
35
|
+
#### Content slot
|
|
36
|
+
|
|
37
|
+
The Content slot is fully customizable and can contain any content needed for your use case.
|
|
38
|
+
|
|
39
|
+
For the recommended layout, use the `Items` property. It provides predefined content styles and supports one, two or three content columns, making it easy to create consistent and scannable list items.
|
|
40
|
+
|
|
41
|
+
If your layout requires more flexibility than the `Items` property supports, you can instead provide custom content through the Content slot.
|
|
42
|
+
|
|
43
|
+
#### Trail slot
|
|
44
|
+
|
|
45
|
+
Use the **Trail** slot for secondary content, such as values, status, metadata or actions. Keep trailing content concise and avoid placing the primary information here.
|
|
46
|
+
|
|
47
|
+
When a list item is configured as navigational**** (`href)`, a chevron icon is automatically displayed in the Trail slot. When configured as `selectable`**** and**** `navigational`, the Trail slot instead displays an icon button with a chevron icon, indicating both selection and navigation.
|
|
48
|
+
|
|
49
|
+
### Do's and don'ts
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Menu button
|
|
2
|
+
|
|
3
|
+
A menu button combines button and link behaviors for navigation menus.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
### Usage
|
|
9
|
+
|
|
10
|
+
Use the menu button to create clear and accessible navigation. Choose the appropriate combination of text and icon depending on the context:
|
|
11
|
+
|
|
12
|
+
* **Text only** is best for straightforward links where the label clearly communicates the destination.
|
|
13
|
+
|
|
14
|
+
* **Text with icon** adds clarity, especially when the icon reinforces the meaning (e.g., a user icon for profile-related links).
|
|
15
|
+
|
|
16
|
+
* **Icon only** can be used when space is limited, but only if the icon is widely recognized and its meaning is clear.
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
Menu buttons have a selected state that visually indicate the current page or section.
|
|
20
|
+
|
|
21
|
+
### Sizes
|
|
22
|
+
|
|
23
|
+
The menu button comes in three sizes to fit different layout needs and navigation contexts:
|
|
24
|
+
|
|
25
|
+
* **Large** - Typically used in primary navigation where space allows for larger, more prominent buttons. It provides good readability and clear touch targets.
|
|
26
|
+
|
|
27
|
+
* **Medium** - Works well when space is limited but readability and clarity are still important.
|
|
28
|
+
|
|
29
|
+
* **Small** - Optimized for tighter layouts and smaller viewports. The text and icon are vertically aligned to maintain visual balance in compact spaces, such as in mobile navigation or secondary toolbars.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
Regardless of size, the height of the menu button will adapt to match the height set by the container. This ensures consistent alignment and spacing across the entire navigation.
|
|
33
|
+
|
|
34
|
+
### Do's and don'ts
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
## UX Guidelines
|
|
38
|
+
|
|
39
|
+
### Writing UX text for menu buttons
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Pagination
|
|
2
|
+
|
|
3
|
+
Pagination helps users navigate large result sets by dividing content into clear, manageable pages.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
### Usage
|
|
9
|
+
|
|
10
|
+
Pagination is used to divide large amounts of content into smaller pages, making it easier to navigate and understand a dataset. It is most useful when content cannot be displayed at once, or when users need to move through information in a defined order.
|
|
11
|
+
|
|
12
|
+
Use pagination when it improves readability and control, for example in tables or long lists, search results, or content listings. Avoid using pagination for small datasets or when continuous scrolling provides a better experience.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Behaviour
|
|
17
|
+
|
|
18
|
+
Pagination should clearly indicate the current page and keep navigation consistent and predictable. Unavailable actions should be disabled at the start or end of the page range. When used with data tables, the item range and total number of items should be displayed.
|
|
19
|
+
|
|
20
|
+
### Accessibility
|
|
21
|
+
|
|
22
|
+
Pagination should use a semantic navigation structure and ensure that all controls are keyboard accessible. The current page should be communicated programmatically, and visual styling alone should not be relied on to convey state.
|
|
23
|
+
|
|
24
|
+
### Do's and don'ts
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Progress
|
|
2
|
+
|
|
3
|
+
Shows the progress and status of an ongoing process.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
|
|
8
|
+
### Usage
|
|
9
|
+
|
|
10
|
+
Progress communicates the status of an ongoing process and helps users understand that something is happening and, when progress can be measured, how much remains.
|
|
11
|
+
|
|
12
|
+
Use Progress for processes that take noticeable time, such as uploading, downloading or processing information.
|
|
13
|
+
|
|
14
|
+
Use **determinate** progress when progress can be measured, and **indeterminate** progress when it cannot.
|
|
15
|
+
|
|
16
|
+
### Determinate and indeterminate
|
|
17
|
+
|
|
18
|
+
Use **determinate** when progress can be measured. The progress bar fills as the process progresses and can show the current value as a percentage or other meaningful information.
|
|
19
|
+
|
|
20
|
+
Use **indeterminate** when the remaining work cannot be measured. The animated progress bar communicates that the process is ongoing without indicating how much remains.
|
|
21
|
+
|
|
22
|
+
### States
|
|
23
|
+
|
|
24
|
+
Progress supports **in progress**, **completed** and **failed** states. Completed and failed states use status colour and an icon to clearly communicate the outcome.
|
|
25
|
+
|
|
26
|
+
### Size
|
|
27
|
+
|
|
28
|
+
Progress is available in **large** and **small**. Use large by default. Use small in compact layouts when you use other small components, or when progress needs less visual prominence.
|
|
29
|
+
|
|
30
|
+
### Layout
|
|
31
|
+
|
|
32
|
+
By default, the label and value are displayed above the progress bar using **column**.
|
|
33
|
+
|
|
34
|
+
Use **column-reverse** to place them below the progress bar when this better suits the surrounding layout.
|
|
35
|
+
|
|
36
|
+
### Label and value
|
|
37
|
+
|
|
38
|
+
Use a short label that describes what is happening, such as **Uploading** or **Downloading**.The value shows progress as a percentage by default. Use **trail** to replace it with more meaningful information when needed, such as **42 of 100 MB** or **Step 2 of 3**.Use **hide-value** when the label is useful but the exact value is not needed.Use **plain** when the surrounding context already communicates what is happening and only the progress bar is needed.
|
|
39
|
+
|
|
40
|
+
### Accessibility
|
|
41
|
+
|
|
42
|
+
Progress is announced to assistive technologies without interrupting the user as the value changes. Updates are communicated in a way that avoids unnecessary or repetitive announcements.
|