@codecademy/styleguide 79.0.0 → 79.0.1-alpha.8aa868.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.
- package/.storybook/components/Elements/DocsContainer.tsx +4 -0
- package/.storybook/components/Elements/Markdown.tsx +0 -1
- package/.storybook/preview.ts +14 -0
- package/.storybook/theming/GamutThemeProvider.tsx +7 -1
- package/CHANGELOG.md +4 -0
- package/package.json +2 -2
- package/src/lib/Foundations/System/About.mdx +1 -1
- package/src/lib/Foundations/System/Props/About.mdx +81 -0
- package/src/lib/Foundations/System/Props/Background.mdx +30 -0
- package/src/lib/Foundations/System/Props/Border.mdx +33 -0
- package/src/lib/Foundations/System/Props/Color.mdx +28 -0
- package/src/lib/Foundations/System/Props/Flex.mdx +28 -0
- package/src/lib/Foundations/System/Props/Grid.mdx +31 -0
- package/src/lib/Foundations/System/Props/Layout.mdx +34 -0
- package/src/lib/Foundations/System/Props/List.mdx +38 -0
- package/src/lib/Foundations/System/Props/Positioning.mdx +29 -0
- package/src/lib/Foundations/System/Props/Shadow.mdx +31 -0
- package/src/lib/Foundations/System/Props/Space.mdx +44 -0
- package/src/lib/Foundations/System/Props/Space.stories.tsx +48 -0
- package/src/lib/Foundations/System/Props/Typography.mdx +28 -0
- package/src/lib/Foundations/System/ResponsiveProperties/ResponsiveProperties.mdx +3 -3
- package/src/lib/Foundations/System/ResponsiveProperties/ResponsiveProperties.stories.tsx +1 -0
- package/src/lib/Foundations/shared/elements.tsx +69 -19
- package/src/lib/Meta/About.mdx +3 -1
- package/src/lib/Meta/Logical and physical CSS properties.mdx +123 -0
- package/src/lib/Meta/Usage Guide.mdx +6 -1
- package/src/static/meta/toolbar.png +0 -0
- package/src/lib/Foundations/System/Props.mdx +0 -230
|
@@ -52,6 +52,9 @@ export const DocsContainer: React.FC<{
|
|
|
52
52
|
|
|
53
53
|
const globalTheme =
|
|
54
54
|
(context as any).store.userGlobals?.globals?.theme || 'core';
|
|
55
|
+
const globalLogicalProps = (context as any).store.userGlobals?.globals
|
|
56
|
+
?.logicalProps;
|
|
57
|
+
const useLogicalProperties = globalLogicalProps !== 'false';
|
|
55
58
|
|
|
56
59
|
const { currentTheme } = useMemo(() => {
|
|
57
60
|
const findThemeStory: keyof typeof themeSpecificStories | undefined =
|
|
@@ -77,6 +80,7 @@ export const DocsContainer: React.FC<{
|
|
|
77
80
|
cache={createEmotionCache({ speedy: false })}
|
|
78
81
|
// This is typed to the CoreTheme in theme.d.ts
|
|
79
82
|
theme={currentTheme as unknown as CoreTheme}
|
|
83
|
+
useLogicalProperties={useLogicalProperties}
|
|
80
84
|
>
|
|
81
85
|
<ColorMode mode="light">
|
|
82
86
|
<HelmetProvider>
|
package/.storybook/preview.ts
CHANGED
|
@@ -49,6 +49,7 @@ const preview: Preview = {
|
|
|
49
49
|
'ESLint rules',
|
|
50
50
|
'Contributing',
|
|
51
51
|
'FAQs',
|
|
52
|
+
'Logical and physical CSS properties',
|
|
52
53
|
'Stories',
|
|
53
54
|
],
|
|
54
55
|
'Foundations',
|
|
@@ -163,6 +164,19 @@ export const globalTypes = {
|
|
|
163
164
|
showName: true,
|
|
164
165
|
},
|
|
165
166
|
},
|
|
167
|
+
logicalProps: {
|
|
168
|
+
name: 'LogicalProps',
|
|
169
|
+
description: 'Toggle between logical and physical CSS properties',
|
|
170
|
+
defaultValue: 'true',
|
|
171
|
+
toolbar: {
|
|
172
|
+
icon: 'transfer',
|
|
173
|
+
items: [
|
|
174
|
+
{ value: 'true', title: 'Logical' },
|
|
175
|
+
{ value: 'false', title: 'Physical' },
|
|
176
|
+
],
|
|
177
|
+
showName: true,
|
|
178
|
+
},
|
|
179
|
+
},
|
|
166
180
|
};
|
|
167
181
|
|
|
168
182
|
export const decorators = [withEmotion];
|
|
@@ -34,12 +34,14 @@ type GlobalsContext = {
|
|
|
34
34
|
globals: {
|
|
35
35
|
colorMode: 'light' | 'dark';
|
|
36
36
|
theme: keyof typeof themeMap;
|
|
37
|
+
logicalProps: 'true' | 'false';
|
|
37
38
|
};
|
|
38
39
|
};
|
|
39
40
|
|
|
40
41
|
export const withEmotion = (Story: any, context: GlobalsContext) => {
|
|
41
42
|
const colorMode = context.globals.colorMode ?? 'light';
|
|
42
43
|
const selectedTheme = context.globals.theme;
|
|
44
|
+
const useLogicalProperties = context.globals.logicalProps !== 'false';
|
|
43
45
|
const background = corePalette[themeBackground[colorMode]];
|
|
44
46
|
const storyRef = useRef<HTMLDivElement>(null);
|
|
45
47
|
const currentTheme = themeMap[selectedTheme];
|
|
@@ -57,6 +59,7 @@ export const withEmotion = (Story: any, context: GlobalsContext) => {
|
|
|
57
59
|
<GamutProvider
|
|
58
60
|
useCache={false}
|
|
59
61
|
useGlobals={false}
|
|
62
|
+
useLogicalProperties={useLogicalProperties}
|
|
60
63
|
theme={currentTheme as unknown as Theme}
|
|
61
64
|
>
|
|
62
65
|
<Background
|
|
@@ -72,7 +75,10 @@ export const withEmotion = (Story: any, context: GlobalsContext) => {
|
|
|
72
75
|
|
|
73
76
|
// Wrap all stories in minimal provider
|
|
74
77
|
return (
|
|
75
|
-
<GamutProvider
|
|
78
|
+
<GamutProvider
|
|
79
|
+
useLogicalProperties={useLogicalProperties}
|
|
80
|
+
theme={currentTheme as unknown as Theme}
|
|
81
|
+
>
|
|
76
82
|
<Background
|
|
77
83
|
alwaysSetVariables
|
|
78
84
|
bg={themeBackground[colorMode]}
|
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,10 @@
|
|
|
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.0.1-alpha.8aa868.0](https://github.com/Codecademy/gamut/compare/@codecademy/styleguide@79.0.0...@codecademy/styleguide@79.0.1-alpha.8aa868.0) (2026-01-29)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @codecademy/styleguide
|
|
9
|
+
|
|
6
10
|
## [79.0.0](https://github.com/Codecademy/gamut/compare/@codecademy/styleguide@78.5.5...@codecademy/styleguide@79.0.0) (2026-01-29)
|
|
7
11
|
|
|
8
12
|
### ⚠ BREAKING CHANGES
|
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.0.0",
|
|
4
|
+
"version": "79.0.1-alpha.8aa868.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": "
|
|
11
|
+
"gitHead": "8b0548707790d55b270d5577b0a95a8242c03ec5"
|
|
12
12
|
}
|
|
@@ -7,7 +7,7 @@ import {
|
|
|
7
7
|
} from '~styleguide/blocks';
|
|
8
8
|
|
|
9
9
|
import { parameters as composeParameters } from './Compose.mdx';
|
|
10
|
-
import { parameters as propsParameters } from './Props.mdx';
|
|
10
|
+
import { parameters as propsParameters } from './Props/About.mdx';
|
|
11
11
|
import { parameters as responsivePropertiesParameters } from './ResponsiveProperties/ResponsiveProperties.mdx';
|
|
12
12
|
import { parameters as variantsParameters } from './Variants.mdx';
|
|
13
13
|
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
AboutHeader,
|
|
5
|
+
addParentPath,
|
|
6
|
+
TableOfContents,
|
|
7
|
+
} from '~styleguide/blocks';
|
|
8
|
+
|
|
9
|
+
import { parameters as backgroundParameters } from './Background.mdx';
|
|
10
|
+
import { parameters as borderParameters } from './Border.mdx';
|
|
11
|
+
import { parameters as colorParameters } from './Color.mdx';
|
|
12
|
+
import { parameters as flexParameters } from './Flex.mdx';
|
|
13
|
+
import { parameters as gridParameters } from './Grid.mdx';
|
|
14
|
+
import { parameters as layoutParameters } from './Layout.mdx';
|
|
15
|
+
import { parameters as listParameters } from './List.mdx';
|
|
16
|
+
import { parameters as positioningParameters } from './Positioning.mdx';
|
|
17
|
+
import { parameters as shadowParameters } from './Shadow.mdx';
|
|
18
|
+
import { parameters as spaceParameters } from './Space.mdx';
|
|
19
|
+
import { parameters as typographyParameters } from './Typography.mdx';
|
|
20
|
+
|
|
21
|
+
export const parameters = {
|
|
22
|
+
id: 'Foundations/System/Props',
|
|
23
|
+
title: 'Props',
|
|
24
|
+
subtitle:
|
|
25
|
+
'Reusable CSS-in-JS props with predictable behaviors and a consistent API for responsive CSS.',
|
|
26
|
+
status: 'current',
|
|
27
|
+
source: {
|
|
28
|
+
repo: 'gamut-styles',
|
|
29
|
+
githubLink:
|
|
30
|
+
'https://github.com/Codecademy/gamut/blob/main/packages/gamut-styles/src/variance/config.ts',
|
|
31
|
+
},
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
<Meta title="Foundations/System/Props/About" />
|
|
35
|
+
|
|
36
|
+
<AboutHeader {...parameters} />
|
|
37
|
+
|
|
38
|
+
We provide a set of out of style functions out of the box through `@codecademy/gamut-styles` that are standardized throughout all of our components. These props are strongly typed and can be included as necessary on any styled component.
|
|
39
|
+
|
|
40
|
+
System props have a few facets that are important to note:
|
|
41
|
+
|
|
42
|
+
- They can some times represent multiple properties.
|
|
43
|
+
- They may be restricted to specific token scales but will always have access to global css values like `initial` and `none`.
|
|
44
|
+
- They may have a function that transforms the given value into a standardized value (e.g. `width={.5}` => `width: 50%`)
|
|
45
|
+
|
|
46
|
+
We've grouped these into a few main groups that affect simliar behaviors: `layout`, `space`, `color`, `border`, `background`, `typography`, `positioning`, `grid`, `flex`, `shadow`.
|
|
47
|
+
|
|
48
|
+
You may import these groups directly from `gamut-styles`.
|
|
49
|
+
|
|
50
|
+
```tsx
|
|
51
|
+
import { variance } from '@codecademy/variance';
|
|
52
|
+
import { system } from '@codecademy/gamut-styles';
|
|
53
|
+
|
|
54
|
+
const ExampleContainer = styled.div(
|
|
55
|
+
variance.compose(system.layout, system.positioning)
|
|
56
|
+
);
|
|
57
|
+
|
|
58
|
+
<ExampleContainer position="absolute" width="50px" height="50px" />;
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Each system prop has 3 important features:
|
|
62
|
+
|
|
63
|
+
- `properties`: Any number of CSS Properties this prop is responsible for.
|
|
64
|
+
- `scale`: A set of values that determines valid inputs for each prop based on the selected theme and that theme's typing (e.g. if the `lxStudio` theme is being used, a scale of `colors` will restrict to the `lxStudio` theme's colors). These are generally aliases for more verbose or opaque CSS properties allowing you to specify a human readable name in your props. If a prop doesn't have a scale that means it accepts all valid `CSSType` values as props, however if it does have a scale it will only accept global values and keys of the provided scale.
|
|
65
|
+
- `transform`: A function that changes the prop / scale value prior to adding it to the stylehseet. This allows us to add / change units for properties like `width` and `height`. Or ensure extra defaults or fallbacks are added dynamically.
|
|
66
|
+
|
|
67
|
+
<TableOfContents
|
|
68
|
+
links={addParentPath(parameters.id, [
|
|
69
|
+
layoutParameters,
|
|
70
|
+
spaceParameters,
|
|
71
|
+
typographyParameters,
|
|
72
|
+
colorParameters,
|
|
73
|
+
borderParameters,
|
|
74
|
+
flexParameters,
|
|
75
|
+
gridParameters,
|
|
76
|
+
backgroundParameters,
|
|
77
|
+
positioningParameters,
|
|
78
|
+
shadowParameters,
|
|
79
|
+
listParameters,
|
|
80
|
+
])}
|
|
81
|
+
/>
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
|
|
7
|
+
export const parameters = {
|
|
8
|
+
title: 'Background',
|
|
9
|
+
subtitle:
|
|
10
|
+
'Props for background manipulation (sizing / repitition / images), for background color see `colors`.',
|
|
11
|
+
status: 'current',
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
<Meta title="Foundations/System/Props/Background" />
|
|
15
|
+
|
|
16
|
+
<AboutHeader {...parameters} />
|
|
17
|
+
|
|
18
|
+
Background props control how background images and patterns are displayed on elements. These properties give you control over image sizing, positioning, and repetition behavior. For solid background colors, use the color props which connect to the theme's color palette.
|
|
19
|
+
|
|
20
|
+
```tsx
|
|
21
|
+
import styled from '@emotion/styled';
|
|
22
|
+
import { system } from '@codecademy/gamut-styles';
|
|
23
|
+
import myBg from './myBg.png';
|
|
24
|
+
|
|
25
|
+
const BackgroundExample = styled.div(system.background);
|
|
26
|
+
|
|
27
|
+
<BackgroundExample background={`url(${myBg}`} backgroundSize="cover" />;
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
<TokenTable rows={getPropRows('background')} columns={defaultColumns} />
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
|
|
7
|
+
export const parameters = {
|
|
8
|
+
title: 'Border',
|
|
9
|
+
subtitle: 'Border styles',
|
|
10
|
+
status: 'updating',
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
<Meta title="Foundations/System/Props/Border" />
|
|
14
|
+
|
|
15
|
+
<AboutHeader {...parameters} />
|
|
16
|
+
|
|
17
|
+
Border props enable you to add and style borders on any side of an element. These properties support directional borders (top, right, bottom, left) as well as convenient shorthands for horizontal and vertical borders. Border radius values connect to the theme's `borderRadii` scale for consistent corner rounding.
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import styled from '@emotion/styled';
|
|
21
|
+
import { system } from '@codecademy/gamut-styles';
|
|
22
|
+
|
|
23
|
+
const BorderExample = styled.div(system.border);
|
|
24
|
+
|
|
25
|
+
<BorderExample
|
|
26
|
+
border={1}
|
|
27
|
+
borderLeft="none"
|
|
28
|
+
borderRightStyle="dotted"
|
|
29
|
+
borderRadius="md"
|
|
30
|
+
/>;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
<TokenTable rows={getPropRows('border')} columns={defaultColumns} />
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
|
|
7
|
+
export const parameters = {
|
|
8
|
+
title: 'Color',
|
|
9
|
+
subtitle: 'Specific color properties',
|
|
10
|
+
status: 'current',
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
<Meta title="Foundations/System/Props/Color" />
|
|
14
|
+
|
|
15
|
+
<AboutHeader {...parameters} />
|
|
16
|
+
|
|
17
|
+
Color props control the foreground, background, and border colors of elements. All color values are restricted to your theme's color palette, ensuring consistent color usage throughout your application. The `bg` shorthand provides a convenient way to set background colors quickly.
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import styled from '@emotion/styled';
|
|
21
|
+
import { system } from '@codecademy/gamut-styles';
|
|
22
|
+
|
|
23
|
+
const ColorExample = styled.div(system.color);
|
|
24
|
+
|
|
25
|
+
<ColorExample bg="navy" textColor="gray-100" borderColor="blue" />;
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
<TokenTable rows={getPropRows('color')} columns={defaultColumns} />
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
|
|
7
|
+
export const parameters = {
|
|
8
|
+
title: 'Flex',
|
|
9
|
+
subtitle: 'Flex specific properties',
|
|
10
|
+
status: 'current',
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
<Meta title="Foundations/System/Props/Flex" />
|
|
14
|
+
|
|
15
|
+
<AboutHeader {...parameters} />
|
|
16
|
+
|
|
17
|
+
Flex props provide complete control over flexbox layouts, from container behavior to individual flex item properties. These properties make it easy to create flexible, responsive layouts with proper alignment and distribution of child elements. Use these on flex containers to control their children or on flex items to control their own behavior.
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import styled from '@emotion/styled';
|
|
21
|
+
import { system } from '@codecademy/gamut-styles';
|
|
22
|
+
|
|
23
|
+
const FlexExample = styled.div(system.flex);
|
|
24
|
+
|
|
25
|
+
<FlexExample flex={1} justifyContent="center" alignItems="flex-start" />;
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
<TokenTable rows={getPropRows('flex')} columns={defaultColumns} />
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
|
|
7
|
+
export const parameters = {
|
|
8
|
+
title: 'Grid',
|
|
9
|
+
subtitle: 'Grid specific properties',
|
|
10
|
+
status: 'current',
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
<Meta title="Foundations/System/Props/Grid" />
|
|
14
|
+
|
|
15
|
+
<AboutHeader {...parameters} />
|
|
16
|
+
|
|
17
|
+
Grid props give you powerful control over CSS Grid layouts. Define grid templates, control auto-placement behavior, and set gaps between grid items. These properties make it straightforward to create complex, responsive grid layouts with precise control over both container and item positioning.
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import styled from '@emotion/styled';
|
|
21
|
+
import { system } from '@codecademy/gamut-styles';
|
|
22
|
+
|
|
23
|
+
const GridExample = styled.div(system.grid);
|
|
24
|
+
|
|
25
|
+
<GridExample
|
|
26
|
+
gridTemplateColumns="max-content 1fr max-content"
|
|
27
|
+
columnGap={32}
|
|
28
|
+
/>;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
<TokenTable rows={getPropRows('grid')} columns={defaultColumns} />
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
|
|
7
|
+
export const parameters = {
|
|
8
|
+
title: 'Layout',
|
|
9
|
+
subtitle:
|
|
10
|
+
'Props for handling dimensions and other layout specific properties.',
|
|
11
|
+
status: 'updating',
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
<Meta title="Foundations/System/Props/Layout" />
|
|
15
|
+
|
|
16
|
+
<AboutHeader {...parameters} />
|
|
17
|
+
|
|
18
|
+
Layout props control the visual structure and dimensions of elements. These properties determine how components take up space, their display behavior, and how they align within their containers. Use these props to set widths, heights, overflow behavior, and container types for responsive layouts.
|
|
19
|
+
|
|
20
|
+
```tsx
|
|
21
|
+
import styled from '@emotion/styled';
|
|
22
|
+
import { system } from '@codecademy/gamut-styles';
|
|
23
|
+
|
|
24
|
+
const LayoutExample = styled.div(system.layout);
|
|
25
|
+
|
|
26
|
+
<LayoutExample
|
|
27
|
+
display="flex"
|
|
28
|
+
width="50%"
|
|
29
|
+
height="300px"
|
|
30
|
+
verticalAlign="middle"
|
|
31
|
+
/>;
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
<TokenTable rows={getPropRows('layout')} columns={defaultColumns} />
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, LinkTo, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
|
|
7
|
+
export const parameters = {
|
|
8
|
+
title: 'List',
|
|
9
|
+
subtitle:
|
|
10
|
+
'Props for adjusting list styles when rendering a component as a `ul` or `ol`',
|
|
11
|
+
status: 'current',
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
<Meta title="Foundations/System/Props/List" />
|
|
15
|
+
|
|
16
|
+
<AboutHeader {...parameters} />
|
|
17
|
+
|
|
18
|
+
List props control the appearance of ordered and unordered lists when components are rendered as `ul` or `ol` elements. These properties let you customize bullet styles, list positioning, and even use custom images as list markers, giving you full control over list presentation.
|
|
19
|
+
|
|
20
|
+
For more advanced list features, refer to the <LinkTo id="Organisms/Lists & Tables/List">List component</LinkTo>.
|
|
21
|
+
|
|
22
|
+
```tsx
|
|
23
|
+
import styled from '@emotion/styled';
|
|
24
|
+
import { system } from '@codecademy/gamut-styles';
|
|
25
|
+
|
|
26
|
+
const ListExample = styled.div(system.list);
|
|
27
|
+
|
|
28
|
+
<ListExample
|
|
29
|
+
as="ul"
|
|
30
|
+
listStyleType="square"
|
|
31
|
+
listStylePosition="inside"
|
|
32
|
+
listStyleImage="none"
|
|
33
|
+
>
|
|
34
|
+
<ListExample as="li">a list item</ListExample>
|
|
35
|
+
</ListExample>;
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
<TokenTable rows={getPropRows('list')} columns={defaultColumns} />
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
|
|
7
|
+
export const parameters = {
|
|
8
|
+
title: 'Positioning',
|
|
9
|
+
subtitle:
|
|
10
|
+
'Props that affect stacking and position contexts. Like `top`, `position` and `opacity`.',
|
|
11
|
+
status: 'updating',
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
<Meta title="Foundations/System/Props/Positioning" />
|
|
15
|
+
|
|
16
|
+
<AboutHeader {...parameters} />
|
|
17
|
+
|
|
18
|
+
Positioning props control how elements are positioned within their parent containers and manage their stacking order. Use these properties to create fixed headers, absolute overlays, sticky navigation, and control layering with z-index. The `inset` shorthand provides a convenient way to set all four position values at once.
|
|
19
|
+
|
|
20
|
+
```tsx
|
|
21
|
+
import styled from '@emotion/styled';
|
|
22
|
+
import { system } from '@codecademy/gamut-styles';
|
|
23
|
+
|
|
24
|
+
const PositioningExample = styled.div(system.positioning);
|
|
25
|
+
|
|
26
|
+
<PositioningExample position="absolute" zIndex={2} top="0" left="0" />;
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
<TokenTable rows={getPropRows('positioning')} columns={defaultColumns} />
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
|
|
7
|
+
export const parameters = {
|
|
8
|
+
title: 'Shadow',
|
|
9
|
+
subtitle: 'Props for box and text shadows.',
|
|
10
|
+
status: 'current',
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
<Meta title="Foundations/System/Props/Shadow" />
|
|
14
|
+
|
|
15
|
+
<AboutHeader {...parameters} />
|
|
16
|
+
|
|
17
|
+
Shadow props add depth and visual interest to your components through box and text shadows. These properties accept standard CSS shadow syntax, allowing you to create subtle elevation effects or dramatic visual depth. Use shadows consistently to establish visual hierarchy in your interface.
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import styled from '@emotion/styled';
|
|
21
|
+
import { system } from '@codecademy/gamut-styles';
|
|
22
|
+
|
|
23
|
+
const ShadowExample = styled.div(system.shadow);
|
|
24
|
+
|
|
25
|
+
<ShadowExample
|
|
26
|
+
boxShadow="0 0 4px rgba(0, 0, 0, .15)"
|
|
27
|
+
textShadow="0 0 4px rgba(0, 0, 0, .15)"
|
|
28
|
+
/>;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
<TokenTable rows={getPropRows('shadows')} columns={defaultColumns} />
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { Canvas, Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, Callout, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
import * as SpaceStories from './Space.stories';
|
|
7
|
+
|
|
8
|
+
export const parameters = {
|
|
9
|
+
title: 'Space',
|
|
10
|
+
subtitle: 'Props for maintaining specific vertical and horizontal rhythms',
|
|
11
|
+
status: 'updating',
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
<Meta of={SpaceStories} title="Foundations/System/Props/Space" />
|
|
15
|
+
|
|
16
|
+
<AboutHeader {...parameters} />
|
|
17
|
+
|
|
18
|
+
Space props provide a consistent way to apply margin and padding throughout your application. All spacing values reference the theme's spacing scale, ensuring visual consistency and making it easy to create responsive spacing patterns using array syntax.
|
|
19
|
+
|
|
20
|
+
```tsx
|
|
21
|
+
import styled from '@emotion/styled';
|
|
22
|
+
import { system } from '@codecademy/gamut-styles';
|
|
23
|
+
|
|
24
|
+
const SpaceExample = styled.div(system.space);
|
|
25
|
+
|
|
26
|
+
<SpaceExample p={8} my={[16, 24, 32]} />;
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
These space props support both physical and logical CSS properties and will render the appropriate properties based on `useLogicalProperties`'s value passed into the `<GamutProvider>` at the root of your application.
|
|
30
|
+
|
|
31
|
+
<Callout
|
|
32
|
+
text={
|
|
33
|
+
<>
|
|
34
|
+
You can use the <strong>LogicalProps</strong> button in the toolbar to
|
|
35
|
+
switch between modes.
|
|
36
|
+
</>
|
|
37
|
+
}
|
|
38
|
+
/>
|
|
39
|
+
|
|
40
|
+
<Canvas of={SpaceStories.MarginExample} />
|
|
41
|
+
|
|
42
|
+
<Canvas of={SpaceStories.PaddingExample} />
|
|
43
|
+
|
|
44
|
+
<TokenTable rows={getPropRows('space')} columns={defaultColumns} />
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { Box, Markdown } from '@codecademy/gamut';
|
|
2
|
+
import type { Meta, StoryObj } from '@storybook/react';
|
|
3
|
+
|
|
4
|
+
const meta: Meta<typeof Box> = {
|
|
5
|
+
title: 'Foundations/System/Props/Space',
|
|
6
|
+
component: Box,
|
|
7
|
+
};
|
|
8
|
+
|
|
9
|
+
export default meta;
|
|
10
|
+
type Story = StoryObj<typeof Box>;
|
|
11
|
+
|
|
12
|
+
export const MarginExample: Story = {
|
|
13
|
+
render: () => (
|
|
14
|
+
<Box
|
|
15
|
+
bg="primary"
|
|
16
|
+
color="background-contrast"
|
|
17
|
+
mb={64}
|
|
18
|
+
ml={16}
|
|
19
|
+
mr={32}
|
|
20
|
+
mt={4}
|
|
21
|
+
textAlign="center"
|
|
22
|
+
>
|
|
23
|
+
This box has{' '}
|
|
24
|
+
<Markdown text="`mt={4}`, `mr={32}`, `mb={64}`, and `ml={16}`." /> Inspect
|
|
25
|
+
the example to see what CSS properties are rendered.
|
|
26
|
+
</Box>
|
|
27
|
+
),
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
export const PaddingExample: Story = {
|
|
31
|
+
render: () => (
|
|
32
|
+
<Box bg="background-selected">
|
|
33
|
+
<Box
|
|
34
|
+
bg="primary"
|
|
35
|
+
color="background-contrast"
|
|
36
|
+
pb={64}
|
|
37
|
+
pl={16}
|
|
38
|
+
pr={32}
|
|
39
|
+
pt={4}
|
|
40
|
+
textAlign="center"
|
|
41
|
+
>
|
|
42
|
+
This box has{' '}
|
|
43
|
+
<Markdown text="`pt={4}`, `pr={32}`, `pb={64}`, and `pl={16}`." />{' '}
|
|
44
|
+
Inspect the example to see what CSS properties are rendered.
|
|
45
|
+
</Box>
|
|
46
|
+
</Box>
|
|
47
|
+
),
|
|
48
|
+
};
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import { AboutHeader, TokenTable } from '~styleguide/blocks';
|
|
4
|
+
|
|
5
|
+
import { defaultColumns, getPropRows } from '../../shared/elements';
|
|
6
|
+
|
|
7
|
+
export const parameters = {
|
|
8
|
+
title: 'Typography',
|
|
9
|
+
subtitle: 'Props for text manipulation',
|
|
10
|
+
status: 'current',
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
<Meta title="Foundations/System/Props/Typography" />
|
|
14
|
+
|
|
15
|
+
<AboutHeader {...parameters} />
|
|
16
|
+
|
|
17
|
+
Typography props give you fine-grained control over text styling and appearance. These properties connect to the theme's typography scales for font families, sizes, weights, and line heights, making it simple to maintain typographic consistency across your application while allowing for custom text transformations and decorations.
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import styled from '@emotion/styled';
|
|
21
|
+
import { system } from '@codecademy/gamut-styles';
|
|
22
|
+
|
|
23
|
+
const TextExample = styled.p(system.typography);
|
|
24
|
+
|
|
25
|
+
<TextExample fontSize={16} fontFamily="accent" textTransform="uppercase" />;
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
<TokenTable rows={getPropRows('typography')} columns={defaultColumns} />
|
|
@@ -6,17 +6,17 @@ import { breakpoint } from '../../shared/elements';
|
|
|
6
6
|
import * as ResponsivePropertiesStories from './ResponsiveProperties.stories';
|
|
7
7
|
|
|
8
8
|
export const parameters = {
|
|
9
|
-
title: 'Responsive
|
|
9
|
+
title: 'Responsive properties',
|
|
10
10
|
subtitle:
|
|
11
11
|
'All system props accept a syntax to generate responsive styles on a per prop basis',
|
|
12
12
|
source: {
|
|
13
13
|
repo: 'variance',
|
|
14
14
|
githubLink:
|
|
15
|
-
'https://github.com/Codecademy/gamut/blob/
|
|
15
|
+
'https://github.com/Codecademy/gamut/blob/main/packages/gamut-styles/src/variables/responsive.ts',
|
|
16
16
|
},
|
|
17
17
|
};
|
|
18
18
|
|
|
19
|
-
<Meta
|
|
19
|
+
<Meta of={ResponsivePropertiesStories} />
|
|
20
20
|
|
|
21
21
|
<AboutHeader {...parameters} />
|
|
22
22
|
|
|
@@ -2,22 +2,32 @@ import { Anchor, Box } from '@codecademy/gamut';
|
|
|
2
2
|
import {
|
|
3
3
|
Background,
|
|
4
4
|
coreSwatches,
|
|
5
|
+
css,
|
|
5
6
|
lxStudioColors,
|
|
6
7
|
theme,
|
|
7
8
|
trueColors,
|
|
8
9
|
} from '@codecademy/gamut-styles';
|
|
9
10
|
// eslint-disable-next-line gamut/import-paths
|
|
10
11
|
import * as ALL_PROPS from '@codecademy/gamut-styles/src/variance/config';
|
|
12
|
+
import { useTheme } from '@emotion/react';
|
|
13
|
+
import styled from '@emotion/styled';
|
|
11
14
|
import kebabCase from 'lodash/kebabCase';
|
|
12
15
|
|
|
13
16
|
import { Code, ColorScale, LinkTo, TokenTable } from '~styleguide/blocks';
|
|
14
17
|
|
|
15
18
|
import { applyCorrectNotation } from './applyCorrectNotation';
|
|
16
19
|
|
|
20
|
+
const AnchorCode = styled(Code)(
|
|
21
|
+
css({
|
|
22
|
+
textDecoration: 'underline',
|
|
23
|
+
mx: 4,
|
|
24
|
+
})
|
|
25
|
+
);
|
|
26
|
+
|
|
17
27
|
export const PROP_COLUMN = {
|
|
18
28
|
key: 'key',
|
|
19
29
|
name: 'Prop',
|
|
20
|
-
size: '
|
|
30
|
+
size: 'lg',
|
|
21
31
|
render: ({ id }: any) => <Code>{id}</Code>,
|
|
22
32
|
};
|
|
23
33
|
|
|
@@ -403,26 +413,61 @@ export const DarkModeTable = () => (
|
|
|
403
413
|
);
|
|
404
414
|
/* eslint-disable gamut/import-paths */
|
|
405
415
|
|
|
416
|
+
const PropertiesRenderer = ({
|
|
417
|
+
property,
|
|
418
|
+
properties,
|
|
419
|
+
resolveProperty,
|
|
420
|
+
}: {
|
|
421
|
+
property: string | { physical: string; logical: string };
|
|
422
|
+
properties?: string[] | { physical: string[]; logical: string[] };
|
|
423
|
+
resolveProperty?: (useLogicalProperties: boolean) => 'logical' | 'physical';
|
|
424
|
+
}) => {
|
|
425
|
+
const currentTheme = useTheme() as { useLogicalProperties?: boolean };
|
|
426
|
+
const useLogicalProperties = currentTheme?.useLogicalProperties ?? true;
|
|
427
|
+
|
|
428
|
+
const mode = resolveProperty
|
|
429
|
+
? resolveProperty(useLogicalProperties)
|
|
430
|
+
: 'physical';
|
|
431
|
+
|
|
432
|
+
const resolvedProperty =
|
|
433
|
+
typeof property === 'string' ? property : property[mode];
|
|
434
|
+
|
|
435
|
+
let resolvedProperties: string[];
|
|
436
|
+
if (!properties) {
|
|
437
|
+
resolvedProperties = [resolvedProperty];
|
|
438
|
+
} else if (Array.isArray(properties)) {
|
|
439
|
+
resolvedProperties = properties;
|
|
440
|
+
} else {
|
|
441
|
+
resolvedProperties = properties[mode];
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
return (
|
|
445
|
+
<>
|
|
446
|
+
{resolvedProperties.map((prop) => (
|
|
447
|
+
<Anchor
|
|
448
|
+
href={`https://developer.mozilla.org/en-US/docs/Web/CSS/${kebabCase(
|
|
449
|
+
prop
|
|
450
|
+
)}`}
|
|
451
|
+
key={prop}
|
|
452
|
+
rel=""
|
|
453
|
+
target="_blank"
|
|
454
|
+
>
|
|
455
|
+
<AnchorCode>{kebabCase(prop)}</AnchorCode>
|
|
456
|
+
</Anchor>
|
|
457
|
+
))}
|
|
458
|
+
</>
|
|
459
|
+
);
|
|
460
|
+
};
|
|
461
|
+
|
|
406
462
|
const PROPERTIES_COLUMN = {
|
|
407
463
|
key: 'properties',
|
|
408
464
|
name: 'Properties',
|
|
409
465
|
size: 'xl',
|
|
410
|
-
render: ({
|
|
411
|
-
property
|
|
412
|
-
properties
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
properties: string[];
|
|
416
|
-
}) =>
|
|
417
|
-
properties.map((property) => (
|
|
418
|
-
<Anchor
|
|
419
|
-
href={`https://developer.mozilla.org/en-US/docs/Web/CSS/${property}`}
|
|
420
|
-
rel=""
|
|
421
|
-
target="_blank"
|
|
422
|
-
>
|
|
423
|
-
<Code key={property}>{kebabCase(property)}</Code>
|
|
424
|
-
</Anchor>
|
|
425
|
-
)),
|
|
466
|
+
render: (props: {
|
|
467
|
+
property: string | { physical: string; logical: string };
|
|
468
|
+
properties?: string[] | { physical: string[]; logical: string[] };
|
|
469
|
+
resolveProperty?: (useLogicalProperties: boolean) => 'logical' | 'physical';
|
|
470
|
+
}) => <PropertiesRenderer {...props} />,
|
|
426
471
|
};
|
|
427
472
|
|
|
428
473
|
const SCALE_COLUMN = {
|
|
@@ -430,7 +475,7 @@ const SCALE_COLUMN = {
|
|
|
430
475
|
name: 'Scale',
|
|
431
476
|
size: 'lg',
|
|
432
477
|
render: ({ scale }: { scale: string }) => (
|
|
433
|
-
<LinkTo id=
|
|
478
|
+
<LinkTo id="Foundations/Theme/Core Theme">{scale}</LinkTo>
|
|
434
479
|
),
|
|
435
480
|
};
|
|
436
481
|
|
|
@@ -438,7 +483,12 @@ const TRANSFORM_COLUMN = {
|
|
|
438
483
|
key: 'transform',
|
|
439
484
|
name: 'Transform',
|
|
440
485
|
size: 'fill',
|
|
441
|
-
render: ({ transform }: any) =>
|
|
486
|
+
render: ({ transform, resolveProperty }: any) => (
|
|
487
|
+
<>
|
|
488
|
+
{transform && <Code>{transform?.name}</Code>}
|
|
489
|
+
{resolveProperty && <Code>{resolveProperty?.name}</Code>}
|
|
490
|
+
</>
|
|
491
|
+
),
|
|
442
492
|
};
|
|
443
493
|
|
|
444
494
|
export const defaultColumns = [
|
package/src/lib/Meta/About.mdx
CHANGED
|
@@ -13,6 +13,7 @@ import { parameters as deepControlsParameters } from './Deep Controls Add-On.mdx
|
|
|
13
13
|
import { parameters as eslintRulesParameters } from './ESLint rules.mdx';
|
|
14
14
|
import { parameters as faqsParameters } from './FAQs.mdx';
|
|
15
15
|
import { parameters as installationParameters } from './Installation.mdx';
|
|
16
|
+
import { parameters as logicalPhysicalParameters } from './Logical and physical CSS properties.mdx';
|
|
16
17
|
import { parameters as storiesParameters } from './Stories.mdx';
|
|
17
18
|
import { parameters as usageGuideParameters } from './Usage Guide.mdx';
|
|
18
19
|
|
|
@@ -34,9 +35,10 @@ export const parameters = {
|
|
|
34
35
|
deepControlsParameters,
|
|
35
36
|
eslintRulesParameters,
|
|
36
37
|
faqsParameters,
|
|
38
|
+
installationParameters,
|
|
39
|
+
logicalPhysicalParameters,
|
|
37
40
|
storiesParameters,
|
|
38
41
|
brandParameters,
|
|
39
|
-
installationParameters,
|
|
40
42
|
usageGuideParameters,
|
|
41
43
|
])}
|
|
42
44
|
/>
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { Meta } from '@storybook/blocks';
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
AboutHeader,
|
|
5
|
+
Callout,
|
|
6
|
+
Code,
|
|
7
|
+
ImageWrapper,
|
|
8
|
+
TokenTable,
|
|
9
|
+
} from '~styleguide/blocks';
|
|
10
|
+
|
|
11
|
+
export const parameters = {
|
|
12
|
+
id: 'Meta/Logical and physical CSS properties',
|
|
13
|
+
title: 'Logical and physical CSS properties',
|
|
14
|
+
subtitle:
|
|
15
|
+
'Understanding CSS logical and physical properties and how Gamut supports both modes.',
|
|
16
|
+
status: 'static',
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
<Meta title="Meta/Logical and physical CSS properties" />
|
|
20
|
+
|
|
21
|
+
<AboutHeader {...parameters} />
|
|
22
|
+
|
|
23
|
+
## What are CSS logical properties?
|
|
24
|
+
|
|
25
|
+
CSS logical properties are a modern approach to styling that adapts to the writing mode and text direction of your content, rather than being tied to physical screen directions. More information can be found on[MDN: CSS Logical Properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values)
|
|
26
|
+
|
|
27
|
+
### Physical Properties (Traditional)
|
|
28
|
+
|
|
29
|
+
Physical properties reference the physical dimensions of the viewport. For example:
|
|
30
|
+
|
|
31
|
+
- `margin-left`, `margin-right`, `margin-top`, `margin-bottom`
|
|
32
|
+
- `padding-left`, `padding-right`, `padding-top`, `padding-bottom`
|
|
33
|
+
|
|
34
|
+
These work well for left-to-right (LTR) languages but require manual overrides for right-to-left (RTL) languages like Arabic or Hebrew.
|
|
35
|
+
|
|
36
|
+
### Logical Properties (Modern)
|
|
37
|
+
|
|
38
|
+
Logical properties reference the flow of content:
|
|
39
|
+
|
|
40
|
+
- **Inline axis** (text direction): `margin-inline-start`, `margin-inline-end`
|
|
41
|
+
- **Block axis** (reading direction): `margin-block-start`, `margin-block-end`
|
|
42
|
+
|
|
43
|
+
## Using `useLogicalProperties` in Gamut
|
|
44
|
+
|
|
45
|
+
Gamut supports both physical and logical CSS properties through the `useLogicalProperties` prop on `GamutProvider`. This allows you to choose which mode your application uses. By default, `useLogicalProperties` is set to `true`, meaning Gamut will use logical CSS properties. If you want to use physical CSS properties, you have to set `useLogicalProperties` to `false`.
|
|
46
|
+
|
|
47
|
+
### Affected Props
|
|
48
|
+
|
|
49
|
+
Here are some examples of how physical and logical properties are affected by the `useLogicalProperties` prop:
|
|
50
|
+
|
|
51
|
+
<TokenTable
|
|
52
|
+
idKey="prop"
|
|
53
|
+
columns={[
|
|
54
|
+
{
|
|
55
|
+
key: 'prop',
|
|
56
|
+
name: 'Prop',
|
|
57
|
+
size: 'sm',
|
|
58
|
+
render: ({ prop }) => <Code>{prop}</Code>,
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
key: 'physical',
|
|
62
|
+
name: 'Physical',
|
|
63
|
+
size: 'xl',
|
|
64
|
+
render: ({ physical }) =>
|
|
65
|
+
physical.map((p) => (
|
|
66
|
+
<>
|
|
67
|
+
<Code key={p}>{p}</Code>{' '}
|
|
68
|
+
</>
|
|
69
|
+
)),
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
key: 'logical',
|
|
73
|
+
name: 'Logical',
|
|
74
|
+
size: 'xl',
|
|
75
|
+
render: ({ logical }) =>
|
|
76
|
+
logical.map((l) => (
|
|
77
|
+
<>
|
|
78
|
+
<Code key={l}>{l}</Code>{' '}
|
|
79
|
+
</>
|
|
80
|
+
)),
|
|
81
|
+
},
|
|
82
|
+
]}
|
|
83
|
+
rows={[
|
|
84
|
+
{
|
|
85
|
+
prop: 'mx',
|
|
86
|
+
physical: ['margin-left', 'margin-right'],
|
|
87
|
+
logical: ['margin-inline-start', 'margin-inline-end'],
|
|
88
|
+
},
|
|
89
|
+
{ prop: 'mt', physical: ['margin-top'], logical: ['margin-block-start'] },
|
|
90
|
+
{
|
|
91
|
+
prop: 'py',
|
|
92
|
+
physical: ['padding-top', 'padding-bottom'],
|
|
93
|
+
logical: ['padding-block-start', 'padding-block-end'],
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
prop: 'pb',
|
|
97
|
+
physical: ['padding-bottom'],
|
|
98
|
+
logical: ['padding-block-end'],
|
|
99
|
+
},
|
|
100
|
+
]}
|
|
101
|
+
/>
|
|
102
|
+
|
|
103
|
+
<Callout
|
|
104
|
+
text={
|
|
105
|
+
<>
|
|
106
|
+
Props like <code>m</code> and <code>p</code> (which set all four sides at
|
|
107
|
+
once) are not affected by this setting, as the CSS <code>margin</code> and{' '}
|
|
108
|
+
<code>padding</code> shorthands work identically in both modes.
|
|
109
|
+
</>
|
|
110
|
+
}
|
|
111
|
+
/>
|
|
112
|
+
|
|
113
|
+
## Previewing in Storybook
|
|
114
|
+
|
|
115
|
+
You can toggle between logical and physical properties in Storybook using the **LogicalProps** toolbar button:
|
|
116
|
+
|
|
117
|
+
<ImageWrapper
|
|
118
|
+
src="./meta/toolbar.png"
|
|
119
|
+
alt="The Storybook toolbar with the LogicalProps toggle highlighted."
|
|
120
|
+
height="auto"
|
|
121
|
+
/>
|
|
122
|
+
|
|
123
|
+
This allows you to preview how components render with either property mode without changing any code.
|
|
@@ -39,7 +39,8 @@ On each page is a toolbar located on the top:
|
|
|
39
39
|
1. Grid (the 2x2 collection of squares) - applies a grid to the preview
|
|
40
40
|
2. Color mode selector (the circle icon) - toggles between light and dark mode for rendered code examples
|
|
41
41
|
3. Theme switcher (the paintbrush icon) - switches between different design system themes (Core, Admin, LX Studio, Percipio)
|
|
42
|
-
4.
|
|
42
|
+
4. LogicalProps (the two arrows icon) - toggles between physical and logical CSS properties
|
|
43
|
+
5. Outline (dotted square) - applies outlines to elements in the rendered code examples
|
|
43
44
|
|
|
44
45
|
### Theme Switcher
|
|
45
46
|
|
|
@@ -58,6 +59,10 @@ Available themes:
|
|
|
58
59
|
|
|
59
60
|
The theme switcher works in combination with the color mode selector, so you can test both light and dark variants of each theme.
|
|
60
61
|
|
|
62
|
+
### LogicalProps
|
|
63
|
+
|
|
64
|
+
The LogicalProps button (two arrows icon) provides a menu to select between Logical and Physical CSS properties.
|
|
65
|
+
|
|
61
66
|
### Showing code
|
|
62
67
|
|
|
63
68
|
On the bottom right of each canvas (a rendered code example) is a button to show its code:
|
|
Binary file
|
|
@@ -1,230 +0,0 @@
|
|
|
1
|
-
import { Meta } from '@storybook/blocks';
|
|
2
|
-
|
|
3
|
-
import { AboutHeader, TokenTable } from '~styleguide/blocks';
|
|
4
|
-
|
|
5
|
-
import { defaultColumns, getPropRows } from '../shared/elements';
|
|
6
|
-
|
|
7
|
-
export const parameters = {
|
|
8
|
-
title: 'Props',
|
|
9
|
-
subtitle:
|
|
10
|
-
'Reusable CSS-in-JS props with predictable behaviors and a consistent API for responsive CSS.',
|
|
11
|
-
source: {
|
|
12
|
-
repo: 'gamut-styles',
|
|
13
|
-
githubLink:
|
|
14
|
-
'https://github.com/Codecademy/gamut/blob/af5be6e39cccca5d5d8a1f811c77a7a0b618c914/packages/gamut-styles/src/variance/config.ts#L11',
|
|
15
|
-
},
|
|
16
|
-
};
|
|
17
|
-
|
|
18
|
-
<Meta title="Foundations/System/Props" />
|
|
19
|
-
|
|
20
|
-
<AboutHeader {...parameters} />
|
|
21
|
-
|
|
22
|
-
We provide a set of out of style functions out of the box through `@codecademy/gamut-styles` that are standardized throughout all of our components. These props are strongly typed and can be included as necessary on any styled component.
|
|
23
|
-
|
|
24
|
-
System props have a few facets that are important to note:
|
|
25
|
-
|
|
26
|
-
- They can some times represent multiple properties.
|
|
27
|
-
- They may be restricted to specific token scales but will always have access to global css values like `initial` and `none`.
|
|
28
|
-
- They may have a function that transforms the given value into a standardized value (e.g. `width={.5}` => `width: 50%`)
|
|
29
|
-
|
|
30
|
-
We've grouped these into a few main groups that affect simliar behaviors: `layout`, `space`, `color`, `border`, `background`, `typography`, `positioning`, `grid`, `flex`, `shadow`.
|
|
31
|
-
|
|
32
|
-
You may import these groups directly from `gamut-styles`.
|
|
33
|
-
|
|
34
|
-
```tsx
|
|
35
|
-
import { variance } from '@codecademy/variance';
|
|
36
|
-
import { system } from '@codecademy/gamut-styles';
|
|
37
|
-
|
|
38
|
-
const Box = styled.div(variance.compose(system.layout, system.positioning));
|
|
39
|
-
|
|
40
|
-
<Box position="absolute" width="50px" height="50px" />;
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Each system prop has 3 important features:
|
|
44
|
-
|
|
45
|
-
- `properties`: Any number of CSS Properties this prop is responsible for.
|
|
46
|
-
- `scale`: A set of values that determines valid inputs for each prop (e.g. a scale of `colors` will restrict to only theme colors). These are generally aliases for more verbose or opaque css properties allowing you to specify a human readable name in your props. If a prop doesn't have a scale that means it accepts all valid CSSType values as props, however if it does have a scale it will only accept global values and keys of the provided scale.
|
|
47
|
-
- `transform`: A function that changes the prop / scale value prior to adding it to the stylehseet. This allows us to add / change units for properties like `width` and `height`. Or ensure extra defaults or fallbacks are added dynamically.
|
|
48
|
-
|
|
49
|
-
<br />
|
|
50
|
-
|
|
51
|
-
## Layout
|
|
52
|
-
|
|
53
|
-
Props for handling dimensions and other layout specific properties.
|
|
54
|
-
|
|
55
|
-
```tsx
|
|
56
|
-
import styled from '@emotion/styled';
|
|
57
|
-
import { system } from '@codecademy/gamut-styles';
|
|
58
|
-
|
|
59
|
-
const Box = styled.div(system.layout);
|
|
60
|
-
|
|
61
|
-
<Box display="flex" width="50%" height="300px" verticalAlign="middle" />;
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
<TokenTable rows={getPropRows('layout')} columns={defaultColumns} />
|
|
65
|
-
|
|
66
|
-
## Space
|
|
67
|
-
|
|
68
|
-
Props for maintaining specific vertical and horizontal rhythms
|
|
69
|
-
|
|
70
|
-
```tsx
|
|
71
|
-
import styled from '@emotion/styled';
|
|
72
|
-
import { system } from '@codecademy/gamut-styles';
|
|
73
|
-
|
|
74
|
-
const Spacer = styled.div(system.space);
|
|
75
|
-
|
|
76
|
-
<Spacer p={8} my={[16, 24, 32]} />;
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
<TokenTable rows={getPropRows('space')} columns={defaultColumns} />
|
|
80
|
-
|
|
81
|
-
## Typography
|
|
82
|
-
|
|
83
|
-
Props for text manipulation
|
|
84
|
-
|
|
85
|
-
```tsx
|
|
86
|
-
import styled from '@emotion/styled';
|
|
87
|
-
import { system } from '@codecademy/gamut-styles';
|
|
88
|
-
|
|
89
|
-
const Text = styled.p(system.typography);
|
|
90
|
-
|
|
91
|
-
<Text fontSize={16} fontFamily="accent" textTransform="uppercase" />;
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
<TokenTable rows={getPropRows('typography')} columns={defaultColumns} />
|
|
95
|
-
|
|
96
|
-
## Color
|
|
97
|
-
|
|
98
|
-
Specific color properties
|
|
99
|
-
|
|
100
|
-
```tsx
|
|
101
|
-
import styled from '@emotion/styled';
|
|
102
|
-
import { system } from '@codecademy/gamut-styles';
|
|
103
|
-
|
|
104
|
-
const Background = styled.div(system.color);
|
|
105
|
-
|
|
106
|
-
<Background bg="navy" textColor="gray-100" borderColor="blue" />;
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
<TokenTable rows={getPropRows('color')} columns={defaultColumns} />
|
|
110
|
-
|
|
111
|
-
## Border
|
|
112
|
-
|
|
113
|
-
Border styles
|
|
114
|
-
|
|
115
|
-
```tsx
|
|
116
|
-
import styled from '@emotion/styled';
|
|
117
|
-
import { system } from '@codecademy/gamut-styles';
|
|
118
|
-
|
|
119
|
-
const Box = styled.div(system.border);
|
|
120
|
-
|
|
121
|
-
<Box
|
|
122
|
-
border={1}
|
|
123
|
-
borderLeft="none"
|
|
124
|
-
borderRightStyle="dotted"
|
|
125
|
-
borderRadius="md"
|
|
126
|
-
/>;
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
<TokenTable rows={getPropRows('border')} columns={defaultColumns} />
|
|
130
|
-
|
|
131
|
-
## Flex
|
|
132
|
-
|
|
133
|
-
Flex specific properties
|
|
134
|
-
|
|
135
|
-
```tsx
|
|
136
|
-
import styled from '@emotion/styled';
|
|
137
|
-
import { system } from '@codecademy/gamut-styles';
|
|
138
|
-
|
|
139
|
-
const FlexBox = styled.div(system.flex);
|
|
140
|
-
|
|
141
|
-
<FlexBox flex={1} justifyContent="center" alignItems="flex-start" />;
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
<TokenTable rows={getPropRows('flex')} columns={defaultColumns} />
|
|
145
|
-
|
|
146
|
-
## Grid
|
|
147
|
-
|
|
148
|
-
Grid specific properties
|
|
149
|
-
|
|
150
|
-
```tsx
|
|
151
|
-
import styled from '@emotion/styled';
|
|
152
|
-
import { system } from '@codecademy/gamut-styles';
|
|
153
|
-
|
|
154
|
-
const GridBox = styled.div(system.grid);
|
|
155
|
-
|
|
156
|
-
<GridBox gridTemplateColumns="max-content 1fr max-content" columnGap={32} />;
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
<TokenTable rows={getPropRows('grid')} columns={defaultColumns} />
|
|
160
|
-
|
|
161
|
-
## Background
|
|
162
|
-
|
|
163
|
-
Props for background manipulation (sizing / repitition / images), for background color see `colors`.
|
|
164
|
-
|
|
165
|
-
```tsx
|
|
166
|
-
import styled from '@emotion/styled';
|
|
167
|
-
import { system } from '@codecademy/gamut-styles';
|
|
168
|
-
import myBg from './myBg.png';
|
|
169
|
-
|
|
170
|
-
const Box = styled.div(system.background);
|
|
171
|
-
|
|
172
|
-
<Box background={`url(${myBg}`} backgroundSize="cover" />;
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
<TokenTable rows={getPropRows('background')} columns={defaultColumns} />
|
|
176
|
-
|
|
177
|
-
## Positioning
|
|
178
|
-
|
|
179
|
-
Props that affect stacking and position contexts. Like `top`, `position` and `opacity`.
|
|
180
|
-
|
|
181
|
-
```tsx
|
|
182
|
-
import styled from '@emotion/styled';
|
|
183
|
-
import { system } from '@codecademy/gamut-styles';
|
|
184
|
-
|
|
185
|
-
const Box = styled.div(system.positioning);
|
|
186
|
-
|
|
187
|
-
<Box position="absolute" zIndex={2} top="0" left="0" />;
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
<TokenTable rows={getPropRows('positioning')} columns={defaultColumns} />
|
|
191
|
-
|
|
192
|
-
## Shadow
|
|
193
|
-
|
|
194
|
-
Props for box and text shadows.
|
|
195
|
-
|
|
196
|
-
```tsx
|
|
197
|
-
import styled from '@emotion/styled';
|
|
198
|
-
import { system } from '@codecademy/gamut-styles';
|
|
199
|
-
|
|
200
|
-
const Box = styled.div(system.shadow);
|
|
201
|
-
|
|
202
|
-
<Box
|
|
203
|
-
boxShadow="0 0 4px rgba(0, 0, 0, .15)"
|
|
204
|
-
textShadow="0 0 4px rgba(0, 0, 0, .15)"
|
|
205
|
-
/>;
|
|
206
|
-
```
|
|
207
|
-
|
|
208
|
-
<TokenTable rows={getPropRows('shadows')} columns={defaultColumns} />
|
|
209
|
-
|
|
210
|
-
## List
|
|
211
|
-
|
|
212
|
-
Props for adjusting list styles when rendering a component as a `ul` or `ol`
|
|
213
|
-
|
|
214
|
-
```tsx
|
|
215
|
-
import styled from '@emotion/styled';
|
|
216
|
-
import { system } from '@codecademy/gamut-styles';
|
|
217
|
-
|
|
218
|
-
const Box = styled.div(system.list);
|
|
219
|
-
|
|
220
|
-
<Box
|
|
221
|
-
as="ul"
|
|
222
|
-
listStyleType="square"
|
|
223
|
-
listStylePosition="inside"
|
|
224
|
-
listStyleImage="none"
|
|
225
|
-
>
|
|
226
|
-
<Box as="li">a list item</Box>
|
|
227
|
-
</Box>;
|
|
228
|
-
```
|
|
229
|
-
|
|
230
|
-
<TokenTable rows={getPropRows('list')} columns={defaultColumns} />
|