@codecademy/styleguide 79.1.4-alpha.fba948.0 → 79.1.4
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/.storybook/components/Elements/ImageGallery.tsx +1 -1
- package/CHANGELOG.md +1 -1
- package/package.json +2 -2
- package/src/lib/Atoms/Animations/ExpandInCollapseOut/ExpandInCollapseOut.stories.tsx +1 -1
- package/src/lib/Atoms/Animations/FadeInSlideOut/FadeInSlideOut.stories.tsx +1 -1
- package/src/lib/Meta/ESLint rules.mdx +1 -1
- package/src/lib/Meta/Installation.mdx +7 -30
- package/src/lib/UX Writing/Component guidelines/Confirmation dialogs.mdx +44 -26
- package/src/static/ux writing/clear_chat.png +0 -0
- package/src/static/ux writing/delete_study_plan.png +0 -0
- package/src/static/ux writing/delete_this_course.png +0 -0
|
@@ -3,7 +3,7 @@ import { GamutIconProps } from '@codecademy/gamut-icons';
|
|
|
3
3
|
import { IllustrationProps } from '@codecademy/gamut-illustrations';
|
|
4
4
|
import { PatternProps } from '@codecademy/gamut-patterns';
|
|
5
5
|
import { css, timingValues } from '@codecademy/gamut-styles';
|
|
6
|
-
import { motion, AnimatePresence } from 'motion
|
|
6
|
+
import { motion, AnimatePresence } from 'framer-motion';
|
|
7
7
|
import * as React from 'react';
|
|
8
8
|
import { useState } from 'react';
|
|
9
9
|
import styled from '@emotion/styled';
|
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
|
-
### [79.1.4
|
|
6
|
+
### [79.1.4](https://github.com/Codecademy/gamut/compare/@codecademy/styleguide@79.1.3...@codecademy/styleguide@79.1.4) (2026-03-09)
|
|
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": "79.1.4
|
|
4
|
+
"version": "79.1.4",
|
|
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": "
|
|
11
|
+
"gitHead": "d98acbdeb5f02be1c5b6592f2968300b9c0c19fe"
|
|
12
12
|
}
|
|
@@ -5,7 +5,7 @@ import {
|
|
|
5
5
|
FlexBox,
|
|
6
6
|
} from '@codecademy/gamut';
|
|
7
7
|
import type { Meta } from '@storybook/react';
|
|
8
|
-
import { AnimatePresence } from 'motion
|
|
8
|
+
import { AnimatePresence } from 'framer-motion';
|
|
9
9
|
import { PropsWithChildren, useState } from 'react';
|
|
10
10
|
|
|
11
11
|
const meta: Meta<typeof ExpandInCollapseOut> = {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Box, FadeInSlideOut, FillButton, FlexBox } from '@codecademy/gamut';
|
|
2
2
|
import type { Meta } from '@storybook/react';
|
|
3
|
-
import { AnimatePresence } from 'motion
|
|
3
|
+
import { AnimatePresence } from 'framer-motion';
|
|
4
4
|
import { useState } from 'react';
|
|
5
5
|
|
|
6
6
|
const meta: Meta<typeof FadeInSlideOut> = {
|
|
@@ -79,7 +79,7 @@ const ExpandableContainer = styled.Box(
|
|
|
79
79
|
|
|
80
80
|
#### Disabling the rule
|
|
81
81
|
|
|
82
|
-
For third-party components or edge cases where inline styles are necessary (e.g., motion animations), you can disable the rule:
|
|
82
|
+
For third-party components or edge cases where inline styles are necessary (e.g., framer-motion animations), you can disable the rule:
|
|
83
83
|
|
|
84
84
|
```tsx
|
|
85
85
|
// eslint-disable-next-line gamut/no-inline-style
|
|
@@ -39,28 +39,6 @@ yarn add @codecademy/gamut-kit @emotion/react @emotion/styled
|
|
|
39
39
|
|
|
40
40
|
3. Wrap your application root with `GamutProvider` and give it the theme you would like to use for your app.
|
|
41
41
|
|
|
42
|
-
**React 19:**
|
|
43
|
-
|
|
44
|
-
```tsx
|
|
45
|
-
import React from 'react';
|
|
46
|
-
import { createRoot } from 'react-dom/client';
|
|
47
|
-
import { GamutProvider, theme } from '@codecademy/gamut-styles';
|
|
48
|
-
|
|
49
|
-
import { App } from './App';
|
|
50
|
-
|
|
51
|
-
const rootElement = document.getElementById('root');
|
|
52
|
-
if (rootElement) {
|
|
53
|
-
const root = createRoot(rootElement);
|
|
54
|
-
root.render(
|
|
55
|
-
<GamutProvider>
|
|
56
|
-
<App />
|
|
57
|
-
</GamutProvider>
|
|
58
|
-
);
|
|
59
|
-
}
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
**React 18:**
|
|
63
|
-
|
|
64
42
|
```tsx
|
|
65
43
|
import React from 'react';
|
|
66
44
|
import { render } from 'react-dom';
|
|
@@ -69,14 +47,13 @@ import { GamutProvider, theme } from '@codecademy/gamut-styles';
|
|
|
69
47
|
import { App } from './App';
|
|
70
48
|
|
|
71
49
|
const rootElement = document.getElementById('root');
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
}
|
|
50
|
+
|
|
51
|
+
render(
|
|
52
|
+
<GamutProvider>
|
|
53
|
+
<App />
|
|
54
|
+
</GamutProvider>,
|
|
55
|
+
rootElement
|
|
56
|
+
);
|
|
80
57
|
```
|
|
81
58
|
|
|
82
59
|
GamutProvider handles a few critical tasks that need to happen in order for components to work.
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { Meta } from '@storybook/blocks';
|
|
2
2
|
|
|
3
|
-
import { AboutHeader, LinkTo } from '~styleguide/blocks';
|
|
3
|
+
import { AboutHeader, ImageWrapper, LinkTo } from '~styleguide/blocks';
|
|
4
4
|
|
|
5
5
|
export const parameters = {
|
|
6
6
|
title: 'Confirmation dialogs',
|
|
7
7
|
subtitle:
|
|
8
|
-
'
|
|
8
|
+
'Use the same verb from the triggering button, heading, to action confirmation button; clearly communicate the consequences; and keep the copy decision-focused.',
|
|
9
9
|
status: 'static',
|
|
10
10
|
design: {
|
|
11
11
|
type: 'figma',
|
|
@@ -17,39 +17,57 @@ export const parameters = {
|
|
|
17
17
|
|
|
18
18
|
<AboutHeader {...parameters} />
|
|
19
19
|
|
|
20
|
-
Confirmation
|
|
20
|
+
Confirmation dialogs use the <LinkTo id="Molecules/Modals/Dialog">Dialog component in Gamut</LinkTo> to create intentional friction to verify that a learner wants to take a high-impact action, such as:
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
- Irreversible actions (e.g., submitting payment)
|
|
23
|
+
- Loss of data, time, or work (e.g., deleting a course)
|
|
24
|
+
- Unexpected consequences (e.g., losing learning history on an existing prototype when when generating a new prototype)
|
|
25
|
+
|
|
26
|
+
Adding friction for these purposes helps improve trust and avoid unintentional actions by making sure learners clearly understand the consequences before continuing. It also lets us offer alternatives or undo options when needed.
|
|
23
27
|
|
|
24
28
|
## Best practices
|
|
25
29
|
|
|
26
|
-
###
|
|
30
|
+
### Heading
|
|
31
|
+
|
|
32
|
+
- **Ask or inform about one main action**, mirroring the button that triggered the confirmation dialog.
|
|
33
|
+
- **Frame your headline as a binary question**, when possible, with 2 unambiguous answers.
|
|
34
|
+
- **Avoid generic “Are you sure?” headings and body text.** This phrasing takes up space, increases cognitive load, and may undermine users' confidence or be interpreted as patronizing.
|
|
35
|
+
|
|
36
|
+
### Body (optional)
|
|
37
|
+
|
|
38
|
+
- **Add essential information about the contextual consequences.** State what will happen, what will be lost/changed, and any critical conditions.
|
|
39
|
+
- **Avoid redundancy.** If the heading is already self-explanatory, the body is not needed.
|
|
40
|
+
- **Keep to 1–2 lines, unless more is required to get all the information across.**
|
|
41
|
+
|
|
42
|
+
### Buttons (CTA1 and CTA2)
|
|
27
43
|
|
|
28
|
-
- **
|
|
29
|
-
- **
|
|
30
|
-
- **
|
|
44
|
+
- **Avoid using “Yes” or “No,”** as they can be misinterpreted in global English and internationalization contexts.
|
|
45
|
+
- **CTA1 matches the verb from the heading** to confirm the action.
|
|
46
|
+
- **CTA2 clarifies the alternative or undo** path.
|
|
47
|
+
- Whenever possible, be specific about the alternative. However, when space is limited, 'Cancel' can be used.
|
|
31
48
|
|
|
32
|
-
###
|
|
49
|
+
### Examples — putting it all together
|
|
33
50
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
51
|
+
<ImageWrapper
|
|
52
|
+
src="./ux writing/delete_this_course.png"
|
|
53
|
+
alt="Delete this course confirmation dialog"
|
|
54
|
+
/>
|
|
38
55
|
|
|
39
|
-
|
|
56
|
+
<ImageWrapper
|
|
57
|
+
src="./ux writing/delete_study_plan.png"
|
|
58
|
+
alt="Delete study plan confirmation dialog"
|
|
59
|
+
/>
|
|
40
60
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
61
|
+
<ImageWrapper
|
|
62
|
+
src="./ux writing/clear_chat.png"
|
|
63
|
+
alt="Clear chat confirmation dialog"
|
|
64
|
+
/>
|
|
44
65
|
|
|
45
66
|
## Checklist
|
|
46
67
|
|
|
47
|
-
- Is the
|
|
48
|
-
-
|
|
49
|
-
-
|
|
50
|
-
- Does the
|
|
51
|
-
-
|
|
52
|
-
-
|
|
53
|
-
- Do the buttons include context to reaffirm the action?
|
|
54
|
-
- Is your copy at a reading level of grade 7 or below? Test with [Hemingway App](https://hemingwayapp.com).
|
|
55
|
-
- Have you asked someone unrelated to the project to read the message and did they understand it?
|
|
68
|
+
- Is the action irreversible, destructive, or has unexpected consequences? If not, consider using a different pattern.
|
|
69
|
+
- Is the same verb used from the action triggering the confirmation dialog, to the heading, to CTA1?
|
|
70
|
+
- Did you avoid filler language such as “Are you sure you want to...?”
|
|
71
|
+
- Does the body front-load the critical consequence in 1–3 lines?
|
|
72
|
+
- Are the buttons mutually exclusive (and avoid using “Yes/No”)?
|
|
73
|
+
- Is there a safer alternative or undo to mention? (If available, offer the option as CTA2.)
|
|
Binary file
|
|
Binary file
|
|
Binary file
|