Skip to content

chore: ui-library-migration #108

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

chore: ui-library-migration #108

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ce952c
chore: ui-library-migration
tractorss Apr 3, 2025
d09d2e2
fix: theme-style-flashing
tractorss Apr 3, 2025
a14cede
chore: ui-library-update
tractorss Apr 4, 2025
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
3 changes: 2 additions & 1 deletion web/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,9 @@
},
"dependencies": {
"@cyntler/react-doc-viewer": "^1.16.3",
"@internationalized/date": "^3.7.0",
"@kleros/kleros-app": "^2.0.2",
"@kleros/ui-components-library": "^2.19.0",
"@kleros/ui-components-library": "3.0.0-rc1",
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Major version upgrade to pre-release version

The dependency @kleros/ui-components-library has been updated from ^2.19.0 to 3.0.0-rc1.

This is a significant version bump (from v2 to v3) and it's using a release candidate. This may introduce breaking changes across the application.

Before deploying to production, verify that:

  1. All components using this library have been properly migrated
  2. Thorough testing has been performed on all screens
  3. You have a rollback plan if issues are discovered with this RC version

🏁 Script executed:

#!/bin/bash
# Check for any remaining onClick props that should be migrated to onPress
echo "Checking for any remaining onClick props that need to be migrated..."
rg --type-add 'tsx:*.tsx' --type tsx 'onClick=' -A 1 -B 1 | grep -v "native HTML"

Length of output: 5607

Major Release Candidate Update – Action Required

The dependency update in web/package.json at line 71 bumps @kleros/ui-components-library from ^2.19.0 to 3.0.0-rc1, which is a major upgrade using a release candidate. This change may introduce breaking changes, notably in how event handlers are handled.

Before deploying to production, please ensure that:

  • Component Migration: All components using the library have been reviewed according to the new v3 guidelines. In particular, verify whether event handler props should be updated from onClick to onPress.

    • The recent scan revealed several components (e.g., those in web/src/pages/NewTransaction/Terms/Payment/GeneralTransaction/TokenSelector/, .../DropdownButton.tsx, .../MaxBalance.tsx, and others in DesktopHeader.tsx, MobileHeader.tsx, etc.) still using onClick. Confirm if these are intentional or if a migration to onPress is required.

  • Thorough Testing: All screens should be fully tested to catch any issues arising from this breaking change.

  • Rollback Plan: A solid rollback strategy must be established should any incompatibilities or issues occur during deployment.

Please address these points to ensure a smooth transition with the new pre-release version.

"@reown/appkit": "^1.6.6",
"@reown/appkit-adapter-wagmi": "^1.6.6",
"@sentry/react": "^7.93.0",
Expand Down
4 changes: 3 additions & 1 deletion web/src/app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { Navigate, Route } from "react-router-dom";
import { SentryRoutes } from "./utils/sentry";
import "react-loading-skeleton/dist/skeleton.css";
import "react-toastify/dist/ReactToastify.css";
import "@kleros/ui-components-library/dist/ui-components-library.css";
import Web3Provider from "context/Web3Provider";
import IsListProvider from "context/IsListProvider";
import QueryClientProvider from "context/QueryClientProvider";
Expand All @@ -15,6 +16,7 @@ import { NewTransactionProvider } from "./context/NewTransactionContext";
import AttachmentDisplay from "./pages/AttachmentDisplay";
import AtlasProvider from "./context/AtlasProvider";
import Settings from "./pages/Settings";
import { StyledH1 } from "./components/StyledTags";

const App: React.FC = () => {
return (
Expand All @@ -32,7 +34,7 @@ const App: React.FC = () => {
<Route path="transactions/*" element={<MyTransactions />} />
<Route path="attachment/*" element={<AttachmentDisplay />} />
<Route path="settings/*" element={<Settings />} />
<Route path="*" element={<h1>404 not found</h1>} />
<Route path="*" element={<StyledH1>404 not found</StyledH1>} />
</Route>
</SentryRoutes>
</NewTransactionProvider>
Expand Down
5 changes: 3 additions & 2 deletions web/src/components/ConnectWallet/AccountDisplay.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { getChain } from "consts/chains";
import { shortenAddress } from "utils/shortenAddress";

import { landscapeStyle } from "styles/landscapeStyle";
import { StyledLabel } from "../StyledTags";

const Container = styled.div`
display: flex;
Expand Down Expand Up @@ -153,13 +154,13 @@ export const AddressOrName: React.FC<IAddressOrName> = ({ address: propAddress }
chainId: 1,
});

return <label>{data ?? (isAddress(address!) ? shortenAddress(address) : address)}</label>;
return <StyledLabel>{data ?? (isAddress(address!) ? shortenAddress(address) : address)}</StyledLabel>;
};

export const ChainDisplay: React.FC = () => {
const chainId = useChainId();
const chain = getChain(chainId);
return <label>{chain?.name}</label>;
return <StyledLabel>{chain?.name}</StyledLabel>;
};

const AccountDisplay: React.FC = () => {
Expand Down
8 changes: 4 additions & 4 deletions web/src/components/ConnectWallet/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ export const SwitchChainButton: React.FC<{ className?: string }> = ({ className
<Button
{...{ className }}
isLoading={isPending}
disabled={isPending}
isDisabled={isPending}
text={`Switch to ${SUPPORTED_CHAINS[DEFAULT_CHAIN].name}`}
onClick={handleSwitch}
onPress={handleSwitch}
/>
);
};
Expand All @@ -35,10 +35,10 @@ const ConnectButton: React.FC<{ className?: string }> = ({ className }) => {
return (
<Button
{...{ className }}
disabled={isOpen}
isDisabled={isOpen}
small
text={"Connect"}
onClick={async () => open({ view: "Connect" })}
onPress={async () => open({ view: "Connect" })}
/>
);
};
Expand Down
7 changes: 4 additions & 3 deletions web/src/components/EnsureAuth.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { Button } from "@kleros/ui-components-library";
import styled from "styled-components";
import { useAtlasProvider } from "@kleros/kleros-app";
import { errorToast, infoToast, successToast } from "utils/wrapWithToast";
import { StyledP } from "./StyledTags";

const Container = styled.div`
display: flex;
Expand All @@ -16,7 +17,7 @@ const Container = styled.div`
align-items: center;
`;

const StyledInfo = styled.p`
const StyledInfo = styled(StyledP)`
margin: 0;
padding: 0;
`;
Expand Down Expand Up @@ -49,8 +50,8 @@ export const EnsureAuth: React.FC<IEnsureAuth> = ({ children, message, buttonTex
{message ? <StyledInfo>{message}</StyledInfo> : null}
<Button
text={buttonText ?? "Sign In"}
onClick={handleClick}
disabled={isSigningIn || !address}
onPress={handleClick}
isDisabled={isSigningIn || !address}
isLoading={isSigningIn}
{...{ className }}
/>
Expand Down
5 changes: 3 additions & 2 deletions web/src/components/LightButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { landscapeStyle } from "styles/landscapeStyle";
import { hoverShortTransitionTiming } from "styles/commonStyles";

import { Button } from "@kleros/ui-components-library";
import { type ButtonProps } from "@kleros/ui-components-library/dist/lib/button";

const StyledButton = styled(Button)<{ isMobileNavbar?: boolean }>`
${hoverShortTransitionTiming}
Expand Down Expand Up @@ -38,14 +39,14 @@ const StyledButton = styled(Button)<{ isMobileNavbar?: boolean }>`
interface ILightButton {
text: string;
Icon?: React.FC<React.SVGAttributes<SVGElement>>;
onClick?: React.MouseEventHandler<HTMLButtonElement>;
onClick?: ButtonProps["onPress"];
disabled?: boolean;
className?: string;
isMobileNavbar?: boolean;
}

const LightButton: React.FC<ILightButton> = ({ text, Icon, onClick, disabled, className, isMobileNavbar }) => (
<StyledButton variant="primary" small {...{ text, Icon, onClick, disabled, className, isMobileNavbar }} />
<StyledButton variant="primary" small {...{ text, Icon, onPress: onClick, disabled, className, isMobileNavbar }} />
);

export default LightButton;
2 changes: 1 addition & 1 deletion web/src/components/OpenModalRaiseDisputeButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const OpenModalRaiseDisputeButton: React.FC<IOpenModalRaiseDisputeButton> = ({ a

return (
<>
<Button variant="secondary" text={"Raise a dispute"} onClick={toggleModal} />
<Button variant="secondary" text={"Raise a dispute"} onPress={toggleModal} />
{isModalOpen ? <RaiseDisputeModal {...{ toggleModal, arbitrationCost }} /> : null}
</>
);
Expand Down
9 changes: 5 additions & 4 deletions web/src/components/PreviewCard/Header.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { mapStatusToEnum } from "utils/mapStatusToEnum";
import { StyledSkeleton } from "../StyledSkeleton";
import StatusBanner from "../TransactionCard/StatusBanner";
import EtherscanIcon from "svgs/icons/etherscan.svg";
import { StyledH1, StyledLabel as Label, StyledA } from "../StyledTags";

const Container = styled.div`
display: flex;
Expand All @@ -17,11 +18,11 @@ const Container = styled.div`
gap: 12px;
`;

const StyledLabel = styled.label`
const StyledLabel = styled(Label)`
color: ${({ theme }) => theme.secondaryPurple};
`;

const StyledHeader = styled.h1`
const StyledHeader = styled(StyledH1)`
margin: 0;
flex-wrap: wrap;
word-break: break-word;
Expand Down Expand Up @@ -75,9 +76,9 @@ const Header: React.FC<IHeader> = ({ escrowType, escrowTitle, id, status, transa
</LeftContent>
<RightContent>
{transactionHash ? (
<a href={etherscanUrl} target="_blank" rel="noreferrer">
<StyledA href={etherscanUrl} target="_blank" rel="noreferrer">
<StyledEtherscanIcon />
</a>
</StyledA>
) : null}
<StatusBanner status={currentStatusEnum} isPreview={true} />
</RightContent>
Expand Down
3 changes: 2 additions & 1 deletion web/src/components/PreviewCard/Terms/Header.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import React from "react";
import styled from "styled-components";
import { StyledH3 } from "components/StyledTags";

const StyledHeader = styled.h3`
const StyledHeader = styled(StyledH3)`
margin-bottom: 0;
`;

Expand Down
58 changes: 58 additions & 0 deletions web/src/components/StyledTags/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import styled from "styled-components";

export const StyledH1 = styled.h1`
margin: 0 0 16px 0;
font-weight: 600;
font-size: 24px;
line-height: 32px;
color: ${({ theme }) => theme.primaryText};
`;

export const StyledH2 = styled.h2`
margin: 0 0 16px 0;
font-weight: 400;
font-size: 24px;
line-height: 32px;
color: ${({ theme }) => theme.primaryText};
`;

export const StyledH3 = styled.h3`
margin: 0 0 16px 0;
font-weight: 600;
font-size: 16px;
line-height: 24px;
color: ${({ theme }) => theme.primaryText};
`;

export const StyledP = styled.p`
font-weight: 400;
font-size: 16px;
line-height: 24px;
color: ${({ theme }) => theme.primaryText};
`;

export const StyledSmall = styled.small`
font-weight: 600;
font-size: 14px;
line-height: 18px;
color: ${({ theme }) => theme.primaryText};
`;

export const StyledLabel = styled.label`
font-weight: 400;
font-size: 14px;
line-height: 18px;
color: ${({ theme }) => theme.secondaryText};
`;

export const StyledA = styled.a`
font-weight: 400;
font-size: 14px;
text-decoration: none;
color: ${({ theme }) => theme.primaryBlue};
`;

export const StyledHr = styled.hr`
opacity: 1;
border: 1px solid ${({ theme }) => theme.stroke};
`;
5 changes: 3 additions & 2 deletions web/src/components/TransactionCard/StatusBanner.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import React, { useMemo } from "react";
import styled, { Theme, useTheme, css } from "styled-components";
import { Statuses } from "consts/statuses";
import { isUndefined } from "utils/index";
import { StyledLabel as Label } from "../StyledTags";

interface IContainer {
isCard: boolean;
Expand Down Expand Up @@ -34,7 +35,7 @@ const Container = styled.div<IContainer>`
}};
`;

const StyledLabel = styled.label<{ frontColor: string; withDot?: boolean; isCard?: boolean }>`
const StyledLabel = styled(Label)<{ frontColor: string; withDot?: boolean; isCard?: boolean }>`
display: flex;
align-items: center;
color: ${({ frontColor }) => frontColor};
Expand All @@ -61,7 +62,7 @@ const StyledLabel = styled.label<{ frontColor: string; withDot?: boolean; isCard
: null}
`;

const StyledNumberLabel = styled.label<{ frontColor: string; withDot?: boolean; isCard?: boolean }>`
const StyledNumberLabel = styled(Label)<{ frontColor: string; withDot?: boolean; isCard?: boolean }>`
display: flex;
align-items: center;
color: ${({ frontColor }) => frontColor};
Expand Down
3 changes: 2 additions & 1 deletion web/src/components/TransactionCard/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import { TransactionDetailsFragment } from "src/graphql/graphql";
import { StyledSkeleton, StyledSkeletonTitle } from "../StyledSkeleton";
import TransactionInfo from "../TransactionInfo";
import StatusBanner from "./StatusBanner";
import { StyledH3 } from "../StyledTags";

const StyledCard = styled(Card)`
width: 100%;
Expand Down Expand Up @@ -55,7 +56,7 @@ const ListContainer = styled.div`

const ListTitle = styled.div``;

const StyledTitle = styled.h3`
const StyledTitle = styled(StyledH3)`
margin: 0;
`;

Expand Down
5 changes: 3 additions & 2 deletions web/src/components/TransactionInfo/Field.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import React from "react";
import styled, { css } from "styled-components";
import { landscapeStyle } from "styles/landscapeStyle";
import { Link } from "react-router-dom";
import { StyledLabel } from "../StyledTags";

type FieldContainerProps = {
width?: string;
Expand Down Expand Up @@ -43,7 +44,7 @@ const FieldContainer = styled.div<FieldContainerProps>`
`};
`;

const StyledValue = styled.label<{ isPreview?: boolean }>`
const StyledValue = styled(StyledLabel)<{ isPreview?: boolean }>`
flex-grow: 1;
text-align: end;
color: ${({ theme }) => theme.primaryText};
Expand All @@ -64,7 +65,7 @@ const StyledLink = styled(Link)`
}
`;

const NameLabel = styled.label<{ isList?: boolean; name: string; isPreview?: boolean }>`
const NameLabel = styled(StyledLabel)<{ isList?: boolean; name: string; isPreview?: boolean }>`
${({ isList, name }) =>
isList &&
css`
Expand Down
20 changes: 10 additions & 10 deletions web/src/components/TransactionInfo/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import CalendarIcon from "svgs/icons/calendar.svg";
import PileCoinsIcon from "svgs/icons/pile-coins.svg";
import UserIcon from "svgs/icons/user.svg";
import Field from "./Field";
import { StyledA as A } from "../StyledTags";

const Container = styled.div<{ isList: boolean; isPreview?: boolean }>`
display: flex;
Expand Down Expand Up @@ -49,7 +50,7 @@ const RestOfFieldsContainer = styled.div<{ isList?: boolean; isPreview?: boolean
flex-direction: row;
flex-wrap: wrap;
justify-content: flex-start;
`};
`};

${({ isList, isPreview }) =>
isList &&
Expand All @@ -71,10 +72,9 @@ const RestOfFieldsContainer = styled.div<{ isList?: boolean; isPreview?: boolean
`
)}
`};

`;

const StyledA = styled.a`
const StyledA = styled(A)`
color: ${({ theme }) => theme.primaryText};
font-weight: 600;

Expand Down Expand Up @@ -107,13 +107,13 @@ const TransactionInfo: React.FC<ITransactionInfo> = ({
const { isList } = useIsList();
const displayAsList = isList && !overrideIsList;

const { data: buyerEns } = useEnsName({
address: buyerAddress as `0x${string}`,
chainId: 1
const { data: buyerEns } = useEnsName({
address: buyerAddress as `0x${string}`,
chainId: 1,
});
const { data: sellerEns } = useEnsName({
address: sellerAddress as `0x${string}`,
chainId: 1
const { data: sellerEns } = useEnsName({
address: sellerAddress as `0x${string}`,
chainId: 1,
});

const displayBuyerAddress = buyerEns || shortenAddress(buyerAddress);
Expand Down Expand Up @@ -195,4 +195,4 @@ const TransactionInfo: React.FC<ITransactionInfo> = ({
);
};

export default TransactionInfo;
export default TransactionInfo;
Loading