Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pigment-css] Create a wrapper package over Pigment CSS #42819

Merged
merged 24 commits into from
Jul 10, 2024
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
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
6 changes: 0 additions & 6 deletions apps/local-ui-lib/.eslintrc

This file was deleted.

9 changes: 0 additions & 9 deletions apps/local-ui-lib/index.d.ts

This file was deleted.

30 changes: 0 additions & 30 deletions apps/local-ui-lib/index.js

This file was deleted.

8 changes: 0 additions & 8 deletions apps/local-ui-lib/package.json

This file was deleted.

3 changes: 0 additions & 3 deletions apps/local-ui-lib/tsconfig.json

This file was deleted.

5 changes: 3 additions & 2 deletions apps/pigment-css-next-app/.eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"rules": {
"import/prefer-default-export": "off",
"import/extensions": "off",
"import/no-unresolved": "off"
}
"import/no-unresolved": "off",
"react/no-unknown-property": ["error", { "ignore": ["sx"] }],
},
}
30 changes: 1 addition & 29 deletions apps/pigment-css-next-app/next.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,44 +97,16 @@ theme.getColorSchemeSelector = (colorScheme) => {
};
theme.toRuntimeSource = stringifyTheme;

function innerNoop() {
return null;
}
function outerNoop() {
return innerNoop;
}

/**
* @type {PigmentOptions}
*/
const pigmentOptions = {
theme,
transformLibraries: ['local-ui-lib'],
sourceMap: true,
displayName: true,
overrideContext: (context) => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

if (!context.$RefreshSig$) {
context.$RefreshSig$ = outerNoop;
}
return {
...context,
require: (id) => {
if (id === '@mui/styled-engine' || id === '@mui/styled-engine-sc') {
return {
__esModule: true,
default: () => () => () => null,
internal_processStyles: () => {},
keyframes: () => '',
css: () => '',
};
}
return context.require(id);
},
};
},
};

