@codecademy/styleguide 79.0.1-alpha.bd18ee.0 → 79.0.1-alpha.c4250e.0

package/src/lib/Meta/MCP/Figma MCP.mdx

@@ -0,0 +1,89 @@
+import { Meta } from '@storybook/blocks';
+
+import { AboutHeader, Callout } from '~styleguide/blocks';
+
+export const parameters = {
+  id: 'Figma MCP',
+  title: 'Figma MCP',
+  subtitle:
+    'Set up the Figma MCP locally to enable design to code generation, exclusive to Codecademy + Skillsoft employees.',
+  status: 'static',
+};
+
+<Meta title="Meta/MCP/Figma MCP" />
+
+<AboutHeader {...parameters} />
+
+<Callout text="Any MCP generated code is EXPERIMENTAL! You should always validate the code generated and adapt it to your own needs — do NOT simply use the MCP to generate code and push it to production! Additionally, you must have a Dev or Full account to be able to be able to use the Figma MCP." />
+
+The offical guidance and documentation comes from Figma. Please reference [Figma Dev Mode MCP documentation](https://help.figma.com/hc/en-us/articles/32132100833559-Guide-to-the-Dev-Mode-MCP-Server) for the most up to date information. This documentation below has been adapted to fit the context of the Gamut repository.
+
+## Figma (desktop client app)
+
+Go to [Figma's download page](https://www.figma.com/downloads/) to download the appropriate version of the Figma desktop client for your OS.
+
+### Start up local Figma MCP server
+
+1. In the Figma desktop client, check that you have dev mode enabled.
+2. The right-hand sidebar should have a "MCP server" section
+3. Click on the "Open settings modal" button
+4. In the modal, toggle the status to "On", the the color of the toggle should be green.
+   OR
+5. Click on the Figma icon in the top left-hand corner and select "Actions"
+6. Type "Enable desktop MCP server"
+7. Click on the checkbox, if it's not already checked, to enable the MCP server.
+
+## Set up MCP Client for your text editor/IDE
+
+We currently support Figma MCP for Cursor. Please let the Gamut team know if you'd like support for other editors.
+
+### Cursor
+
+1. Open **Cursor** → **Settings** → **Cursor Settings**.
+2. Go to the **MCP** tab (might be called **MCP & Integrations**) from the left-hand sidebar.
+3. Under **MCP Tools**, click **+ Add MCP server**.
+4. Enter the following configuration and save:
+
+```
+{
+  "mcpServers": {
+    "Figma": {
+      "url": "http://127.0.0.1:3845/mcp"
+    }
+  }
+}
+```
+
+### Verify your MCP server is running
+
+To check if your MCP server is running, you can visit the endpoint: `http://127.0.0.1:3845/mcp`. You should see a response, e.g.: `{"jsonrpc":"2.0","error":{"code":-32001,"message":"Invalid sessionId"},"id":null}`.
+Yes, it's an odd response, but it indicates that the MCP server is running — otherwise if it's not running you'll see an error "This site can’t be reached" on the page.
+
+Similarly you can test the end point using:
+
+```bash
+curl http://127.0.0.1:3845/mcp
+```
+
+## Prompt your MCP client
+
+You can prompt the MCP in two main ways:
+
+1. Provide a link to the node of the design you'd like to generate code for, e.g.:
+
+   > Generate the code for this node: https://www.figma.com/design/ReGfRNillGABAj5SlITalN/%F0%9F%93%90-Gamut?node-id=79202-13690&m=dev
+
+2. Selecting the node in the Figma interface, e.g.:
+   > Generate the code for the current selection
+
+In the chat, you may be prompted to allow the Figma commands like `get_code()` to run. You can also add these commands to an allow list in your code editor's settings.
+
+## Feedback for the Gamut team
+
+Please let the Gamut team of any feedback you have, things like:
+
+- If you find that a new rule that you'd like implemented in this repo, please let the Gamut team know.
+- Support for another text editor/IDE.
+- Incorrect code generation
+
+If you have any other feedback or suggestions, feel free to share those as well!

package/src/lib/Meta/Usage Guide.mdx

@@ -39,8 +39,7 @@ On each page is a toolbar located on the top:
 1. Grid (the 2x2 collection of squares) - applies a grid to the preview
 2. Color mode selector (the circle icon) - toggles between light and dark mode for rendered code examples
 3. Theme switcher (the paintbrush icon) - switches between different design system themes (Core, Admin, LX Studio, Percipio)
-4. LogicalProps (the two arrows icon) - toggles between physical and logical CSS properties
-5. Outline (dotted square) - applies outlines to elements in the rendered code examples
+4. Outline (dotted square) - applies outlines to elements in the rendered code examples
 
 ### Theme Switcher
 
@@ -59,10 +58,6 @@ Available themes:
 
 The theme switcher works in combination with the color mode selector, so you can test both light and dark variants of each theme.
 
-### LogicalProps
-
-The LogicalProps button (two arrows icon) provides a menu to select between Logical and Physical CSS properties.
-
 ### Showing code
 
 On the bottom right of each canvas (a rendered code example) is a button to show its code:

package/src/lib/Molecules/Alert/Alert.mdx

@@ -62,7 +62,7 @@ Use an alert to display an important, succinct message with actions for users to
 4. Dismiss button (optional)
 
 - Use to allow users to remove the alert after they've acknowledged it or when it's no longer needed
-- Only exclude when the information must remain visible until specific conditions are met to ensure users don’t miss critical information
+- Only exclude when the information must remain visible until specific conditions are met to ensure users don't miss critical information
 
 ## Variants
 

package/src/lib/Foundations/System/Props/About.mdx

@@ -1,81 +0,0 @@
-import { Meta } from '@storybook/blocks';
-
-import {
-  AboutHeader,
-  addParentPath,
-  TableOfContents,
-} from '~styleguide/blocks';
-
-import { parameters as backgroundParameters } from './Background.mdx';
-import { parameters as borderParameters } from './Border.mdx';
-import { parameters as colorParameters } from './Color.mdx';
-import { parameters as flexParameters } from './Flex.mdx';
-import { parameters as gridParameters } from './Grid.mdx';
-import { parameters as layoutParameters } from './Layout.mdx';
-import { parameters as listParameters } from './List.mdx';
-import { parameters as positioningParameters } from './Positioning.mdx';
-import { parameters as shadowParameters } from './Shadow.mdx';
-import { parameters as spaceParameters } from './Space.mdx';
-import { parameters as typographyParameters } from './Typography.mdx';
-
-export const parameters = {
-  id: 'Foundations/System/Props',
-  title: 'Props',
-  subtitle:
-    'Reusable CSS-in-JS props with predictable behaviors and a consistent API for responsive CSS.',
-  status: 'current',
-  source: {
-    repo: 'gamut-styles',
-    githubLink:
-      'https://github.com/Codecademy/gamut/blob/main/packages/gamut-styles/src/variance/config.ts',
-  },
-};
-
-<Meta title="Foundations/System/Props/About" />
-
-<AboutHeader {...parameters} />
-
-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.
-
-System props have a few facets that are important to note:
-
-- They can some times represent multiple properties.
-- They may be restricted to specific token scales but will always have access to global css values like `initial` and `none`.
-- They may have a function that transforms the given value into a standardized value (e.g. `width={.5}` => `width: 50%`)
-
-We've grouped these into a few main groups that affect simliar behaviors: `layout`, `space`, `color`, `border`, `background`, `typography`, `positioning`, `grid`, `flex`, `shadow`.
-
-You may import these groups directly from `gamut-styles`.
-
-```tsx
-import { variance } from '@codecademy/variance';
-import { system } from '@codecademy/gamut-styles';
-
-const ExampleContainer = styled.div(
-  variance.compose(system.layout, system.positioning)
-);
-
-<ExampleContainer position="absolute" width="50px" height="50px" />;
-```
-
-Each system prop has 3 important features:
-
-- `properties`: Any number of CSS Properties this prop is responsible for.
-- `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.
-- `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.
-
-<TableOfContents
-  links={addParentPath(parameters.id, [
-    layoutParameters,
-    spaceParameters,
-    typographyParameters,
-    colorParameters,
-    borderParameters,
-    flexParameters,
-    gridParameters,
-    backgroundParameters,
-    positioningParameters,
-    shadowParameters,
-    listParameters,
-  ])}
-/>

package/src/lib/Foundations/System/Props/Background.mdx

@@ -1,30 +0,0 @@
-import { Meta } from '@storybook/blocks';
-
-import { AboutHeader, TokenTable } from '~styleguide/blocks';
-
-import { defaultColumns, getPropRows } from '../../shared/elements';
-
-export const parameters = {
-  title: 'Background',
-  subtitle:
-    'Props for background manipulation (sizing / repitition / images), for background color see `colors`.',
-  status: 'current',
-};
-
-<Meta title="Foundations/System/Props/Background" />
-
-<AboutHeader {...parameters} />
-
-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.
-
-```tsx
-import styled from '@emotion/styled';
-import { system } from '@codecademy/gamut-styles';
-import myBg from './myBg.png';
-
-const BackgroundExample = styled.div(system.background);
-
-<BackgroundExample background={`url(${myBg}`} backgroundSize="cover" />;
-```
-
-<TokenTable rows={getPropRows('background')} columns={defaultColumns} />

package/src/lib/Foundations/System/Props/Border.mdx

@@ -1,33 +0,0 @@
-import { Meta } from '@storybook/blocks';
-
-import { AboutHeader, TokenTable } from '~styleguide/blocks';
-
-import { defaultColumns, getPropRows } from '../../shared/elements';
-
-export const parameters = {
-  title: 'Border',
-  subtitle: 'Border styles',
-  status: 'updating',
-};
-
-<Meta title="Foundations/System/Props/Border" />
-
-<AboutHeader {...parameters} />
-
-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.
-
-```tsx
-import styled from '@emotion/styled';
-import { system } from '@codecademy/gamut-styles';
-
-const BorderExample = styled.div(system.border);
-
-<BorderExample
-  border={1}
-  borderLeft="none"
-  borderRightStyle="dotted"
-  borderRadius="md"
-/>;
-```
-
-<TokenTable rows={getPropRows('border')} columns={defaultColumns} />

package/src/lib/Foundations/System/Props/Color.mdx

@@ -1,28 +0,0 @@
-import { Meta } from '@storybook/blocks';
-
-import { AboutHeader, TokenTable } from '~styleguide/blocks';
-
-import { defaultColumns, getPropRows } from '../../shared/elements';
-
-export const parameters = {
-  title: 'Color',
-  subtitle: 'Specific color properties',
-  status: 'current',
-};
-
-<Meta title="Foundations/System/Props/Color" />
-
-<AboutHeader {...parameters} />
-
-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.
-
-```tsx
-import styled from '@emotion/styled';
-import { system } from '@codecademy/gamut-styles';
-
-const ColorExample = styled.div(system.color);
-
-<ColorExample bg="navy" textColor="gray-100" borderColor="blue" />;
-```
-
-<TokenTable rows={getPropRows('color')} columns={defaultColumns} />

package/src/lib/Foundations/System/Props/Flex.mdx

@@ -1,28 +0,0 @@
-import { Meta } from '@storybook/blocks';
-
-import { AboutHeader, TokenTable } from '~styleguide/blocks';
-
-import { defaultColumns, getPropRows } from '../../shared/elements';
-
-export const parameters = {
-  title: 'Flex',
-  subtitle: 'Flex specific properties',
-  status: 'current',
-};
-
-<Meta title="Foundations/System/Props/Flex" />
-
-<AboutHeader {...parameters} />
-
-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.
-
-```tsx
-import styled from '@emotion/styled';
-import { system } from '@codecademy/gamut-styles';
-
-const FlexExample = styled.div(system.flex);
-
-<FlexExample flex={1} justifyContent="center" alignItems="flex-start" />;
-```
-
-<TokenTable rows={getPropRows('flex')} columns={defaultColumns} />

package/src/lib/Foundations/System/Props/Grid.mdx

@@ -1,31 +0,0 @@
-import { Meta } from '@storybook/blocks';
-
-import { AboutHeader, TokenTable } from '~styleguide/blocks';
-
-import { defaultColumns, getPropRows } from '../../shared/elements';
-
-export const parameters = {
-  title: 'Grid',
-  subtitle: 'Grid specific properties',
-  status: 'current',
-};
-
-<Meta title="Foundations/System/Props/Grid" />
-
-<AboutHeader {...parameters} />
-
-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.
-
-```tsx
-import styled from '@emotion/styled';
-import { system } from '@codecademy/gamut-styles';
-
-const GridExample = styled.div(system.grid);
-
-<GridExample
-  gridTemplateColumns="max-content 1fr max-content"
-  columnGap={32}
-/>;
-```
-
-<TokenTable rows={getPropRows('grid')} columns={defaultColumns} />

package/src/lib/Foundations/System/Props/Layout.mdx

@@ -1,45 +0,0 @@
-import { Canvas, Meta } from '@storybook/blocks';
-
-import { AboutHeader, TokenTable } from '~styleguide/blocks';
-
-import { defaultColumns, getPropRows } from '../../shared/elements';
-import * as LayoutStories from './Layout.stories';
-
-export const parameters = {
-  title: 'Layout',
-  subtitle:
-    'Props for handling dimensions and other layout specific properties.',
-  status: 'updating',
-};
-
-<Meta title="Foundations/System/Props/Layout" of={LayoutStories} />
-
-<AboutHeader {...parameters} />
-
-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.
-
-```tsx
-import styled from '@emotion/styled';
-import { system } from '@codecademy/gamut-styles';
-
-const LayoutExample = styled.div(system.layout);
-
-<LayoutExample
-  display="flex"
-  width="50%"
-  height="300px"
-  verticalAlign="middle"
-/>;
-```
-
-## Examples
-
-### Width
-
-<Canvas of={LayoutStories.WidthExample} />
-
-### Direction
-
-<Canvas of={LayoutStories.DirectionExample} />
-
-<TokenTable rows={getPropRows('layout')} columns={defaultColumns} />

package/src/lib/Foundations/System/Props/Layout.stories.tsx

@@ -1,47 +0,0 @@
-import { Box, Markdown } from '@codecademy/gamut';
-import type { Meta, StoryObj } from '@storybook/react';
-
-const meta: Meta<typeof Box> = {
-  title: 'Foundations/System/Props/Layout',
-  component: Box,
-};
-
-export default meta;
-type Story = StoryObj<typeof Box>;
-
-export const WidthExample: Story = {
-  render: () => (
-    <Box bg="background-selected" p={16}>
-      <Box
-        bg="primary"
-        color="background-contrast"
-        height="300px"
-        p={16}
-        width="50%"
-      >
-        This box has <Markdown text="`width='50%' and height='300px'`." /> It
-        takes up half the width of its container. Inspect the box to see the
-        rendered CSS property.
-      </Box>
-    </Box>
-  ),
-};
-
-export const DirectionExample: Story = {
-  render: () => (
-    <Box display="flex" flexDirection="row" gap={16}>
-      <Box bg="background-selected" p={16} width="50%">
-        <Box bg="primary" color="background-contrast" direction="ltr" p={16}>
-          <Markdown text="`direction='ltr'`." /> Left-to-right text direction
-          (default for English).
-        </Box>
-      </Box>
-      <Box bg="background-selected" p={16} width="50%">
-        <Box bg="primary" color="background-contrast" direction="rtl" p={16}>
-          <Markdown text="`direction='rtl'`." /> Right-to-left text direction
-          (used for Arabic, Hebrew, etc.).
-        </Box>
-      </Box>
-    </Box>
-  ),
-};

package/src/lib/Foundations/System/Props/List.mdx

@@ -1,38 +0,0 @@
-import { Meta } from '@storybook/blocks';
-
-import { AboutHeader, LinkTo, TokenTable } from '~styleguide/blocks';
-
-import { defaultColumns, getPropRows } from '../../shared/elements';
-
-export const parameters = {
-  title: 'List',
-  subtitle:
-    'Props for adjusting list styles when rendering a component as a `ul` or `ol`',
-  status: 'current',
-};
-
-<Meta title="Foundations/System/Props/List" />
-
-<AboutHeader {...parameters} />
-
-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.
-
-For more advanced list features, refer to the <LinkTo id="Organisms/Lists & Tables/List">List component</LinkTo>.
-
-```tsx
-import styled from '@emotion/styled';
-import { system } from '@codecademy/gamut-styles';
-
-const ListExample = styled.div(system.list);
-
-<ListExample
-  as="ul"
-  listStyleType="square"
-  listStylePosition="inside"
-  listStyleImage="none"
->
-  <ListExample as="li">a list item</ListExample>
-</ListExample>;
-```
-
-<TokenTable rows={getPropRows('list')} columns={defaultColumns} />

package/src/lib/Foundations/System/Props/Positioning.mdx

@@ -1,29 +0,0 @@
-import { Meta } from '@storybook/blocks';
-
-import { AboutHeader, TokenTable } from '~styleguide/blocks';
-
-import { defaultColumns, getPropRows } from '../../shared/elements';
-
-export const parameters = {
-  title: 'Positioning',
-  subtitle:
-    'Props that affect stacking and position contexts. Like `top`, `position` and `opacity`.',
-  status: 'updating',
-};
-
-<Meta title="Foundations/System/Props/Positioning" />
-
-<AboutHeader {...parameters} />
-
-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.
-
-```tsx
-import styled from '@emotion/styled';
-import { system } from '@codecademy/gamut-styles';
-
-const PositioningExample = styled.div(system.positioning);
-
-<PositioningExample position="absolute" zIndex={2} top="0" left="0" />;
-```
-
-<TokenTable rows={getPropRows('positioning')} columns={defaultColumns} />

package/src/lib/Foundations/System/Props/Shadow.mdx

@@ -1,31 +0,0 @@
-import { Meta } from '@storybook/blocks';
-
-import { AboutHeader, TokenTable } from '~styleguide/blocks';
-
-import { defaultColumns, getPropRows } from '../../shared/elements';
-
-export const parameters = {
-  title: 'Shadow',
-  subtitle: 'Props for box and text shadows.',
-  status: 'current',
-};
-
-<Meta title="Foundations/System/Props/Shadow" />
-
-<AboutHeader {...parameters} />
-
-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.
-
-```tsx
-import styled from '@emotion/styled';
-import { system } from '@codecademy/gamut-styles';
-
-const ShadowExample = styled.div(system.shadow);
-
-<ShadowExample
-  boxShadow="0 0 4px rgba(0, 0, 0, .15)"
-  textShadow="0 0 4px rgba(0, 0, 0, .15)"
-/>;
-```
-
-<TokenTable rows={getPropRows('shadows')} columns={defaultColumns} />

package/src/lib/Foundations/System/Props/Space.mdx

@@ -1,44 +0,0 @@
-import { Canvas, Meta } from '@storybook/blocks';
-
-import { AboutHeader, Callout, TokenTable } from '~styleguide/blocks';
-
-import { defaultColumns, getPropRows } from '../../shared/elements';
-import * as SpaceStories from './Space.stories';
-
-export const parameters = {
-  title: 'Space',
-  subtitle: 'Props for maintaining specific vertical and horizontal rhythms',
-  status: 'updating',
-};
-
-<Meta of={SpaceStories} title="Foundations/System/Props/Space" />
-
-<AboutHeader {...parameters} />
-
-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.
-
-```tsx
-import styled from '@emotion/styled';
-import { system } from '@codecademy/gamut-styles';
-
-const SpaceExample = styled.div(system.space);
-
-<SpaceExample p={8} my={[16, 24, 32]} />;
-```
-
-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.
-
-<Callout
-  text={
-    <>
-      You can use the <strong>LogicalProps</strong> button in the toolbar to
-      switch between modes.
-    </>
-  }
-/>
-
-<Canvas of={SpaceStories.MarginExample} />
-
-<Canvas of={SpaceStories.PaddingExample} />
-
-<TokenTable rows={getPropRows('space')} columns={defaultColumns} />

package/src/lib/Foundations/System/Props/Space.stories.tsx

@@ -1,48 +0,0 @@
-import { Box, Markdown } from '@codecademy/gamut';
-import type { Meta, StoryObj } from '@storybook/react';
-
-const meta: Meta<typeof Box> = {
-  title: 'Foundations/System/Props/Space',
-  component: Box,
-};
-
-export default meta;
-type Story = StoryObj<typeof Box>;
-
-export const MarginExample: Story = {
-  render: () => (
-    <Box
-      bg="primary"
-      color="background-contrast"
-      mb={64}
-      ml={16}
-      mr={32}
-      mt={4}
-      textAlign="center"
-    >
-      This box has{' '}
-      <Markdown text="`mt={4}`, `mr={32}`, `mb={64}`, and `ml={16}`." /> Inspect
-      the example to see what CSS properties are rendered.
-    </Box>
-  ),
-};
-
-export const PaddingExample: Story = {
-  render: () => (
-    <Box bg="background-selected">
-      <Box
-        bg="primary"
-        color="background-contrast"
-        pb={64}
-        pl={16}
-        pr={32}
-        pt={4}
-        textAlign="center"
-      >
-        This box has{' '}
-        <Markdown text="`pt={4}`, `pr={32}`, `pb={64}`, and `pl={16}`." />{' '}
-        Inspect the example to see what CSS properties are rendered.
-      </Box>
-    </Box>
-  ),
-};