Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ root.render(

Use the provided `DiamondDSTheme` with the ThemeProvider, or create your own. The theme controls colour via semantic surface tokens and consists of two parts:
- Theme configuration (`DiamondDSTheme.ts`)
- Semantic role tokens (`diamond-ds-roles.css`)
- Semantic tokens (`DiamondDSTokens.css`)

Navigation components support either static links (with href) or the use of a routing library (with linkComponent and to).
For NavLink and FooterLink, if both linkComponent and to are provided, it will use linkComponent. If not, it falls back to using href.
Expand Down
4 changes: 2 additions & 2 deletions src/storybook/Installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Use this page to install SciReactUI, configure the Diamond Design System theme,

The design system theme consists of two parts:
- Theme configuration (DiamondDSTheme.ts)
- Semantic role tokens (diamond-ds-roles.css)
- Semantic tokens (DiamondDSTokens.css)

### Finally, add the Components

Expand Down Expand Up @@ -176,7 +176,7 @@ Use this page to install SciReactUI, configure the Diamond Design System theme,

1. Copy the base files and rename them for your own project:
- DiamondDSTheme.ts -> MyDSTheme.ts
- diamond-ds-tokens.css -> my-ds-tokens.css
- DiamondDSTokens.css -> MyDSTokens.css

2. Update the CSS tokens

Expand Down
4 changes: 2 additions & 2 deletions src/themes/DiamondDSTheme.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ import { dirname, resolve } from "node:path";
const tokensCss = readFileSync(
resolve(
dirname(fileURLToPath(import.meta.url)),
"../styles/diamondDS/DiamondDSTokens.css",
"../styles/DiamondDSTokens.css",
),
"utf8",
);

const typographyCss = readFileSync(
resolve(
dirname(fileURLToPath(import.meta.url)),
"../styles/diamondDS/DiamondDSTypography.css",
"../styles/DiamondDSTypography.css",
),
"utf8",
);
Expand Down
6 changes: 3 additions & 3 deletions src/themes/DiamondDSTheme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* into MUI's theme system, component model and runtime styling APIs.
*
* CSS variables are the source of truth.
* These are defined in diamond-ds-tokens.css.
* These are defined in DiamondDSTokens.css.
*
* Tokens are the CSS variables.
* Roles are the semantic values exposed through the MUI palette and component APIs.
Expand All @@ -19,8 +19,8 @@ import "@fontsource-variable/inter";
import "@fontsource-variable/outfit";
import "@fontsource/ibm-plex-mono/latin-400.css";
import "@fontsource/ibm-plex-mono/latin-600.css";
import "../styles/diamondDS/DiamondDSTokens.css";
import "../styles/diamondDS/DiamondDSTypography.css";
import "../styles/DiamondDSTokens.css";
import "../styles/DiamondDSTypography.css";

// Enables `theme.vars` typings for MUI CSS variable themes.
import type {} from "@mui/material/themeCssVarsAugmentation";
Expand Down
Loading