/** @type {import('next').NextConfig} */
/** @type {import('@pigment-css/nextjs-plugin').NextConfig} */
const nextConfig = {
eslint: {
ignoreDuringBuilds: true,
Expand Down
5 changes: 2 additions & 3 deletions apps/pigment-css-next-app/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"clean": "rimraf .next"
},
"dependencies": {
"@pigment-css/react": "^0.0.16",
"@mui/material-pigment-css": "workspace:^",
"@mui/utils": "workspace:^",
"@mui/base": "workspace:^",
"@mui/icons-material": "workspace:^",
Expand All @@ -18,13 +18,12 @@
"@mui/material-nextjs": "workspace:^",
"@mui/system": "workspace:^",
"@emotion/cache": "latest",
"local-ui-lib": "workspace:^",
"next": "latest",
"react": "^18.3.1",
"react-dom": "^18.3.1"
},
"devDependencies": {
"@pigment-css/nextjs-plugin": "^0.0.16",
"@pigment-css/nextjs-plugin": "0.0.17",
"@types/node": "^20.5.7",
"@types/react": "^18.3.3",
"@types/react-dom": "^18.3.0",
Expand Down
2 changes: 1 addition & 1 deletion apps/pigment-css-next-app/src/app/box/page.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable material-ui/no-empty-box */

import { styled } from '@pigment-css/react';
import { styled } from '@mui/material-pigment-css';
import * as React from 'react';
import { Box as MuiBox } from '../../components/Box';

Expand Down
2 changes: 1 addition & 1 deletion apps/pigment-css-next-app/src/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { Metadata } from 'next';
import { Inter } from 'next/font/google';
import { AppRouterCacheProvider } from '@mui/material-nextjs/v14-appRouter';
import { ThemeProvider } from '@mui/material/styles';
import '@pigment-css/react/styles.css';
import '@mui/material-pigment-css/styles.css';
import theme from './theme';

import './globals.css';
Expand Down
2 changes: 1 addition & 1 deletion apps/pigment-css-next-app/src/app/material-ui/layout.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from 'react';
import { styled } from '@pigment-css/react';
import { styled } from '@mui/material-pigment-css';

const Main = styled('div')(({ theme }) => ({
display: 'flex',
Expand Down
12 changes: 6 additions & 6 deletions apps/pigment-css-next-app/src/app/material-ui/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ import * as React from 'react';
import Link from 'next/link';
import fs from 'fs/promises';
import path from 'path';
import { css } from '@pigment-css/react';
import Box from '@pigment-css/react/Box';
import { css } from '@mui/material-pigment-css';

export default async function MaterialUIPage() {
const rootPaths = await fs.readdir(path.join(process.cwd(), `src/app/material-ui`));
const rootPaths = (await fs.readdir(path.join(process.cwd(), `src/app/material-ui`))).filter(
(p) => !p.startsWith('.'),
);
return (
<div>
<h1>Material UI Components</h1>
<nav>
<Box
brijeshb42 marked this conversation as resolved.
Show resolved Hide resolved
as="ul"
<ul
sx={{
margin: 0,
marginBlock: '1rem',
Expand All @@ -39,7 +39,7 @@ export default async function MaterialUIPage() {
</Link>
</li>
))}
</Box>
</ul>
</nav>
</div>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import * as React from 'react';
import Box from '@mui/material/Box';
import Paper from '@mui/material/Paper';
import Grid from '@mui/material/PigmentGrid';
import { styled } from '@pigment-css/react';
import { styled } from '@mui/material-pigment-css';

const Item = styled(Paper)(({ theme }) => ({
backgroundColor: '#fff',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import * as React from 'react';
import Divider from '@mui/material/Divider';
import Paper from '@mui/material/Paper';
import Stack from '@mui/material/PigmentStack';
import { styled } from '@pigment-css/react';
import { styled } from '@mui/material-pigment-css';

const Item = styled(Paper)(({ theme }) => ({
backgroundColor: '#fff',
Expand Down
2 changes: 1 addition & 1 deletion apps/pigment-css-next-app/src/app/page.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Image from 'next/image';
import { styled, css } from '@pigment-css/react';
import { styled, css } from '@mui/material-pigment-css';
import PigmentStack from '@mui/material/PigmentStack';
import PigmentContainer from '@mui/material/PigmentContainer';
import PigmentHidden from '@mui/material/PigmentHidden';
Expand Down
72 changes: 43 additions & 29 deletions apps/pigment-css-next-app/src/augment.d.ts
Original file line number Diff line number Diff line change
@@ -1,34 +1,48 @@
import type { ExtendTheme } from '@pigment-css/react';
import type { ExtendTheme } from '@mui/material-pigment-css';

declare module '@pigment-css/react/theme' {
interface ThemeTokens {
'max-width': string;
'border-radius': string;
'font-mono': string;
'foreground-rgb': string;
'background-start-rgb': string;
'background-end-rgb': string;
'primary-glow': string;
'secondary-glow': string;
title: {
'start-rgb': string;
'end-rgb': string;
border: string;
};
callout: {
rgb: string;
'border-rgb': string;
};
card: {
rgb: string;
'border-rgb': string;
};
}
interface ThemeTokens {
'max-width': string;
'border-radius': string;
'font-mono': string;
'foreground-rgb': string;
'background-start-rgb': string;
'background-end-rgb': string;
'primary-glow': string;
'secondary-glow': string;
title: {
'start-rgb': string;
'end-rgb': string;
border: string;
};
callout: {
rgb: string;
'border-rgb': string;
};
card: {
rgb: string;
'border-rgb': string;
};
}

type CustomTheme = ExtendTheme<{
colorScheme: 'light' | 'dark';
tokens: ThemeTokens;
}>;

declare module '@mui/material-pigment-css/theme' {
interface ThemeArgs {
theme: ExtendTheme<{
colorScheme: 'light' | 'dark';
tokens: ThemeTokens;
}>;
theme: CustomTheme;
}
}

declare global {
namespace React {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
interface HTMLAttributes<T> {
sx?:
| React.CSSProperties
| ((theme: CustomTheme) => React.CSSProperties)
| ReadonlyArray<React.CSSProperties | ((theme: CustomTheme) => React.CSSProperties)>;
}
}
}
2 changes: 1 addition & 1 deletion apps/pigment-css-next-app/src/components/Box.jsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { generateAtomics } from '@pigment-css/react';
import { generateAtomics } from '@mui/material-pigment-css';

const atomics = generateAtomics(({ theme }) => ({
conditions: Object.keys(theme.breakpoints.values).reduce((acc, breakpoint) => {
Expand Down
5 changes: 3 additions & 2 deletions apps/pigment-css-vite-app/.eslintrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"rules": {
"import/prefer-default-export": "off",
"react/react-in-jsx-scope": "off"
}
"react/react-in-jsx-scope": "off",
"react/no-unknown-property": ["error", { "ignore": ["sx"] }],
},
}
5 changes: 2 additions & 3 deletions apps/pigment-css-vite-app/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,14 @@
"build": "vite build"
},
"dependencies": {
"@pigment-css/react": "^0.0.16",
"@mui/material-pigment-css": "workspace:^",
"@mui/utils": "workspace:^",
"@mui/base": "workspace:^",
"@mui/icons-material": "workspace:^",
"@mui/lab": "workspace:^",
"@mui/material": "workspace:^",
"@mui/system": "workspace:^",
"clsx": "^2.1.1",
"local-ui-lib": "workspace:^",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"react-error-boundary": "^4.0.13",
Expand All @@ -27,7 +26,7 @@
"devDependencies": {
"@babel/preset-react": "^7.24.7",
"@babel/preset-typescript": "^7.24.7",
"@pigment-css/vite-plugin": "^0.0.16",
"@pigment-css/vite-plugin": "0.0.17",
"@types/react": "^18.3.3",
"@types/react-dom": "^18.3.0",
"@vitejs/plugin-react": "^4.3.1",
Expand Down
2 changes: 1 addition & 1 deletion apps/pigment-css-vite-app/src/Box.jsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { generateAtomics } from '@pigment-css/react';
import { generateAtomics } from '@mui/material-pigment-css';

const atomics = generateAtomics(({ theme }) => ({
conditions: Object.keys(theme.breakpoints.values).reduce((acc, breakpoint) => {
Expand Down
2 changes: 1 addition & 1 deletion apps/pigment-css-vite-app/src/Layout.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from 'react';
import { styled } from '@pigment-css/react';
import { styled } from '@mui/material-pigment-css';

const Main = styled.main(({ theme }) => ({
display: 'flex',
Expand Down
2 changes: 1 addition & 1 deletion apps/pigment-css-vite-app/src/Slider/ZeroSlider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
getSliderUtilityClass,
} from '@mui/material/Slider';
import { isHostComponent, useSlotProps } from '@mui/base/utils';
import { styled } from '@pigment-css/react';
import { styled } from '@mui/material-pigment-css';
import { capitalize } from '@mui/material/utils';
import { SliderValueLabel } from '@mui/material/Slider';
import { useSlider, valueToPercent } from '@mui/base/useSlider';
Expand Down
23 changes: 18 additions & 5 deletions apps/pigment-css-vite-app/src/augment.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import type { extendTheme } from '@mui/material/styles';
import '@pigment-css/react/theme';
import '@mui/material-pigment-css';

declare module '@pigment-css/react/theme' {
type CustomTheme = ReturnType<typeof extendTheme> & {
applyDarkStyles<T>(obj: T): Record<string, T>;
};
declare module '@mui/material-pigment-css/theme' {
export interface ThemeArgs {
theme: ReturnType<typeof extendTheme> & {
applyDarkStyles<T>(obj: T): Record<string, T>;
};
theme: CustomTheme;
}
}

Expand All @@ -17,3 +18,15 @@ declare module '@mui/material' {
mainChannel: string;
}
}

declare global {
namespace React {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
interface HTMLAttributes<T> {
sx?:
| React.CSSProperties
| ((theme: CustomTheme) => React.CSSProperties)
| ReadonlyArray<React.CSSProperties | ((theme: CustomTheme) => React.CSSProperties)>;
}
}
}
Loading
Loading