@codecademy/styleguide 78.5.5-alpha.7e2d80.0 → 78.5.5-alpha.86116a.0

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.
@@ -2,7 +2,6 @@ export * from './ImageWrapper';
2
2
  export * from './TokenTable';
3
3
  export * from './Headers';
4
4
  export * from './Elements/Callout';
5
- export * from './Elements/KeyboardKey';
6
5
  export * from './Elements/Markdown';
7
6
  export * from './Elements/ImageGallery';
8
7
  export * from './Scales/ColorScale';
package/CHANGELOG.md CHANGED
@@ -3,7 +3,7 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
- ### [78.5.5-alpha.7e2d80.0](https://github.com/Codecademy/gamut/compare/@codecademy/styleguide@78.5.4...@codecademy/styleguide@78.5.5-alpha.7e2d80.0) (2026-01-06)
6
+ ### [78.5.5-alpha.86116a.0](https://github.com/Codecademy/gamut/compare/@codecademy/styleguide@78.5.4...@codecademy/styleguide@78.5.5-alpha.86116a.0) (2026-01-06)
7
7
 
8
8
  **Note:** Version bump only for package @codecademy/styleguide
9
9
 
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@codecademy/styleguide",
3
3
  "description": "Styleguide & Component library for codecademy.com",
4
- "version": "78.5.5-alpha.7e2d80.0",
4
+ "version": "78.5.5-alpha.86116a.0",
5
5
  "author": "Codecademy Engineering",
6
6
  "license": "MIT",
7
7
  "publishConfig": {
8
8
  "access": "public"
9
9
  },
10
10
  "repository": "git@github.com:Codecademy/gamut.git",
11
- "gitHead": "32955354e4424e7ed406926d63c1e4dbe253318f"
11
+ "gitHead": "40580b721fdf4aecae402662ba002deedcceb4eb"
12
12
  }
@@ -69,6 +69,12 @@ A field can include <LinkTo id="Molecules/Tips/InfoTip"> our existing `InfoTip`<
69
69
 
70
70
  <Canvas of={FormGroupStories.HighEmphasisInfoTip} />
71
71
 
72
+ #### Accessibility
73
+
74
+ InfoTip buttons are automatically labelled by string field labels for accessibility.
75
+
76
+ <Canvas of={FormGroupStories.InfoTipAutoLabelling} />
77
+
72
78
  ## Playground
73
79
 
74
80
  <Canvas sourceState="shown" of={FormGroupStories.Default} />
@@ -97,3 +97,14 @@ export const HighEmphasisInfoTip: Story = {
97
97
  children: <Input />,
98
98
  },
99
99
  };
100
+
101
+ export const InfoTipAutoLabelling: Story = {
102
+ args: {
103
+ label: 'Email address',
104
+ htmlFor: 'auto-label-input',
105
+ infotip: {
106
+ info: 'We will never share your email with third parties.',
107
+ },
108
+ children: <Input htmlFor="auto-label-input" type="email" />,
109
+ },
110
+ };
@@ -1,6 +1,6 @@
1
1
  import { Canvas, Controls, Meta } from '@storybook/blocks';
2
2
 
3
- import { ComponentHeader, KeyboardKey } from '~styleguide/blocks';
3
+ import { ComponentHeader } from '~styleguide/blocks';
4
4
 
5
5
  import * as SkipToContentStories from './SkipToContent.stories';
6
6
 
