@iress-oss/ids-mcp-server 5.15.0 → 5.20.2
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/generated/docs/components_components-alert-docs.md +496 -0
- package/generated/docs/components_components-autocomplete-docs.md +3429 -0
- package/generated/docs/{components-autocomplete-recipes-docs.md → components_components-autocomplete-recipes-docs.md} +39 -14
- package/generated/docs/{components-badge-docs.md → components_components-badge-docs.md} +222 -30
- package/generated/docs/components_components-button-docs.md +2078 -0
- package/generated/docs/components_components-button-recipes-docs.md +37 -0
- package/generated/docs/components_components-buttongroup-docs.md +1045 -0
- package/generated/docs/components_components-card-docs.md +2290 -0
- package/generated/docs/{components-card-recipes-docs.md → components_components-card-recipes-docs.md} +132 -15
- package/generated/docs/components_components-checkbox-docs.md +1040 -0
- package/generated/docs/{components-checkboxgroup-docs.md → components_components-checkboxgroup-docs.md} +1001 -82
- package/generated/docs/{components-checkboxgroup-recipes-docs.md → components_components-checkboxgroup-recipes-docs.md} +102 -12
- package/generated/docs/{components-col-docs.md → components_components-col-docs.md} +331 -58
- package/generated/docs/components_components-combobox-docs.md +3735 -0
- package/generated/docs/{components-container-docs.md → components_components-container-docs.md} +61 -24
- package/generated/docs/{components-divider-docs.md → components_components-divider-docs.md} +83 -24
- package/generated/docs/{components-expander-docs.md → components_components-expander-docs.md} +266 -33
- package/generated/docs/components_components-field-docs.md +1369 -0
- package/generated/docs/components_components-filter-docs.md +4080 -0
- package/generated/docs/{components-form-docs.md → components_components-form-docs.md} +1556 -360
- package/generated/docs/{components-form-recipes-docs.md → components_components-form-recipes-docs.md} +277 -60
- package/generated/docs/{components-hide-docs.md → components_components-hide-docs.md} +195 -124
- package/generated/docs/components_components-icon-docs.md +1337 -0
- package/generated/docs/{components-inline-docs.md → components_components-inline-docs.md} +462 -42
- package/generated/docs/components_components-input-docs.md +1468 -0
- package/generated/docs/components_components-input-recipes-docs.md +367 -0
- package/generated/docs/components_components-inputcurrency-docs.md +432 -0
- package/generated/docs/{components-inputcurrency-recipes-docs.md → components_components-inputcurrency-recipes-docs.md} +113 -17
- package/generated/docs/components_components-label-docs.md +323 -0
- package/generated/docs/components_components-menu-docs.md +2345 -0
- package/generated/docs/components_components-menu-menuitem-docs.md +633 -0
- package/generated/docs/{components-modal-docs.md → components_components-modal-docs.md} +1640 -231
- package/generated/docs/components_components-navbar-docs.md +1847 -0
- package/generated/docs/{components-navbar-recipes-docs.md → components_components-navbar-recipes-docs.md} +721 -40
- package/generated/docs/{components-panel-docs.md → components_components-panel-docs.md} +754 -57
- package/generated/docs/components_components-placeholder-docs.md +92 -0
- package/generated/docs/components_components-popover-docs.md +1643 -0
- package/generated/docs/components_components-popover-recipes-docs.md +491 -0
- package/generated/docs/components_components-progress-docs.md +115 -0
- package/generated/docs/{components-provider-docs.md → components_components-provider-docs.md} +42 -33
- package/generated/docs/components_components-radio-docs.md +491 -0
- package/generated/docs/{components-radiogroup-docs.md → components_components-radiogroup-docs.md} +927 -75
- package/generated/docs/components_components-readonly-docs.md +263 -0
- package/generated/docs/components_components-richselect-docs.md +6521 -0
- package/generated/docs/{components-row-docs.md → components_components-row-docs.md} +353 -43
- package/generated/docs/{components-select-docs.md → components_components-select-docs.md} +719 -61
- package/generated/docs/components_components-skeleton-docs.md +480 -0
- package/generated/docs/{components-skeleton-recipes-docs.md → components_components-skeleton-recipes-docs.md} +51 -11
- package/generated/docs/{components-skiplink-docs.md → components_components-skiplink-docs.md} +53 -14
- package/generated/docs/components_components-slideout-docs.md +2293 -0
- package/generated/docs/components_components-slider-docs.md +1276 -0
- package/generated/docs/components_components-spinner-docs.md +82 -0
- package/generated/docs/{components-stack-docs.md → components_components-stack-docs.md} +223 -40
- package/generated/docs/components_components-table-docs.md +3658 -0
- package/generated/docs/components_components-tabset-docs.md +772 -0
- package/generated/docs/components_components-tabset-tab-docs.md +262 -0
- package/generated/docs/components_components-tag-docs.md +257 -0
- package/generated/docs/{components-text-docs.md → components_components-text-docs.md} +491 -51
- package/generated/docs/{components-toaster-docs.md → components_components-toaster-docs.md} +187 -85
- package/generated/docs/components_components-toaster-toast-docs.md +634 -0
- package/generated/docs/components_components-toggle-docs.md +461 -0
- package/generated/docs/{components-tooltip-docs.md → components_components-tooltip-docs.md} +286 -41
- package/generated/docs/{components-validationmessage-docs.md → components_components-validationmessage-docs.md} +230 -61
- package/generated/docs/components_contact-us-docs.md +12 -0
- package/generated/docs/{foundations-accessibility-docs.md → components_foundations-accessibility-docs.md} +11 -21
- package/generated/docs/{foundations-colours-docs.md → components_foundations-colour-030-colours.md} +8 -15
- package/generated/docs/{foundations-consistency-docs.md → components_foundations-consistency-docs.md} +12 -20
- package/generated/docs/{foundations-content-docs.md → components_foundations-content-docs.md} +6 -11
- package/generated/docs/components_foundations-introduction-docs.md +15 -0
- package/generated/docs/{foundations-principles-docs.md → components_foundations-principles-docs.md} +14 -24
- package/generated/docs/components_foundations-typography-docs.md +608 -0
- package/generated/docs/{foundations-user-experience-docs.md → components_foundations-user-experience-docs.md} +16 -26
- package/generated/docs/{foundations-visual-design-docs.md → components_foundations-visual-design-docs.md} +10 -17
- package/generated/docs/{frequently-asked-questions-docs.md → components_frequently-asked-questions-docs.md} +14 -23
- package/generated/docs/components_get-started-develop-docs.md +84 -0
- package/generated/docs/components_get-started-using-storybook-docs.md +55 -0
- package/generated/docs/components_introduction-docs.md +15 -0
- package/generated/docs/{patterns-loading-docs.md → components_patterns-loading-docs.md} +798 -153
- package/generated/docs/components_resources-changelog-docs.md +4 -0
- package/generated/docs/{resources-code-katas-docs.md → components_resources-code-katas-docs.md} +5 -9
- package/generated/docs/{resources-migration-guides-from-v4-to-v5-docs.md → components_resources-migration-guides-from-v4-to-v5-docs.md} +54 -239
- package/generated/docs/components_sandbox-docs.md +4 -0
- package/generated/docs/{versions-docs.md → components_versions-docs.md} +5 -8
- package/generated/docs/guidelines.md +484 -200
- package/generated/docs/introduction-docs.md +19 -30
- package/package.json +41 -45
- package/generated/docs/components-alert-docs.md +0 -130
- package/generated/docs/components-autocomplete-docs.md +0 -754
- package/generated/docs/components-button-docs.md +0 -362
- package/generated/docs/components-button-recipes-docs.md +0 -76
- package/generated/docs/components-buttongroup-docs.md +0 -310
- package/generated/docs/components-card-docs.md +0 -494
- package/generated/docs/components-checkbox-docs.md +0 -193
- package/generated/docs/components-combobox-docs.md +0 -1016
- package/generated/docs/components-field-docs.md +0 -675
- package/generated/docs/components-filter-docs.md +0 -1109
- package/generated/docs/components-icon-docs.md +0 -553
- package/generated/docs/components-input-docs.md +0 -335
- package/generated/docs/components-input-recipes-docs.md +0 -140
- package/generated/docs/components-inputcurrency-docs.md +0 -157
- package/generated/docs/components-label-docs.md +0 -135
- package/generated/docs/components-menu-docs.md +0 -704
- package/generated/docs/components-menu-menuitem-docs.md +0 -193
- package/generated/docs/components-navbar-docs.md +0 -291
- package/generated/docs/components-placeholder-docs.md +0 -27
- package/generated/docs/components-popover-docs.md +0 -464
- package/generated/docs/components-popover-recipes-docs.md +0 -245
- package/generated/docs/components-progress-docs.md +0 -104
- package/generated/docs/components-radio-docs.md +0 -107
- package/generated/docs/components-readonly-docs.md +0 -89
- package/generated/docs/components-richselect-docs.md +0 -2433
- package/generated/docs/components-skeleton-docs.md +0 -214
- package/generated/docs/components-slideout-docs.md +0 -538
- package/generated/docs/components-slider-docs.md +0 -346
- package/generated/docs/components-spinner-docs.md +0 -59
- package/generated/docs/components-table-ag-grid-docs.md +0 -1074
- package/generated/docs/components-table-docs.md +0 -1305
- package/generated/docs/components-tabset-docs.md +0 -341
- package/generated/docs/components-tabset-tab-docs.md +0 -86
- package/generated/docs/components-tag-docs.md +0 -115
- package/generated/docs/components-toaster-toast-docs.md +0 -157
- package/generated/docs/components-toggle-docs.md +0 -158
- package/generated/docs/contact-us-docs.md +0 -27
- package/generated/docs/extensions-editor-docs.md +0 -288
- package/generated/docs/extensions-editor-recipes-docs.md +0 -39
- package/generated/docs/foundations-introduction-docs.md +0 -17
- package/generated/docs/foundations-typography-docs.md +0 -191
- package/generated/docs/get-started-develop-docs.md +0 -209
- package/generated/docs/get-started-using-storybook-docs.md +0 -68
- package/generated/docs/resources-changelog-docs.md +0 -6
- package/generated/docs/themes-available-themes-docs.md +0 -66
- package/generated/docs/themes-introduction-docs.md +0 -121
- package/generated/docs/themes-tokens-docs.md +0 -1200
- /package/{LICENSE.txt → LICENSE} +0 -0
|
@@ -2,41 +2,39 @@
|
|
|
2
2
|
|
|
3
3
|
This document contains all design foundations and guidelines for the design system.
|
|
4
4
|
|
|
5
|
-
## Introduction
|
|
5
|
+
## React components / Introduction
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
7
|
+
Introduction
|
|
8
|
+
============
|
|
9
9
|
|
|
10
10
|
The IDS and product design team use the foundations to create a consistent user experience across all Iress products. This includes design principles and guidelines that ensure a cohesive look and feel.
|
|
11
11
|
|
|
12
|
-
1. [Principles](
|
|
13
|
-
2. [Accessibility](
|
|
14
|
-
3. [Colours](
|
|
15
|
-
4. [Typography](
|
|
16
|
-
5. [Visual Design](
|
|
17
|
-
6. [Consistency](
|
|
18
|
-
7. [Content](
|
|
19
|
-
8. [User Experience](
|
|
12
|
+
1. [Principles](/docs/foundations-principles--docs)
|
|
13
|
+
2. [Accessibility](/docs/foundations-accessibility--docs)
|
|
14
|
+
3. [Colours](/docs/foundations-colours--docs)
|
|
15
|
+
4. [Typography](/docs/foundations-typography--docs)
|
|
16
|
+
5. [Visual Design](/docs/foundations-visual-design--docs)
|
|
17
|
+
6. [Consistency](/docs/foundations-consistency--docs)
|
|
18
|
+
7. [Content](/docs/foundations-content--docs)
|
|
19
|
+
8. [User Experience](/docs/foundations-user-experience--docs)
|
|
20
20
|
|
|
21
21
|
_This document is a living standard. Revisit and revise regularly to reflect evolving needs, technologies, and user expectations._
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
## Principles
|
|
23
|
+
## React components / Principles
|
|
26
24
|
|
|
27
|
-
|
|
28
|
-
|
|
25
|
+
Core Design Principles
|
|
26
|
+
======================
|
|
29
27
|
|
|
30
|
-
|
|
31
|
-
|
|
28
|
+
Consistency
|
|
29
|
+
-----------
|
|
32
30
|
|
|
33
31
|
* Maintain brand consistency across all applications and experiences
|
|
34
32
|
* Use standardised component naming conventions (all components start with `Iress` prefix)
|
|
35
33
|
* Leverage shared design tokens for spacing, colours, typography, and interactive states
|
|
36
34
|
* Ensure consistent behaviour patterns across similar components
|
|
37
35
|
|
|
38
|
-
|
|
39
|
-
|
|
36
|
+
Accessibility First
|
|
37
|
+
-------------------
|
|
40
38
|
|
|
41
39
|
* Meet or exceed WCAG 2.1 Level AA Accessibility Guidelines
|
|
42
40
|
* Provide proper colour contrast ratios (minimum 4.5:1 for AA, 7:1 for AAA)
|
|
@@ -45,16 +43,16 @@ On this page
|
|
|
45
43
|
* Support focus management and skip navigation patterns
|
|
46
44
|
* Document accessibility considerations and requirements
|
|
47
45
|
|
|
48
|
-
|
|
49
|
-
|
|
46
|
+
Clarity and Usability
|
|
47
|
+
---------------------
|
|
50
48
|
|
|
51
49
|
* Prioritise clear visual hierarchy through typography scales and spacing systems
|
|
52
50
|
* Use progressive disclosure to manage complexity
|
|
53
51
|
* Provide immediate feedback for user actions (loading states, validation, etc.)
|
|
54
52
|
* Design for touch-friendly interfaces with adequate target sizes
|
|
55
53
|
|
|
56
|
-
|
|
57
|
-
|
|
54
|
+
Developer Experience
|
|
55
|
+
--------------------
|
|
58
56
|
|
|
59
57
|
* Maintain clean component APIs with predictable prop patterns
|
|
60
58
|
* Provide comprehensive documentation with usage examples
|
|
@@ -63,65 +61,55 @@ On this page
|
|
|
63
61
|
* Enable efficient testing strategies with semantic roles and accessible queries
|
|
64
62
|
* Maintain up-to-date prop documentation and type definitions
|
|
65
63
|
|
|
66
|
-
|
|
67
|
-
|
|
64
|
+
Quality assurance
|
|
65
|
+
-----------------
|
|
68
66
|
|
|
69
67
|
* Test components across supported browsers and devices
|
|
70
68
|
* Validate accessibility compliance with automated and manual testing
|
|
71
69
|
* Ensure proper keyboard navigation functionality
|
|
72
70
|
* Test with assistive technologies (screen readers, voice control)
|
|
73
71
|
|
|
74
|
-
###
|
|
72
|
+
### Code Standards
|
|
75
73
|
|
|
76
74
|
* Follow consistent naming conventions for CSS classes and component props
|
|
77
75
|
* Use semantic HTML elements where appropriate
|
|
78
76
|
* Implement proper TypeScript typing for better developer experience
|
|
79
77
|
* Maintain clean separation between presentation and logic
|
|
80
78
|
|
|
81
|
-
###
|
|
79
|
+
### Performance Considerations
|
|
82
80
|
|
|
83
81
|
* Optimise component rendering and re-rendering
|
|
84
82
|
* Implement appropriate code splitting strategies
|
|
85
83
|
* Use efficient animation and transition patterns
|
|
86
84
|
* Consider bundle size impact of component dependencies
|
|
87
85
|
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
* [Consistency](#consistency)
|
|
91
|
-
* [Accessibility First](#accessibility-first)
|
|
92
|
-
* [Clarity and Usability](#clarity-and-usability)
|
|
93
|
-
* [Developer Experience](#developer-experience)
|
|
94
|
-
* [Quality assurance](#quality-assurance)
|
|
95
|
-
* [Code Standards](#code-standards)
|
|
96
|
-
* [Performance Considerations](#performance-considerations)
|
|
97
|
-
|
|
98
|
-
## Accessibility
|
|
86
|
+
## React components / Accessibility
|
|
99
87
|
|
|
100
|
-
|
|
101
|
-
|
|
88
|
+
Accessibility
|
|
89
|
+
=============
|
|
102
90
|
|
|
103
91
|
Accessibility is everyone's responsibility. It ensures that all users, regardless of their abilities or disabilities, can access and interact with our components effectively. This document outlines the key practices for building accessible components we follow within IDS.
|
|
104
92
|
|
|
105
93
|
Please note: The default behaviour of our components is to be accessible, but it is the responsibility of the product to ensure that they are used correctly in accessibile context, or any modifications made to them do not compromise accessibility.
|
|
106
94
|
|
|
107
|
-
|
|
108
|
-
|
|
95
|
+
Interaction Patterns
|
|
96
|
+
--------------------
|
|
109
97
|
|
|
110
|
-
###
|
|
98
|
+
### Keyboard Navigation
|
|
111
99
|
|
|
112
100
|
* Support standard keyboard shortcuts (Tab, Arrow keys, Enter, Space, Escape)
|
|
113
101
|
* Implement proper focus order and visual focus indicators
|
|
114
102
|
* Provide keyboard alternatives for mouse-only interactions
|
|
115
103
|
* Follow established ARIA patterns for complex widgets
|
|
116
104
|
|
|
117
|
-
###
|
|
105
|
+
### Touch Interactions
|
|
118
106
|
|
|
119
107
|
* Provide adequate touch target sizes (minimum 44px)
|
|
120
108
|
* Implement touch-friendly spacing between interactive elements
|
|
121
109
|
* Support gesture-based interactions where appropriate
|
|
122
110
|
* Ensure consistent behaviour across device types
|
|
123
111
|
|
|
124
|
-
###
|
|
112
|
+
### Loading and Feedback
|
|
125
113
|
|
|
126
114
|
* Use appropriate loading patterns based on context:
|
|
127
115
|
* **Page**: Full page loading states
|
|
@@ -133,44 +121,34 @@ Please note: The default behaviour of our components is to be accessible, but it
|
|
|
133
121
|
|
|
134
122
|
* * *
|
|
135
123
|
|
|
136
|
-
|
|
137
|
-
|
|
124
|
+
Responsive Design
|
|
125
|
+
-----------------
|
|
138
126
|
|
|
139
|
-
###
|
|
127
|
+
### Breakpoint Strategy
|
|
140
128
|
|
|
141
129
|
* Implement mobile-first responsive design
|
|
142
130
|
* Use consistent breakpoint values across all components
|
|
143
131
|
* Provide appropriate component variants for different screen sizes
|
|
144
132
|
* Consider content priority and progressive disclosure on smaller screens
|
|
145
133
|
|
|
146
|
-
###
|
|
134
|
+
### Adaptive Behaviour
|
|
147
135
|
|
|
148
136
|
* Reduce option counts on mobile devices where appropriate
|
|
149
137
|
* Implement responsive navigation patterns
|
|
150
138
|
* Adjust spacing and sizing for different contexts
|
|
151
139
|
* Maintain usability across all supported devices
|
|
152
140
|
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
* [Interaction Patterns](#interaction-patterns)
|
|
156
|
-
* [Keyboard Navigation](#keyboard-navigation)
|
|
157
|
-
* [Touch Interactions](#touch-interactions)
|
|
158
|
-
* [Loading and Feedback](#loading-and-feedback)
|
|
159
|
-
* [Responsive Design](#responsive-design)
|
|
160
|
-
* [Breakpoint Strategy](#breakpoint-strategy)
|
|
161
|
-
* [Adaptive Behaviour](#adaptive-behaviour)
|
|
162
|
-
|
|
163
|
-
## Colours
|
|
141
|
+
## React components / Colour
|
|
164
142
|
|
|
165
|
-
|
|
166
|
-
|
|
143
|
+
Colours
|
|
144
|
+
=======
|
|
167
145
|
|
|
168
146
|
Colour is an integral aspect of conveying clear concise data. Our colours are optimized across two backgrounds, meeting or exceeding [WCAG 2.1 Level AA Accessibility Guidelines](https://www.w3.org/TR/WCAG21/#contrast-minimum).
|
|
169
147
|
|
|
170
148
|
The Iress themes are designed to meet WCAG contrast guidelines (2.1 AA). We can't guarantee this when consumer branding is applied, so colour combinations should be checked to ensure conformance.
|
|
171
149
|
|
|
172
|
-
|
|
173
|
-
|
|
150
|
+
Backgrounds
|
|
151
|
+
-----------
|
|
174
152
|
|
|
175
153
|
### Default Background
|
|
176
154
|
|
|
@@ -304,8 +282,8 @@ Used for the hover and active state of elements such as tables, button groups, e
|
|
|
304
282
|
5.1 AA
|
|
305
283
|
|
|
306
284
|
|
|
307
|
-
|
|
308
|
-
|
|
285
|
+
Primary
|
|
286
|
+
-------
|
|
309
287
|
|
|
310
288
|
### Primary
|
|
311
289
|
|
|
@@ -333,8 +311,8 @@ Used for the hover state of primary buttons.
|
|
|
333
311
|
15.5 AAA
|
|
334
312
|
|
|
335
313
|
|
|
336
|
-
|
|
337
|
-
|
|
314
|
+
System
|
|
315
|
+
------
|
|
338
316
|
|
|
339
317
|
### Info
|
|
340
318
|
|
|
@@ -412,37 +390,30 @@ Used to indicate an element that is above a threshold or limit. Usually used for
|
|
|
412
390
|
* \--iress-g-positive-contrast-color
|
|
413
391
|
|
|
414
392
|
5.5 AA
|
|
415
|
-
|
|
416
393
|
|
|
417
|
-
|
|
394
|
+
## React components / Typography
|
|
418
395
|
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
* [System](#system)
|
|
422
|
-
|
|
423
|
-
## Typography
|
|
424
|
-
|
|
425
|
-
[](#typography)Typography
|
|
426
|
-
=========================
|
|
396
|
+
Typography
|
|
397
|
+
==========
|
|
427
398
|
|
|
428
399
|
Typography is set up as part of the theming. Typography is controlled by the `IressText` component and the `iress-u-text` utility class. They implement consistent line heights and font weights.
|
|
429
400
|
|
|
430
401
|
Typography styles are designed to be encapsulated. If you want text to pick up the Iress styling, you'll need to wrap it in an `IressText` component.
|
|
431
402
|
|
|
432
|
-
|
|
433
|
-
|
|
403
|
+
Body
|
|
404
|
+
----
|
|
434
405
|
|
|
435
406
|
This is the default text variant, and is designed to be clear and easy to read.
|
|
436
407
|
|
|
408
|
+
[](./iframe.html?id=foundations-typography--body)
|
|
409
|
+
|
|
437
410
|
Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita.
|
|
438
411
|
|
|
439
412
|
* Voluptatem assumenda soluta!
|
|
440
413
|
* Illum et atque alias possimus maiores rem in corrupti consectetur!
|
|
441
414
|
* Dolorum, repellat expedita!
|
|
442
415
|
|
|
443
|
-
Hide
|
|
444
|
-
|
|
445
|
-
\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
|
|
416
|
+
Hide codedrawOpen in CodeSandbox
|
|
446
417
|
|
|
447
418
|
<IressText\>
|
|
448
419
|
<p\>
|
|
@@ -457,13 +428,87 @@ Hide code
|
|
|
457
428
|
</ul\>
|
|
458
429
|
</IressText\>
|
|
459
430
|
|
|
460
|
-
|
|
431
|
+
```
|
|
461
432
|
|
|
462
|
-
|
|
463
|
-
|
|
433
|
+
#### Props
|
|
434
|
+
|
|
435
|
+
| Name | Description | Default | Control |
|
|
436
|
+
| --- | --- | --- | --- |
|
|
437
|
+
| align |
|
|
438
|
+
Text alignment.
|
|
439
|
+
|
|
440
|
+
union
|
|
441
|
+
|
|
442
|
+
| \- | Set object |
|
|
443
|
+
| children |
|
|
444
|
+
|
|
445
|
+
The content to be rendered; can be a string or a ReactNode (e.g. IressIcon).
|
|
446
|
+
|
|
447
|
+
union
|
|
448
|
+
|
|
449
|
+
| \- |
|
|
450
|
+
|
|
451
|
+
Edit JSON
|
|
452
|
+
|
|
453
|
+
* children :
|
|
454
|
+
|
|
455
|
+
\[
|
|
456
|
+
|
|
457
|
+
* 0 :
|
|
458
|
+
|
|
459
|
+
{...} 6 keys
|
|
460
|
+
|
|
461
|
+
* 1 :
|
|
462
|
+
|
|
463
|
+
{...} 6 keys
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
\]
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
|
470
|
+
| element |
|
|
471
|
+
|
|
472
|
+
The HTML element that should be rendered.
|
|
473
|
+
|
|
474
|
+
union
|
|
475
|
+
|
|
476
|
+
|
|
|
477
|
+
|
|
478
|
+
'div'
|
|
479
|
+
|
|
480
|
+
| Set object |
|
|
481
|
+
| mode |
|
|
482
|
+
|
|
483
|
+
Allows control of the text color.
|
|
484
|
+
|
|
485
|
+
**Note**: The body mode has been deprecated and will be removed in a future version. Please use the body variant instead.
|
|
486
|
+
|
|
487
|
+
union
|
|
488
|
+
|
|
489
|
+
| \- | Set object |
|
|
490
|
+
| noGutter |
|
|
491
|
+
|
|
492
|
+
Removes bottom margin from last child of the text element if true.
|
|
493
|
+
|
|
494
|
+
boolean
|
|
495
|
+
|
|
496
|
+
| \- | Set boolean |
|
|
497
|
+
| variant |
|
|
498
|
+
|
|
499
|
+
The typographic style to be rendered.
|
|
500
|
+
|
|
501
|
+
union
|
|
502
|
+
|
|
503
|
+
| \- | Set object |
|
|
504
|
+
|
|
505
|
+
Headings
|
|
506
|
+
--------
|
|
464
507
|
|
|
465
508
|
Headings form the structure of a web page. They're designed to stand out visually, drawing a user's eye to distinct sections of the document. They can be set in a variety of sizes based on systematic font sizing with native heading scales (H1-H6).
|
|
466
509
|
|
|
510
|
+
[](./iframe.html?id=foundations-typography--headings)
|
|
511
|
+
|
|
467
512
|
Hello, we are a company that puts clients first.
|
|
468
513
|
================================================
|
|
469
514
|
|
|
@@ -479,9 +524,7 @@ Hello, we are a company that puts clients first.
|
|
|
479
524
|
An H2 styled as an H3.
|
|
480
525
|
----------------------
|
|
481
526
|
|
|
482
|
-
Hide
|
|
483
|
-
|
|
484
|
-
\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
|
|
527
|
+
Hide codedrawOpen in CodeSandbox
|
|
485
528
|
|
|
486
529
|
<IressStack gutter\="md"\>
|
|
487
530
|
<IressText element\="h1"\>
|
|
@@ -501,14 +544,66 @@ Hide code
|
|
|
501
544
|
An H2 styled as an H3. </IressText\>
|
|
502
545
|
</IressStack\>
|
|
503
546
|
|
|
504
|
-
|
|
547
|
+
```
|
|
505
548
|
|
|
506
|
-
|
|
507
|
-
|
|
549
|
+
#### Props
|
|
550
|
+
|
|
551
|
+
| Name | Description | Default | Control |
|
|
552
|
+
| --- | --- | --- | --- |
|
|
553
|
+
| align |
|
|
554
|
+
Text alignment.
|
|
555
|
+
|
|
556
|
+
union
|
|
557
|
+
|
|
558
|
+
| \- | Set object |
|
|
559
|
+
| children |
|
|
560
|
+
|
|
561
|
+
The content to be rendered; can be a string or a ReactNode (e.g. IressIcon).
|
|
562
|
+
|
|
563
|
+
union
|
|
564
|
+
|
|
565
|
+
| \- | \- |
|
|
566
|
+
| element |
|
|
567
|
+
|
|
568
|
+
The HTML element that should be rendered.
|
|
569
|
+
|
|
570
|
+
union
|
|
571
|
+
|
|
572
|
+
|
|
|
573
|
+
|
|
574
|
+
'div'
|
|
575
|
+
|
|
576
|
+
| Set object |
|
|
577
|
+
| mode |
|
|
578
|
+
|
|
579
|
+
Allows control of the text color.
|
|
580
|
+
|
|
581
|
+
**Note**: The body mode has been deprecated and will be removed in a future version. Please use the body variant instead.
|
|
582
|
+
|
|
583
|
+
union
|
|
584
|
+
|
|
585
|
+
| \- | Set object |
|
|
586
|
+
| noGutter |
|
|
587
|
+
|
|
588
|
+
Removes bottom margin from last child of the text element if true.
|
|
589
|
+
|
|
590
|
+
boolean
|
|
591
|
+
|
|
592
|
+
| \- | Set boolean |
|
|
593
|
+
| variant |
|
|
594
|
+
|
|
595
|
+
The typographic style to be rendered.
|
|
596
|
+
|
|
597
|
+
union
|
|
598
|
+
|
|
599
|
+
| \- | Set object |
|
|
600
|
+
|
|
601
|
+
Display
|
|
602
|
+
-------
|
|
508
603
|
|
|
509
604
|
Display text is used to draw attention to specific pieces of content, like introductory text on a landing page. It has larger font sizes than the heading variants, and a lighter font weight.
|
|
510
605
|
|
|
511
|
-
|
|
606
|
+
[](./iframe.html?id=foundations-typography--display)
|
|
512
607
|
|
|
513
608
|
Hello, we are a company that puts clients first.
|
|
514
609
|
|
|
@@ -516,9 +611,9 @@ Hello, we are a company that puts clients first.
|
|
|
516
611
|
|
|
517
612
|
Hello, we are a company that puts clients first.
|
|
518
613
|
|
|
519
|
-
|
|
614
|
+
Hello, we are a company that puts clients first.
|
|
520
615
|
|
|
521
|
-
|
|
616
|
+
Hide codedrawOpen in CodeSandbox
|
|
522
617
|
|
|
523
618
|
<IressStack gutter\="md"\>
|
|
524
619
|
<IressText variant\="display1"\>
|
|
@@ -531,18 +626,70 @@ Hide code
|
|
|
531
626
|
Hello, we are a company that puts clients first. </IressText\>
|
|
532
627
|
</IressStack\>
|
|
533
628
|
|
|
534
|
-
|
|
629
|
+
```
|
|
535
630
|
|
|
536
|
-
|
|
537
|
-
|
|
631
|
+
#### Props
|
|
632
|
+
|
|
633
|
+
| Name | Description | Default | Control |
|
|
634
|
+
| --- | --- | --- | --- |
|
|
635
|
+
| align |
|
|
636
|
+
Text alignment.
|
|
637
|
+
|
|
638
|
+
union
|
|
639
|
+
|
|
640
|
+
| \- | Set object |
|
|
641
|
+
| children |
|
|
642
|
+
|
|
643
|
+
The content to be rendered; can be a string or a ReactNode (e.g. IressIcon).
|
|
644
|
+
|
|
645
|
+
union
|
|
646
|
+
|
|
647
|
+
| \- | \- |
|
|
648
|
+
| element |
|
|
649
|
+
|
|
650
|
+
The HTML element that should be rendered.
|
|
651
|
+
|
|
652
|
+
union
|
|
653
|
+
|
|
654
|
+
|
|
|
655
|
+
|
|
656
|
+
'div'
|
|
657
|
+
|
|
658
|
+
| Set object |
|
|
659
|
+
| mode |
|
|
660
|
+
|
|
661
|
+
Allows control of the text color.
|
|
662
|
+
|
|
663
|
+
**Note**: The body mode has been deprecated and will be removed in a future version. Please use the body variant instead.
|
|
664
|
+
|
|
665
|
+
union
|
|
666
|
+
|
|
667
|
+
| \- | Set object |
|
|
668
|
+
| noGutter |
|
|
669
|
+
|
|
670
|
+
Removes bottom margin from last child of the text element if true.
|
|
671
|
+
|
|
672
|
+
boolean
|
|
673
|
+
|
|
674
|
+
| \- | Set boolean |
|
|
675
|
+
| variant |
|
|
676
|
+
|
|
677
|
+
The typographic style to be rendered.
|
|
678
|
+
|
|
679
|
+
union
|
|
680
|
+
|
|
681
|
+
| \- | Set object |
|
|
682
|
+
|
|
683
|
+
Lead
|
|
684
|
+
----
|
|
538
685
|
|
|
539
686
|
Lead text is used to introduce users to a new section, and often gives a brief summary of a section. It has a larger font size than body text, but a lighter font weight so that it doesn't clash with headings.
|
|
540
687
|
|
|
541
|
-
|
|
688
|
+
[](./iframe.html?id=foundations-typography--lead)
|
|
542
689
|
|
|
543
|
-
|
|
690
|
+
Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita.
|
|
544
691
|
|
|
545
|
-
|
|
692
|
+
Hide codedrawOpen in CodeSandbox
|
|
546
693
|
|
|
547
694
|
<IressText
|
|
548
695
|
element\="p"
|
|
@@ -551,27 +698,151 @@ Hide code
|
|
|
551
698
|
Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita.
|
|
552
699
|
</IressText\>
|
|
553
700
|
|
|
554
|
-
|
|
701
|
+
```
|
|
555
702
|
|
|
556
|
-
|
|
557
|
-
|
|
703
|
+
#### Props
|
|
704
|
+
|
|
705
|
+
| Name | Description | Default | Control |
|
|
706
|
+
| --- | --- | --- | --- |
|
|
707
|
+
| align |
|
|
708
|
+
Text alignment.
|
|
709
|
+
|
|
710
|
+
union
|
|
711
|
+
|
|
712
|
+
| \- | Set object |
|
|
713
|
+
| children |
|
|
714
|
+
|
|
715
|
+
The content to be rendered; can be a string or a ReactNode (e.g. IressIcon).
|
|
716
|
+
|
|
717
|
+
union
|
|
718
|
+
|
|
719
|
+
| \- |
|
|
720
|
+
|
|
721
|
+
"Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita."
|
|
722
|
+
|
|
723
|
+
|
|
|
724
|
+
| element |
|
|
725
|
+
|
|
726
|
+
The HTML element that should be rendered.
|
|
727
|
+
|
|
728
|
+
union
|
|
729
|
+
|
|
730
|
+
|
|
|
731
|
+
|
|
732
|
+
'div'
|
|
733
|
+
|
|
734
|
+
|
|
|
735
|
+
|
|
736
|
+
"p"
|
|
737
|
+
|
|
738
|
+
|
|
|
739
|
+
| mode |
|
|
740
|
+
|
|
741
|
+
Allows control of the text color.
|
|
742
|
+
|
|
743
|
+
**Note**: The body mode has been deprecated and will be removed in a future version. Please use the body variant instead.
|
|
744
|
+
|
|
745
|
+
union
|
|
746
|
+
|
|
747
|
+
| \- | Set object |
|
|
748
|
+
| noGutter |
|
|
749
|
+
|
|
750
|
+
Removes bottom margin from last child of the text element if true.
|
|
751
|
+
|
|
752
|
+
boolean
|
|
753
|
+
|
|
754
|
+
| \- | Set boolean |
|
|
755
|
+
| variant |
|
|
756
|
+
|
|
757
|
+
The typographic style to be rendered.
|
|
758
|
+
|
|
759
|
+
union
|
|
760
|
+
|
|
761
|
+
| \- |
|
|
762
|
+
|
|
763
|
+
"lead"
|
|
764
|
+
|
|
765
|
+
|
|
|
766
|
+
|
|
767
|
+
Caption
|
|
768
|
+
-------
|
|
558
769
|
|
|
559
770
|
The caption variant is used for small text that provides additional information about a table or image. It has a smaller font size than body text, and a lighter font weight.
|
|
560
771
|
|
|
561
|
-
|
|
772
|
+
[](./iframe.html?id=foundations-typography--caption)
|
|
562
773
|
|
|
563
|
-
|
|
774
|
+
Example caption
|
|
564
775
|
|
|
565
|
-
|
|
776
|
+
Hide codedrawOpen in CodeSandbox
|
|
566
777
|
|
|
567
778
|
<IressText element\="caption"\>
|
|
568
779
|
Example caption
|
|
569
780
|
</IressText\>
|
|
570
781
|
|
|
571
|
-
|
|
782
|
+
```
|
|
783
|
+
|
|
784
|
+
#### Props
|
|
785
|
+
|
|
786
|
+
| Name | Description | Default | Control |
|
|
787
|
+
| --- | --- | --- | --- |
|
|
788
|
+
| align |
|
|
789
|
+
Text alignment.
|
|
790
|
+
|
|
791
|
+
union
|
|
792
|
+
|
|
793
|
+
| \- | Set object |
|
|
794
|
+
| children |
|
|
795
|
+
|
|
796
|
+
The content to be rendered; can be a string or a ReactNode (e.g. IressIcon).
|
|
797
|
+
|
|
798
|
+
union
|
|
799
|
+
|
|
800
|
+
| \- |
|
|
801
|
+
|
|
802
|
+
"Example caption"
|
|
803
|
+
|
|
804
|
+
|
|
|
805
|
+
| element |
|
|
806
|
+
|
|
807
|
+
The HTML element that should be rendered.
|
|
808
|
+
|
|
809
|
+
union
|
|
810
|
+
|
|
811
|
+
|
|
|
812
|
+
|
|
813
|
+
'div'
|
|
814
|
+
|
|
815
|
+
|
|
|
816
|
+
|
|
817
|
+
"caption"
|
|
818
|
+
|
|
819
|
+
|
|
|
820
|
+
| mode |
|
|
821
|
+
|
|
822
|
+
Allows control of the text color.
|
|
823
|
+
|
|
824
|
+
**Note**: The body mode has been deprecated and will be removed in a future version. Please use the body variant instead.
|
|
825
|
+
|
|
826
|
+
union
|
|
572
827
|
|
|
573
|
-
|
|
574
|
-
|
|
828
|
+
| \- | Set object |
|
|
829
|
+
| noGutter |
|
|
830
|
+
|
|
831
|
+
Removes bottom margin from last child of the text element if true.
|
|
832
|
+
|
|
833
|
+
boolean
|
|
834
|
+
|
|
835
|
+
| \- | Set boolean |
|
|
836
|
+
| variant |
|
|
837
|
+
|
|
838
|
+
The typographic style to be rendered.
|
|
839
|
+
|
|
840
|
+
union
|
|
841
|
+
|
|
842
|
+
| \- | Set object |
|
|
843
|
+
|
|
844
|
+
Other variants
|
|
845
|
+
--------------
|
|
575
846
|
|
|
576
847
|
IDS also includes bold, italic and small text variants.
|
|
577
848
|
|
|
@@ -580,6 +851,8 @@ IDS also includes bold, italic and small text variants.
|
|
|
580
851
|
* Small text is used for side comments or for text that's secondary to the main content.
|
|
581
852
|
* Muted text is used to de-emphasise content, such as when displaying informative text that is not critical to the user experience.
|
|
582
853
|
|
|
854
|
+
[](./iframe.html?id=foundations-typography--other)
|
|
855
|
+
|
|
583
856
|
Bold text
|
|
584
857
|
|
|
585
858
|
Italic text
|
|
@@ -588,9 +861,7 @@ Small text
|
|
|
588
861
|
|
|
589
862
|
Muted text
|
|
590
863
|
|
|
591
|
-
Hide
|
|
592
|
-
|
|
593
|
-
\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
|
|
864
|
+
Hide codedrawOpen in CodeSandbox
|
|
594
865
|
|
|
595
866
|
<IressStack gutter\="md"\>
|
|
596
867
|
<IressText variant\="bold"\>
|
|
@@ -603,32 +874,75 @@ Hide code
|
|
|
603
874
|
Muted text </IressText\>
|
|
604
875
|
</IressStack\>
|
|
605
876
|
|
|
606
|
-
|
|
877
|
+
```
|
|
607
878
|
|
|
608
|
-
|
|
879
|
+
#### Props
|
|
609
880
|
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
* [Caption](#caption)
|
|
615
|
-
* [Other variants](#other-variants)
|
|
881
|
+
| Name | Description | Default | Control |
|
|
882
|
+
| --- | --- | --- | --- |
|
|
883
|
+
| align |
|
|
884
|
+
Text alignment.
|
|
616
885
|
|
|
617
|
-
|
|
886
|
+
union
|
|
618
887
|
|
|
619
|
-
|
|
620
|
-
|
|
888
|
+
| \- | Set object |
|
|
889
|
+
| children |
|
|
621
890
|
|
|
622
|
-
|
|
623
|
-
|
|
891
|
+
The content to be rendered; can be a string or a ReactNode (e.g. IressIcon).
|
|
892
|
+
|
|
893
|
+
union
|
|
894
|
+
|
|
895
|
+
| \- | \- |
|
|
896
|
+
| element |
|
|
897
|
+
|
|
898
|
+
The HTML element that should be rendered.
|
|
899
|
+
|
|
900
|
+
union
|
|
901
|
+
|
|
902
|
+
|
|
|
903
|
+
|
|
904
|
+
'div'
|
|
905
|
+
|
|
906
|
+
| Set object |
|
|
907
|
+
| mode |
|
|
908
|
+
|
|
909
|
+
Allows control of the text color.
|
|
910
|
+
|
|
911
|
+
**Note**: The body mode has been deprecated and will be removed in a future version. Please use the body variant instead.
|
|
912
|
+
|
|
913
|
+
union
|
|
914
|
+
|
|
915
|
+
| \- | Set object |
|
|
916
|
+
| noGutter |
|
|
917
|
+
|
|
918
|
+
Removes bottom margin from last child of the text element if true.
|
|
919
|
+
|
|
920
|
+
boolean
|
|
921
|
+
|
|
922
|
+
| \- | Set boolean |
|
|
923
|
+
| variant |
|
|
924
|
+
|
|
925
|
+
The typographic style to be rendered.
|
|
926
|
+
|
|
927
|
+
union
|
|
928
|
+
|
|
929
|
+
| \- | Set object |
|
|
930
|
+
|
|
931
|
+
## React components / Visual Design
|
|
932
|
+
|
|
933
|
+
Visual Design Standards
|
|
934
|
+
=======================
|
|
935
|
+
|
|
936
|
+
Typography
|
|
937
|
+
----------
|
|
624
938
|
|
|
625
939
|
* Use systematic font sizing with heading scales (H1-H6)
|
|
626
940
|
* Implement consistent line heights and font weights
|
|
627
941
|
* Provide text colour hierarchies (primary, muted, success, warning, danger)
|
|
628
942
|
* Support responsive typography scaling
|
|
629
943
|
|
|
630
|
-
|
|
631
|
-
|
|
944
|
+
Colour System
|
|
945
|
+
-------------
|
|
632
946
|
|
|
633
947
|
* Maintain semantic colour meanings:
|
|
634
948
|
* **Primary**: Main call-to-action colour with high contrast
|
|
@@ -640,36 +954,29 @@ On this page
|
|
|
640
954
|
* Ensure all colour combinations meet accessibility contrast requirements
|
|
641
955
|
* Provide consistent hover and active state colours
|
|
642
956
|
|
|
643
|
-
|
|
644
|
-
|
|
957
|
+
Spacing and Layout
|
|
958
|
+
------------------
|
|
645
959
|
|
|
646
960
|
* Use systematic spacing scale (xs, sm, md, lg, xl)
|
|
647
961
|
* Apply consistent gutter systems for layout components
|
|
648
962
|
* Implement responsive breakpoints for adaptive layouts
|
|
649
963
|
* Maintain proper margin and padding relationships
|
|
650
964
|
|
|
651
|
-
|
|
652
|
-
|
|
965
|
+
Interactive States
|
|
966
|
+
------------------
|
|
653
967
|
|
|
654
968
|
* Provide clear hover, focus, active, and disabled states
|
|
655
969
|
* Use consistent transition timing and easing
|
|
656
970
|
* Implement proper focus indicators for keyboard navigation
|
|
657
971
|
* Show loading states for asynchronous operations
|
|
658
972
|
|
|
659
|
-
|
|
973
|
+
## React components / Consistency
|
|
660
974
|
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
* [Spacing and Layout](#spacing-and-layout)
|
|
664
|
-
* [Interactive States](#interactive-states)
|
|
665
|
-
|
|
666
|
-
## Consistency
|
|
667
|
-
|
|
668
|
-
[](#using-components-consistently)Using components consistently
|
|
669
|
-
===============================================================
|
|
975
|
+
Using components consistently
|
|
976
|
+
=============================
|
|
670
977
|
|
|
671
|
-
|
|
672
|
-
|
|
978
|
+
Buttons
|
|
979
|
+
-------
|
|
673
980
|
|
|
674
981
|
* **Primary**: Limit to one per view for main call-to-action
|
|
675
982
|
* **Secondary**: Use for secondary actions
|
|
@@ -678,135 +985,112 @@ On this page
|
|
|
678
985
|
* **Danger**: Destructive actions requiring extra confirmation
|
|
679
986
|
* **Positive/Negative**: Financial transactions (buy/sell)
|
|
680
987
|
|
|
681
|
-
|
|
682
|
-
|
|
988
|
+
Forms
|
|
989
|
+
-----
|
|
683
990
|
|
|
684
991
|
* Always use `IressField` wrapper for proper label, hint, and error placement
|
|
685
992
|
* Provide clear validation feedback with appropriate error messages
|
|
686
993
|
* Use consistent input sizing based on expected content length
|
|
687
994
|
* Implement proper form state management and accessibility
|
|
688
995
|
|
|
689
|
-
|
|
690
|
-
|
|
996
|
+
Navigation
|
|
997
|
+
----------
|
|
691
998
|
|
|
692
999
|
* Use semantic HTML5 navigation elements
|
|
693
1000
|
* Provide skip links for keyboard users
|
|
694
1001
|
* Implement proper ARIA labelling for navigation sections
|
|
695
1002
|
* Ensure consistent navigation patterns across applications
|
|
696
1003
|
|
|
697
|
-
|
|
698
|
-
|
|
1004
|
+
Data Display
|
|
1005
|
+
------------
|
|
699
1006
|
|
|
700
1007
|
* Use semantic table structures with proper headers
|
|
701
1008
|
* Provide clear visual hierarchy in data presentations
|
|
702
1009
|
* Implement consistent sorting and filtering patterns
|
|
703
1010
|
* Use appropriate loading states for data-heavy components
|
|
704
1011
|
|
|
705
|
-
|
|
706
|
-
|
|
1012
|
+
Modals and Overlays
|
|
1013
|
+
-------------------
|
|
707
1014
|
|
|
708
1015
|
* Reserve modals for critical tasks requiring full attention
|
|
709
1016
|
* Provide multiple dismissal methods (backdrop, escape key, close button)
|
|
710
1017
|
* Implement proper focus management and restoration
|
|
711
1018
|
* Use slideouts for supplementary tasks where underlying content needs visibility
|
|
712
1019
|
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
* [Buttons](#buttons)
|
|
716
|
-
* [Forms](#forms)
|
|
717
|
-
* [Navigation](#navigation)
|
|
718
|
-
* [Data Display](#data-display)
|
|
719
|
-
* [Modals and Overlays](#modals-and-overlays)
|
|
1020
|
+
## React components / Content
|
|
720
1021
|
|
|
721
|
-
|
|
1022
|
+
Content
|
|
1023
|
+
=======
|
|
722
1024
|
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
[](#microcopy-guidelines)Microcopy Guidelines
|
|
727
|
-
---------------------------------------------
|
|
1025
|
+
Microcopy Guidelines
|
|
1026
|
+
--------------------
|
|
728
1027
|
|
|
729
1028
|
* Use clear, concise language that matches user mental models
|
|
730
1029
|
* Provide helpful error messages with actionable guidance
|
|
731
1030
|
* Implement consistent tone of voice across all interface text
|
|
732
1031
|
* Use progressive disclosure for complex information
|
|
733
1032
|
|
|
734
|
-
|
|
735
|
-
|
|
1033
|
+
Iconography
|
|
1034
|
+
-----------
|
|
736
1035
|
|
|
737
1036
|
* Use icons consistently with established meanings
|
|
738
1037
|
* Provide screen reader text for meaningful icons
|
|
739
1038
|
* Avoid using icons as the sole means of communication
|
|
740
1039
|
* Maintain consistent icon sizing and alignment
|
|
741
1040
|
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
* [Microcopy Guidelines](#microcopy-guidelines)
|
|
745
|
-
* [Iconography](#iconography)
|
|
746
|
-
|
|
747
|
-
## User Experience
|
|
1041
|
+
## React components / User Experience
|
|
748
1042
|
|
|
749
|
-
|
|
750
|
-
|
|
1043
|
+
User experience
|
|
1044
|
+
===============
|
|
751
1045
|
|
|
752
1046
|
We use heuristic guidelines to assess the usability and user-centred design quality of all Iress products.
|
|
753
1047
|
|
|
754
|
-
|
|
755
|
-
|
|
1048
|
+
System Feedback
|
|
1049
|
+
---------------
|
|
756
1050
|
|
|
757
1051
|
* Always show users where they are, what just happened, and what’s possible next.
|
|
758
1052
|
* Provide immediate visual and textual feedback for all actions and states.
|
|
759
1053
|
* Ensure feedback is clear, contextual, and proportionate to the importance of the action.
|
|
760
1054
|
|
|
761
|
-
|
|
762
|
-
|
|
1055
|
+
Language and Mental Models
|
|
1056
|
+
--------------------------
|
|
763
1057
|
|
|
764
1058
|
* Use user-centred language and avoid technical jargon.
|
|
765
1059
|
* Follow cultural and industry conventions for colour, iconography, terminology, and layout.
|
|
766
1060
|
* Align interaction patterns with real-world analogues wherever feasible.
|
|
767
1061
|
|
|
768
|
-
|
|
769
|
-
|
|
1062
|
+
Control and Forgiveness
|
|
1063
|
+
-----------------------
|
|
770
1064
|
|
|
771
1065
|
* Make actions reversible and provide undo where errors may occur.
|
|
772
1066
|
* Let users easily backtrack, edit inputs, or abandon flows.
|
|
773
1067
|
* Provide escape hatches from any process without penalty.
|
|
774
1068
|
|
|
775
|
-
|
|
776
|
-
|
|
1069
|
+
Standards and Consistency
|
|
1070
|
+
-------------------------
|
|
777
1071
|
|
|
778
1072
|
* Use consistent layout, labelling, iconography, and grammar.
|
|
779
1073
|
* Reinforce expectations by placing similar elements in predictable positions.
|
|
780
1074
|
* Apply colour, spacing, and visual patterns consistently across all screens.
|
|
781
1075
|
|
|
782
|
-
|
|
783
|
-
|
|
1076
|
+
Error Prevention and Recovery
|
|
1077
|
+
-----------------------------
|
|
784
1078
|
|
|
785
1079
|
* Prevent errors by anticipating misuse and validating early.
|
|
786
1080
|
* Phrase error messages with clarity, empathy, and constructive suggestions.
|
|
787
1081
|
* Where errors occur, explain why and how they can be resolved.
|
|
788
1082
|
|
|
789
|
-
|
|
790
|
-
|
|
1083
|
+
Recognition Over Recall
|
|
1084
|
+
-----------------------
|
|
791
1085
|
|
|
792
1086
|
* Display necessary information at the point of decision.
|
|
793
1087
|
* Use visual grouping, spacing, and affordance to reveal hierarchy.
|
|
794
1088
|
* Prioritise visual clarity over novelty.
|
|
795
1089
|
|
|
796
|
-
|
|
797
|
-
|
|
1090
|
+
Simplicity and Minimalism
|
|
1091
|
+
-------------------------
|
|
798
1092
|
|
|
799
1093
|
* Remove unnecessary detail—every word, element, or feature should earn its place.
|
|
800
1094
|
* Design for clarity of purpose with visually distinct, semantically meaningful UI components.
|
|
801
1095
|
* Use whitespace, clean alignment, and simplified flows to reduce cognitive load.
|
|
802
1096
|
|
|
803
|
-
On this page
|
|
804
|
-
|
|
805
|
-
* [System Feedback](#system-feedback)
|
|
806
|
-
* [Language and Mental Models](#language-and-mental-models)
|
|
807
|
-
* [Control and Forgiveness](#control-and-forgiveness)
|
|
808
|
-
* [Standards and Consistency](#standards-and-consistency)
|
|
809
|
-
* [Error Prevention and Recovery](#error-prevention-and-recovery)
|
|
810
|
-
* [Recognition Over Recall](#recognition-over-recall)
|
|
811
|
-
* [Simplicity and Minimalism](#simplicity-and-minimalism)
|
|
812
|
-
|