@@ -21,10 +21,11 @@ export const parameters = {
21
21
 
22
22
  ## Usage
23
23
 
24
- Use `<SkipToContent />` to add a hidden-by-default link that becomes visible when the user <KeyboardKey>Tab</KeyboardKey>s over it (gives it focus).
24
+ Use `<SkipToContent />` to add a hidden-by-default link that becomes visible when the user <kbd>Tab</kbd>s over it (gives it focus).
25
25
  It takes in the ID of the element it will scroll to and focus ([dev.to article explaining why](https://dev.to/robdodson/managing-focus-64l)) on click (via mouse or keyboard).
26
26
 
27
- This type of control is necessary for pages that have a bunch of stuff keyboard users would have to <KeyboardKey>Tab</KeyboardKey> through to get to the page's main content (like navigations).
27
+ This type of control is necessary for pages that have a bunch of stuff keyboard users would have to Tab through to get
28
+ to the page's main content (like navigations).
28
29
 
29
30
  For this element to work properly, there must be a `<SkipToContentTarget />` component with the id passed into this component for the `contentId` prop. The `<SkipToContentTarget />` component by default has a `tabIndex` of -1.
30
31
  Example:
@@ -42,7 +43,7 @@ Example:
42
43
  </div>
43
44
  ```
44
45
 
45
- To see it, keep pressing <KeyboardKey>Tab</KeyboardKey> around on this page or visit [the catalog](https://www.codecademy.com/catalog/language/javascript) and navigate via <KeyboardKey>Tab</KeyboardKey> to see it in action.
46
+ To see it, keep tabbing around on this page or visit [the catalog](https://www.codecademy.com/catalog/language/javascript) and navigate via tab to see it in action.
46
47
 
47
48
  ## Playground
48
49
 
@@ -1,6 +1,6 @@
1
1
  import { Canvas, Controls, Meta } from '@storybook/blocks';
2
2
 
3
- import { ComponentHeader, KeyboardKey, LinkTo } from '~styleguide/blocks';
3
+ import { ComponentHeader, LinkTo } from '~styleguide/blocks';
4
4
 
5
5
  import * as FlyoutStories from './Flyout.stories';
6
6
 
@@ -25,7 +25,7 @@ export const parameters = {
25
25
 
26
26
  ## Usage
27
27
 
28
- On button click, a container animates in from the left or right side of the window. Flyout can be configured to close by pressing the "X" close icon, pressing the <KeyboardKey>Esc</KeyboardKey> key, and/or clicking outside of the container.
28
+ On button click, a container animates in from the left or right side of the window. Flyout can be configured to close by pressing the X close icon, pressing they “esc” key, and/or clicking outside of the container.
29
29
 
30
30
  Internally, Flyout is a combination of <LinkTo id="Molecules/Modals/Overlay">Overlay</LinkTo> and <LinkTo id="Atoms/Drawer">Drawer</LinkTo>.
31
31
 
@@ -1,6 +1,6 @@
1
1
  import { Canvas, Controls, Meta } from '@storybook/blocks';
2
2
 
3
- import { ComponentHeader, KeyboardKey } from '~styleguide/blocks';
3
+ import { ComponentHeader } from '~styleguide/blocks';
4
4
 
5
5
  import * as ModalStories from './Modal.stories';
6
6
 
@@ -77,7 +77,7 @@ If the close button is hidden, you will need to create a custom way to close the
77
77
  Other than creating buttons that can close the Modal, there are other ways a Modal can be closed by the user.
78
78
 
79
79
  1. Clicking the content outside of the Modal
80
- 2. Pressing the <KeyboardKey>Esc</KeyboardKey> key on their keyboard
80
+ 2. Clicking the escape key on their keyboard
81
81
 
82
82
  All of these methods default to `true` for accessibility reasons, and rely on setting the required `onRequestClose` prop and making sure it toggles the `isOpen` prop on the Modal.
83
83
 
@@ -1,6 +1,6 @@
1
1
  import { Canvas, Controls, Meta } from '@storybook/blocks';
2
2
 
3
- import { ComponentHeader, KeyboardKey, LinkTo } from '~styleguide/blocks';
3
+ import { ComponentHeader, LinkTo } from '~styleguide/blocks';
4
4
 
5
5
  import * as TabStories from './Tabs.stories';
6
6
 
@@ -67,7 +67,7 @@ It is recommended to add a unique `aria-label` to the `TabNav` component, to dif
67
67
 
68
68
  ### Tabs with interactive content
69
69
 
70
- Normally, when you navigate to the contents of a `TabPanel` using the <KeyboardKey>Tab</KeyboardKey> key or arrow keys, the entire section of the `TabPanel` will be in focus.
70
+ Normally, when you navigate to the contents of a `TabPanel` using the <kbd>tab</kbd> key or arrow keys, the entire section of the `TabPanel` will be in focus.
71
71
 
72
72
  However, if you have tabs with interactive content within them (such as a button or link), and tab into the `TabPanel`, the focus will be on the interactive content and not the entirety of the `TabPanel`.
73
73
 
@@ -1,6 +1,6 @@
1
1
  import { Canvas, Controls, Meta } from '@storybook/blocks';
2
2
 
3
- import { ComponentHeader, KeyboardKey } from '~styleguide/blocks';
3
+ import { ComponentHeader } from '~styleguide/blocks';
4
4
 
5
5
  import * as InfoTipStories from './InfoTip.stories';
6
6
 
@@ -25,11 +25,10 @@ export const parameters = {
25
25
 
26
26
  ## Usage
27
27
 
28
- A tip is triggered by clicking on an information icon button and can be closed by clicking outside, pressing <KeyboardKey>Esc</KeyboardKey>, or clicking the info button again.
28
+ A tip is triggered by clicking on an information icon button and can be closed by clicking outside, pressing <kbd>Esc</kbd>, or clicking the info button again.
29
29
 
30
30
  Use an infotip to provide additional info about a nearby element or content.
31
-
32
- Infotip consists of an icon button and the .tip-bg subcomponent. The info button has low and high emphasis variants and the `.tip` has 4 alignment variants.
31
+ The info button has low and high emphasis variants and the `Tip` has 4 alignment variants.
33
32
 
34
33
  ## Variants
35
34
 
@@ -57,17 +56,19 @@ This `floating` variant should only be used as needed.
57
56
 
58
57
  ### InfoTips with links or buttons
59
58
 
60
- Links or buttons within InfoTips should be used sparingly and only when the information is critical to the user's understanding of the content. If an infotip _absolutely requires_ a link or button, it needs to provide a programmatic focus by way of the `onClick` prop. The `onClick` prop accepts a function that can accept an `{isTipHidden}` argument and using that you can set programmatic focus as needed.
59
+ Links or buttons within InfoTips should be used sparingly and only when the information is critical to the user's understanding of the content. When an InfoTip opens, focus automatically moves to the tip content, allowing keyboard users to immediately interact with any links or buttons inside.
61
60
 
62
61
  <Canvas of={InfoTipStories.WithLinksOrButtons} />
63
62
 
64
- ### Floating placement
63
+ ### Automatic Focus Management
65
64
 
66
- When using `placement="floating"`, InfoTips implements focus management for easier navigation:
65
+ InfoTips automatically manage focus for optimal keyboard accessibility:
67
66
 
68
- - **<KeyboardKey>Tab</KeyboardKey>**: Navigate forward through focusable elements (links, buttons) inside the tip. When reaching the last element, wraps back to the InfoTip button for convenience
69
- - **<KeyboardKey>Shift</KeyboardKey>+<KeyboardKey>Tab</KeyboardKey>**: Navigate backward naturally through the page
70
- - **<KeyboardKey>Esc</KeyboardKey>**: Closes the tip and returns focus to the InfoTip button
67
+ - **Opening**: Focus automatically moves to the tip content when opened
68
+ - **Tab (Floating)**: Navigate forward through focusable elements (links, buttons) inside the tip. When reaching the last element, wraps back to the InfoTip button
69
+ - **Shift+Tab (Floating)**: Navigate backward naturally - from the button, exits to the previous page element
70
+ - **Tab/Shift+Tab (Inline)**: Follows normal document flow
71
+ - **Escape**: Closes the tip and returns focus to the InfoTip button
71
72
 
72
73
  <Canvas of={InfoTipStories.KeyboardNavigation} />
73
74
 
@@ -75,13 +76,28 @@ When using `placement="floating"`, InfoTips implements focus management for easi
75
76
 
76
77
  InfoTips have intelligent Escape key handling that works correctly both inside and outside Modals:
77
78
 
78
- - **InfoTips close on <KeyboardKey>Esc</KeyboardKey>** regardless of where keyboard focus is, and focus returns to the InfoTip button
79
- - **InfoTips inside Modals close first** - When an InfoTip is placed inside a Modal, pressing <KeyboardKey>Esc</KeyboardKey> closes the InfoTip while keeping the Modal open
80
- - **Layered navigation** - After closing an InfoTip inside a Modal, pressing <KeyboardKey>Esc</KeyboardKey> again closes the Modal
81
- - **Modals take priority over external InfoTips** - InfoTips detect when `dialog[open]`, `role="dialog"`, or `role="alertdialog"` elements are present and defer <KeyboardKey>Esc</KeyboardKey> handling to them when the InfoTip is outside the Modal
79
+ - **InfoTips close on Escape** regardless of where keyboard focus is, and focus returns to the InfoTip button
80
+ - **InfoTips inside Modals close first** - When an InfoTip is placed inside a Modal, pressing Escape closes the InfoTip while keeping the Modal open
81
+ - **Layered navigation** - After closing an InfoTip inside a Modal, pressing Escape again closes the Modal
82
+ - **Modals take priority over external InfoTips** - InfoTips detect when `dialog[open]`, `role="dialog"`, or `role="alertdialog"` elements are present and defer Escape handling to them when the InfoTip is outside the Modal
82
83
 
83
84
  <Canvas of={InfoTipStories.InfoTipInsideModal} />
84
85
 
86
+ ## Custom Accessible Labeling
87
+
88
+ Provide either `ariaLabel` or `ariaLabelledby` to ensure screen reader users understand the purpose of the InfoTip button.
89
+
90
+ The InfoTip button's accessible label can be customized using either prop:
91
+
92
+ - **`ariaLabel`**: Directly sets the accessible label text. Useful when you want to provide a custom label without referencing another element.
93
+ - **`ariaLabelledby`**: References the ID of another element to use as the label. Useful when you want the InfoTip button to be labeled by visible text elsewhere on the page. This is useful for when the `InfoTip` is beside text that contextualizes it.
94
+
95
+ ### Custom Role Description
96
+
97
+ The `InfoTipButton` uses [`aria-roledescription`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-roledescription) to provide additional context to screen reader users about the button's specific purpose. This defaults to `"More information button"` but can be customized via the `ariaRoleDescription` prop for translation or other accessibility needs.
98
+
99
+ <Canvas of={InfoTipStories.AriaLabel} />
100
+
85
101
  ## InfoTips and zIndex
86
102
 
87
103
  You can change the zIndex of your `InfoTip` with the zIndex property.
@@ -4,17 +4,20 @@ import {
4
4
  FillButton,
5
5
  FlexBox,
6
6
  GridBox,
7
+ IconButton,
7
8
  InfoTip,
8
9
  Modal,
9
10
  Text,
10
11
  } from '@codecademy/gamut';
12
+ import { SparkleIcon } from '@codecademy/gamut-icons';
11
13
  import type { Meta, StoryObj } from '@storybook/react';
12
- import { useRef, useState } from 'react';
14
+ import { useState } from 'react';
13
15
 
14
16
  const meta: Meta<typeof InfoTip> = {
15
17
  component: InfoTip,
16
18
  args: {
17
19
  alignment: 'top-left',
20
+ ariaLabel: 'More information',
18
21
  info: `I am additional information about a nearby element or content.`,
19
22
  },
20
23
  };
@@ -28,7 +31,10 @@ export const Emphasis: Story = {
28
31
  },
29
32
  render: (args) => (
30
33
  <FlexBox center m={24} py={64}>
31
- <Text mr={4}>Some text that needs info</Text> <InfoTip {...args} />
34
+ <Text id="emphasis-text" mr={4}>
35
+ Some text that needs info
36
+ </Text>
37
+ <InfoTip {...args} ariaLabelledby="emphasis-text" />
32
38
  </FlexBox>
33
39
  ),
34
40
  };
@@ -38,10 +44,15 @@ export const Alignments: Story = {
38
44
  <GridBox gap={24} gridTemplateColumns="1fr 1fr" ml={8} py={64}>
39
45
  {(['top-right', 'top-left', 'bottom-right', 'bottom-left'] as const).map(
40
46
  (alignment) => {
47
+ const labelId = `alignment-${alignment}`;
41
48
  return (
42
49
  <Box key={alignment}>
43
- <Text>{alignment}</Text>
44
- <InfoTip {...args} alignment={alignment} />
50
+ <Text id={labelId}>{alignment}</Text>
51
+ <InfoTip
52
+ {...args}
53
+ alignment={alignment}
54
+ ariaLabelledby={labelId}
55
+ />
45
56
  </Box>
46
57
  );
47
58
  }
@@ -56,10 +67,52 @@ export const Placement: Story = {
56
67
  },
57
68
  render: (args) => (
58
69
  <FlexBox center>
59
- <Text mr={4}>
70
+ <Text id="placement-text" mr={4}>
60
71
  This text is in a small space and needs floating placement
61
72
  </Text>{' '}
62
- <InfoTip {...args} />
73
+ <InfoTip {...args} ariaLabelledby="placement-text" />
74
+ </FlexBox>
75
+ ),
76
+ };
77
+
78
+ export const AriaLabel: Story = {
79
+ render: (args) => (
80
+ <FlexBox center column gap={24} my={48} width={1}>
81
+ <FlexBox alignItems="center" gap={8}>
82
+ <Text fontSize={16} fontWeight="bold">
83
+ Using ariaLabel (no visible label text):
84
+ </Text>
85
+ </FlexBox>
86
+ <FlexBox alignItems="center" gap={8}>
87
+ <IconButton
88
+ icon={SparkleIcon}
89
+ tip="This tool needs to be explained in the InfoTip"
90
+ tipProps={{ placement: 'floating' }}
91
+ onClick={() => null}
92
+ />
93
+ <InfoTip
94
+ {...args}
95
+ ariaLabel="Learn more about this tool"
96
+ info="This is some helpful info about the tool represented by the IconButton"
97
+ />
98
+ </FlexBox>
99
+
100
+ <FlexBox alignItems="center" gap={8}>
101
+ <Text fontSize={16} fontWeight="bold">
102
+ Using ariaLabelledby (references visible text):
103
+ </Text>
104
+ </FlexBox>
105
+ <FlexBox alignItems="center" gap={8}>
106
+ <Text id="custom-info-id">
107
+ I am some helpful yet concise text that needs more explanation
108
+ </Text>
109
+ <InfoTip
110
+ {...args}
111
+ alignment="bottom-left"
112
+ ariaLabelledby="custom-info-id"
113
+ info="I am clarifying information related to the concise text."
114
+ />
115
+ </FlexBox>
63
116
  </FlexBox>
64
117
  ),
65
118
  };
@@ -69,19 +122,16 @@ export const WithLinksOrButtons: Story = {
69
122
  placement: 'floating',
70
123
  },
71
124
  render: function WithLinksOrButtons(args) {
72
- const ref = useRef<HTMLDivElement>(null);
73
-
74
- const onClick = ({ isTipHidden }: { isTipHidden: boolean }) => {
75
- if (!isTipHidden) ref.current?.focus();
76
- };
77
-
78
125
  return (
79
126
  <FlexBox center py={64}>
80
- <Text mr={4}>This text is in a small space and needs info </Text>{' '}
127
+ <Text id="links-text" mr={4}>
128
+ This text is in a small space and needs info
129
+ </Text>{' '}
81
130
  <InfoTip
82
131
  {...args}
132
+ ariaLabelledby="links-text"
83
133
  info={
84
- <Text ref={ref} tabIndex={-1}>
134
+ <Text tabIndex={-1}>
85
135
  Hey! Here is a{' '}
86
136
  <Anchor href="https://giphy.com/search/nichijou">
87
137
  cool link
@@ -93,7 +143,6 @@ export const WithLinksOrButtons: Story = {
93
143
  that is also super important.
94
144
  </Text>
95
145
  }
96
- onClick={onClick}
97
146
  />
98
147
  </FlexBox>
99
148
  );
@@ -102,42 +151,35 @@ export const WithLinksOrButtons: Story = {
102
151
 
103
152
  export const KeyboardNavigation: Story = {
104
153
  render: function KeyboardNavigation() {
105
- const floatingRef = useRef<HTMLDivElement>(null);
106
- const inlineRef = useRef<HTMLDivElement>(null);
107
-
108
154
  const examples = [
109
155
  {
110
156
  title: 'Floating Placement',
111
157
  placement: 'floating' as const,
112
- ref: floatingRef,
113
158
  links: ['Link 1', 'Link 2', 'Link 3'],
114
159
  },
115
160
  {
116
161
  title: 'Inline Placement',
117
162
  placement: 'inline' as const,
118
163
  alignment: 'bottom-right' as const,
119
- ref: inlineRef,
120
164
  links: ['Link A', 'Link B'],
121
165
  },
122
166
  ];
123
167
 
124
168
  return (
125
- <FlexBox center column gap={24} py={64}>
169
+ <FlexBox center flexDirection="column" gap={24} py={64}>
126
170
  <GridBox gap={16} gridTemplateColumns="1fr 1fr">
127
- {examples.map(({ title, placement, alignment, ref, links }) => {
128
- const onClick = ({ isTipHidden }: { isTipHidden: boolean }) => {
129
- if (!isTipHidden) ref.current?.focus();
130
- };
131
-
171
+ {examples.map(({ title, placement, alignment, links }) => {
172
+ const labelId = `keyboard-nav-${placement}`;
132
173
  return (
133
174
  <FlexBox gap={8} key={placement}>
134
- <Text fontSize={16} fontWeight="bold">
175
+ <Text fontSize={16} fontWeight="bold" id={labelId}>
135
176
  {title}
136
177
  </Text>
137
178
  <InfoTip
138
179
  alignment={alignment}
180
+ ariaLabelledby={labelId}
139
181
  info={
140
- <Text ref={ref} tabIndex={-1}>
182
+ <Text>
141
183
  {links.map((label, idx) => (
142
184
  <>
143
185
  {idx > 0 && ', '}
@@ -150,7 +192,6 @@ export const KeyboardNavigation: Story = {
150
192
  </Text>
151
193
  }
152
194
  placement={placement}
153
- onClick={onClick}
154
195
  />
155
196
  </FlexBox>
156
197
  );
@@ -162,6 +203,10 @@ export const KeyboardNavigation: Story = {
162
203
  Keyboard Navigation:
163
204
  </Text>
164
205
  <Box as="ul" fontSize={14} pl={16}>
206
+ <li>
207
+ <strong>Opening:</strong> Focus automatically moves to the tip
208
+ content when opened
209
+ </li>
165
210
  <li>
166
211
  <strong>Floating - Tab:</strong> Navigates forward through links,
167
212
  then wraps to button (contained)
@@ -224,8 +269,10 @@ export const InfoTipInsideModal: Story = {
224
269
  <Text>This modal contains an InfoTip below:</Text>
225
270
 
226
271
  <FlexBox alignItems="center" gap={8}>
227
- <Text>Some text that needs explanation</Text>
228
- <InfoTip {...args} />
272
+ <Text id="modal-infotip-text">
273
+ Some text that needs explanation
274
+ </Text>
275
+ <InfoTip {...args} ariaLabelledby="modal-infotip-text" />
229
276
  </FlexBox>
230
277
 
231
278
  <Text color="text-disabled" fontSize={14}>
@@ -253,11 +300,14 @@ export const ZIndex: Story = {
253
300
  <Box bg="paleBlue" zIndex={3}>
254
301
  I will not be behind the infotip, sad + unreadable
255
302
  </Box>
256
- <InfoTip info="I am inline, cool" />
303
+ <InfoTip
304
+ ariaLabel="z-index example without override"
305
+ info="I am inline, cool"
306
+ />
257
307
  <Box bg="paleBlue" zIndex={3}>
258
308
  I will be behind the infotip, nice + great
259
309
  </Box>
260
- <InfoTip {...args} />
310
+ <InfoTip {...args} ariaLabel="z-index example with override" />
261
311
  </FlexBox>
262
312
  ),
263
313
  };
@@ -265,7 +315,10 @@ export const ZIndex: Story = {
265
315
  export const Default: Story = {
266
316
  render: (args) => (
267
317
  <FlexBox center m={24} py={64}>
268
- <Text mr={4}>Some text that needs info</Text> <InfoTip {...args} />
318
+ <Text id="default-text" mr={4}>
319
+ Some text that needs info
320
+ </Text>
321
+ <InfoTip {...args} ariaLabelledby="default-text" />
269
322
  </FlexBox>
270
323
  ),
271
324
  };
@@ -61,6 +61,26 @@ A `ConnectedFormGroup` can be in one of three states: `default`, `error`, or `di
61
61
 
62
62
  <Canvas of={ConnectedFormGroupStories.States} />
63
63
 
64
+ ## InfoTip
65
+
66
+ A `ConnectedFormGroup` can include an `infotip` prop to provide additional context.
67
+
68
+ ### Automatic labelling
69
+
70
+ InfoTip buttons are automatically labelled by string field labels for accessibility.
71
+
72
+ <Canvas of={ConnectedFormGroupStories.InfoTipAutoLabelling} />
73
+
74
+ ### ReactNode labels
75
+
76
+ For ReactNode labels (e.g., styled text or icons), you have three options:
77
+
78
+ - `labelledByFieldLabel: true` - opt into automatic labelling by the field label
79
+ - `ariaLabel` - provide a custom accessible name
80
+ - `ariaLabelledby` - reference another element on the page, such as a section heading
81
+
82
+ <Canvas of={ConnectedFormGroupStories.InfoTipWithReactNodeLabel} />
83
+
64
84
  ## Playground
65
85
 
66
86
  To see how a `ConnectedFormGroup` can be used in a `ConnectedForm`, check out the <LinkTo id="Organisms/ConnectedForm/ConnectedForm">ConnectedForm</LinkTo> page.
@@ -2,7 +2,9 @@ import {
2
2
  ConnectedForm,
3
3
  ConnectedFormGroup,
4
4
  ConnectedFormGroupProps,
5
+ ConnectedInput,
5
6
  ConnectedRadioGroupInput,
7
+ Text,
6
8
  useConnectedForm,
7
9
  } from '@codecademy/gamut';
8
10
  import { action } from '@storybook/addon-actions';
@@ -119,3 +121,81 @@ export const States = () => {
119
121
  </ConnectedForm>
120
122
  );
121
123
  };
124
+
125
+ /**
126
+ * InfoTip buttons are automatically labelled by string field labels for accessibility.
127
+ * Screen readers will announce "Field Label, button" when focusing the InfoTip.
128
+ */
129
+ export const InfoTipAutoLabelling: Story = {
130
+ render: () => (
131
+ <ConnectedForm
132
+ defaultValues={{ email: '' }}
133
+ onSubmit={(values) => action('Form Submitted')(values)}
134
+ >
135
+ <ConnectedFormGroup
136
+ field={{ component: ConnectedInput, type: 'email' }}
137
+ infotip={{ info: 'We will never share your email with third parties.' }}
138
+ label="Email address"
139
+ name="email"
140
+ />
141
+ </ConnectedForm>
142
+ ),
143
+ };
144
+
145
+ /**
146
+ * For ReactNode labels, you have three options for accessible InfoTip labelling:
147
+ * - `labelledByFieldLabel: true` - uses the field label
148
+ * - `ariaLabel` - provides a custom accessible name
149
+ * - `ariaLabelledby` - references another element on the page
150
+ */
151
+ export const InfoTipWithReactNodeLabel: Story = {
152
+ render: () => (
153
+ <ConnectedForm
154
+ defaultValues={{ username: '', password: '', apiKey: '' }}
155
+ onSubmit={(values) => action('Form Submitted')(values)}
156
+ >
157
+ <Text as="h3" id="api-section-heading" mb={8}>
158
+ API Configuration
159
+ </Text>
160
+ <ConnectedFormGroup
161
+ field={{ component: ConnectedInput }}
162
+ infotip={{
163
+ info: 'Choose a unique username between 3-20 characters.',
164
+ labelledByFieldLabel: true,
165
+ }}
166
+ label={
167
+ <Text as="span" fontWeight="bold">
168
+ Username (labelledByFieldLabel)
169
+ </Text>
170
+ }
171
+ name="username"
172
+ />
173
+ <ConnectedFormGroup
174
+ field={{ component: ConnectedInput, type: 'password' }}
175
+ infotip={{
176
+ info: 'Password must be at least 8 characters with one uppercase letter and one number.',
177
+ ariaLabel: 'Password requirements',
178
+ }}
179
+ label={
180
+ <Text as="span" fontWeight="bold">
181
+ Password (ariaLabel)
182
+ </Text>
183
+ }
184
+ name="password"
185
+ />
186
+ <ConnectedFormGroup
187
+ field={{ component: ConnectedInput }}
188
+ infotip={{
189
+ info: 'You can find your API key in the developer settings dashboard.',
190
+ ariaLabelledby: 'api-section-heading',
191
+ }}
192
+ label={
193
+ <Text as="span" fontWeight="bold">
194
+ API Key (ariaLabelledby)
195
+ </Text>
196
+ }
197
+ name="apiKey"
198
+ />
199
+ </ConnectedForm>
200
+ ),
201
+ };
@@ -95,3 +95,23 @@ Hidden inputs can be used to include data that users can't see or modify with th
95
95
  We call it a "sweet container" so that bots do not immediately detect it as a honeypot input.
96
96
 
97
97
  <Canvas of={FieldsStories.SweetContainer} />
98
+
99
+ ## InfoTip
100
+
101
+ Any field can include an `infotip` prop to provide additional context to users.
102
+
103
+ ### Automatic labelling
104
+
105
+ InfoTip buttons are automatically labelled by string field labels for accessibility.
106
+
107
+ <Canvas of={FieldsStories.InfoTipAutoLabelling} />
108
+
109
+ ### ReactNode labels
110
+
111
+ For ReactNode labels, you have three options:
112
+
113
+ - `labelledByFieldLabel: true` - opt into automatic labelling by the field label
114
+ - `ariaLabel` - provide a custom accessible name
115
+ - `ariaLabelledby` - reference another element on the page, such as a section heading
116
+
117
+ <Canvas of={FieldsStories.InfoTipWithReactNodeLabel} />
@@ -1,4 +1,4 @@
1
- import { FormGroup, GridForm, Input } from '@codecademy/gamut';
1
+ import { FormGroup, GridForm, Input, Text } from '@codecademy/gamut';
2
2
  import { action } from '@storybook/addon-actions';
3
3
  import type { Meta, StoryObj } from '@storybook/react';
4
4
 
@@ -328,3 +328,74 @@ export const SweetContainer: Story = {
328
328
  ],
329
329
  },
330
330
  };
331
+
332
+ /**
333
+ * InfoTip buttons are automatically labelled by string field labels for accessibility.
334
+ * Screen readers will announce "Field Label, button" when focusing the InfoTip.
335
+ */
336
+ export const InfoTipAutoLabelling: Story = {
337
+ args: {
338
+ fields: [
339
+ {
340
+ label: 'Email address',
341
+ name: 'email',
342
+ size: 9,
343
+ type: 'email',
344
+ infotip: {
345
+ info: 'We will never share your email with third parties.',
346
+ },
347
+ },
348
+ ],
349
+ },
350
+ };
351
+
352
+ /**
353
+ * For ReactNode labels, you have three options for accessible InfoTip labelling:
354
+ * - `labelledByFieldLabel: true` - uses the field label
355
+ * - `ariaLabel` - provides a custom accessible name
356
+ * - `ariaLabelledby` - references another element on the page
357
+ */
358
+ export const InfoTipWithReactNodeLabel: Story = {
359
+ render: (args) => (
360
+ <>
361
+ <Text as="h3" id="api-section-heading" mb={8}>
362
+ API Configuration
363
+ </Text>
364
+ <GridForm {...args} />
365
+ </>
366
+ ),
367
+ args: {
368
+ fields: [
369
+ {
370
+ label: <strong>Username (labelledByFieldLabel)</strong>,
371
+ name: 'username',
372
+ size: 9,
373
+ type: 'text',
374
+ infotip: {
375
+ info: 'Choose a unique username between 3-20 characters.',
376
+ labelledByFieldLabel: true,
377
+ },
378
+ },
379
+ {
380
+ label: <strong>Password (ariaLabel)</strong>,
381
+ name: 'password',
382
+ size: 9,
383
+ type: 'password',
384
+ infotip: {
385
+ info: 'Password must be at least 8 characters with one uppercase letter and one number.',
386
+ ariaLabel: 'Password requirements',
387
+ },
388
+ },
389
+ {
390
+ label: <strong>API Key (ariaLabelledby)</strong>,
391
+ name: 'apiKey',
392
+ size: 9,
393
+ type: 'text',
394
+ infotip: {
395
+ info: 'You can find your API key in the developer settings dashboard.',
396
+ ariaLabelledby: 'api-section-heading',
397
+ },
398
+ },
399
+ ],
400
+ },
401
+ };
@@ -1,17 +0,0 @@
1
- import styled from '@emotion/styled';
2
- import { css } from '@codecademy/gamut-styles';
3
-
4
- export const KeyboardKey = styled.kbd(
5
- css({
6
- mx: 2 as any,
7
- fontFamily: 'monospace',
8
- fontSize: '0.75rem' as any,
9
- bg: 'background-selected',
10
- border: 1,
11
- borderColor: 'border-tertiary',
12
- borderRadius: 'sm',
13
- px: 4,
14
- py: 2 as any,
15
- boxShadow: 'inset 0 -1px 0 rgba(0, 0, 0, 0.2)',
16
- })
17
- );