feat: Revamp library using new Safe Theme

.github/workflows/lint.yml

@@ -6,4 +6,14 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - uses: actions/checkout@v3
- - uses: gnosis/safe-react-eslint-plus-action@v4.0.1
+
+ - uses: actions/setup-node@v3
+ with:
+ node-version: 18
+ cache: yarn
+
+ - name: Install Dependencies
+ run: yarn install --frozen-lockfile
+
+ - name: Run eslint
+ run: yarn lint:check

.github/workflows/test.yml

@@ -1,6 +1,9 @@
 name: Unit tests
 on:
  pull_request:
+ push:
+ branches:
+ - main
 
 jobs:
  test:

.storybook/main.js

@@ -1,4 +1,7 @@
 module.exports = {
+ core: {
+ builder: 'webpack5',
+ },
  stories: ['../src/**/*.stories.tsx'],
  addons: [
  '@storybook/addon-actions',
@@ -7,4 +10,5 @@ module.exports = {
  '@storybook/addon-links',
  'storybook-addon-react-docgen',
  ],
+ staticDirs: ['../src/assets/fonts'],
 };

.storybook/manager.js

@@ -1,10 +1,14 @@
+import { create } from '@storybook/theming/create';
 import { addons } from '@storybook/addons';
-import gnosisTheme from './gnosisTheme';
-
 
 addons.setConfig({
+ disableTelemetry: true,
  enableShortcuts: false,
  showNav: true,
  showPanel: false,
- theme: gnosisTheme,
+ theme: storyBookTheme,
+});
+
+const storyBookTheme = create({
+ base: 'light',
 });

.storybook/preview-head.html

@@ -0,0 +1 @@
+<link rel="stylesheet" href="/fonts.css" />

.storybook/preview.js

@@ -1,15 +1,53 @@
 import React from 'react';
 import { addDecorator } from '@storybook/react';
 import { addParameters } from '@storybook/react';
-import { ThemeProvider } from 'styled-components';
 
-import theme from '../src/theme';
+import {
+ Stack,
+ Typography,
+ IconButton,
+ Card,
+ CardContent,
+ CssBaseline,
+ ThemeProvider,
+} from '@mui/material';
+import Brightness4Icon from '@mui/icons-material/Brightness4';
+import Brightness7Icon from '@mui/icons-material/Brightness7';
 
-addDecorator((storyFn) => (
- <>
- <ThemeProvider theme={theme}>{storyFn()}</ThemeProvider>
- </>
-));
+import createSafeTheme from '../src/theme/safeTheme.tsx';
+import useThemeMode from '../src/hooks/useThemeMode';
+import SafeThemeProvider from '../src/theme/SafeThemeProvider';
+
+addDecorator((storyFn) => {
+ const { switchThemeMode, themeMode } = useThemeMode();
+
+ return (
+ <SafeThemeProvider mode={themeMode}>
+ {(safeTheme) => (
+ <ThemeProvider theme={safeTheme}>
+ <CssBaseline />
+ <Card>
+ <CardContent>
+ <Stack direction="row" alignItems="center" sx={{ mb: 2 }}>
+ <IconButton
+ onClick={switchThemeMode}
+ color="inherit"
+ sx={{ p: 0 }}>
+ {themeMode === 'light' ? (
+ <Brightness4Icon />
+ ) : (
+ <Brightness7Icon />
+ )}
+ </IconButton>
+ </Stack>
+ {storyFn()}
+ </CardContent>
+ </Card>
+ </ThemeProvider>
+ )}
+ </SafeThemeProvider>
+ );
+});
 
 addParameters({
  options: {

.storybook/webpack.config.js

@@ -2,43 +2,47 @@ module.exports = ({ config }) => {
  config.module.rules.push({
  test: /\.(ts|js)x?$/,
  exclude: [/node_modules/],
- use: [
- {
- loader: require.resolve('ts-loader'),
- },
- ]
+ use: {
+ loader: 'ts-loader',
+ },
  });
 
- // There was a problem with the fonts not being loaded
- // I took the fix from here: https://github.com/storybookjs/storybook/issues/5936#issuecomment-532902187
- config.module.rules = config.module.rules.map(rule => {
- if (rule.test && rule.test.toString().includes('woff')) {
+ config.module.rules.push({
+ test: /\.css$/i,
+ use: ['style-loader', 'css-loader'],
+ });
+
+ // remove svg from existing rule
+ config.module.rules = config.module.rules.map((rule) => {
+ if (
+ String(rule.test) ===
+ String(
+ /\.(svg|ico|jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|cur|ani)(\?.*)?$/
+ )
+ ) {
  return {
  ...rule,
- test: /\.(svg|ico|jpg|jpeg|png|gif|webp|cur|ani|pdf)(\?.*)?$/
- }
+ test: /\.(ico|jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|cur|ani)(\?.*)?$/,
+ };
  }
- return rule
- })
+
+ return rule;
+ });
 
  config.module.rules.push({
- test: /\.(svg|png|jpg)$/i,
- use: [
- {
- loader: 'url-loader',
- query: {
- name: '[name].[ext]'
- }
- }
- ]
+ test: /\.(woff(2)?|ttf|eot)(\?v=\d+\.\d+\.\d+)?$/,
+ type: 'asset/resource',
+ generator: {
+ filename: '[name][ext][query]',
+ },
  });
 
- config.resolve.extensions.push('.ts', '.tsx', 'woff2');
+ config.module.rules.push({
+ test: /\.(png|jpg)$/i,
+ type: 'asset/inline',
+ });
 
- config.node = {
- fs: 'empty',
- child_process: 'empty'
- };
+ config.resolve.extensions.push('.ts', '.tsx', 'woff2');
 
  return config;
 };

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2022 Safe Ecosystem Foundation
+Copyright (c) 2018-2023 Safe Ecosystem Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,75 +1,95 @@
 # safe-react-components
 
-[![Storybook](https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg)](https://components.gnosis-safe.io/)
-[![npm](https://img.shields.io/npm/v/@gnosis.pm/safe-react-components)](https://www.npmjs.com/package/@gnosis.pm/safe-react-components)
+![license](https://img.shields.io/github/license/safe-global/safe-react-components)
+![tests](https://img.shields.io/github/actions/workflow/status/safe-global/safe-react-components/test.yml?branch=main)
 
-This repository contains a set of React components written in TypeScript.
+This repository contains a [@mui/material](https://material-ui.com/) theming and a set of useful React components written in TypeScript.
 
-These components are being used to build the [Gnosis Safe](https://github.com/gnosis/safe-react) web and desktop app.
+These components and theming are being used to build the [Safe](https://github.com/safe-global/web-core) web and desktop app.
 
-As Gnosis Safe allows to integrate third party applications ("Safe Apps"), these components can also be used to build Safe Apps with the following benefits:
+As Safe allows to integrate third party applications ("Safe Apps"), these components can also be used to build Safe Apps with the following benefits:
 
-- **Native feel:** Build your Safe Apps with a similar style as the one used by Gnosis Safe. This makes your Safe Apps feel almost like a native feature of the Gnosis Safe.
-- **Responsive:** Most of the components will are optimized to render properly in different resolutions.
+- **Native feel:** Build your Safe Apps with a similar style as the one used by the Safe. This makes your Safe Apps feel almost like a native feature of the Safe.
 - **Blockchain-focused:** Some components solve common blockchain-related problems like inputs for ETH addresses and bigNumbers, identicon images, and more.
 - **Save time:** No need to build all components from scratch.
 
 ## How to install
 
-```bash
- yarn add @gnosis.pm/safe-react-components
+### Yarn
 
- npm install @gnosis.pm/safe-react-components
+```bash
+ yarn add @safe-global/safe-react-components
 ```
 
-## Integration
+### npm
 
-This library makes use of [material-ui - 4.X.X](https://material-ui.com/) and [styled-components - 5.X.X](https://styled-components.com/) as `peer dependencies`, this means you must install it in your Safe App. Make sure to provide the same version as the one being used by the current version of this library.
+```bash
+ npm install @safe-global/safe-react-components
+```
 
+## Integration
 
-Once everything is installed, you have to instantiate a [ThemeProvider](https://styled-components.com/docs/api#themeprovider) from [styled-components](https://styled-components.com/).
+This library makes use of [@mui/material - 5.x.x](https://material-ui.com/) as `peer dependency`, this means you must install it in your Safe App. Make sure to provide a compatible version as defined by peer dependencies.
 
-This example uses the theme exported by safe-react-components. Here, you can extend this theme to customize it to your needs.
+Once everything is installed, you have to instantiate the SafeThemeProvider with the desired theme mode (light/dark) and with the generated safe theme return a [ThemeProvider](https://mui.com/material-ui/customization/theming/#theme-provider) for the application.
 
 ```js
-import { ThemeProvider } from 'styled-components';
-import { theme } from '@gnosis.pm/safe-react-components';
+import { ThemeProvider } from '@mui/material/styles';
+import { SafeThemeProvider } from '@safe-global/safe-react-components';
 
 import App from './App';
 
 export default () => (
- <ThemeProvider theme={theme}>
- <App />
- </ThemeProvider>
+ <SafeThemeProvider mode="light">
+ {(safeTheme: Theme) => (
+ <ThemeProvider theme={safeTheme}>
+ <App />
+ </ThemeProvider>
+ )}
+ </SafeThemeProvider>
 );
 ```
 
 ## Using the components
 
-You can import every component exported from `@gnosis.pm/safe-react-components` in the same way.
+You can import every component exported from `@safe-global/safe-react-components` in the same way.
 
 ```js
-import { Text } from '@gnosis.pm/safe-react-components';
+import { EthHashInfo } from '@safe-global/safe-react-components';
 
-const App = () => {
- return <Text size="lg">some text</Text>;
+const App = (account) => {
+ return <EthHashInfo address={account} showCopyButton />;
 };
 
 export default App;
 ```
 
+## Adding the fonts
+
+The fonts will be bundled on `build` and a `fonts.css` file will be provided as well for adding the corresponding `font-face` declarations
+
+```
+// from js/ts files
+import '@safe-global/safe-react-components/dist/fonts.css'
+
+// from css files
+@import url(<path-to-node_modules>/@safe-global/safe-react-components/dist/fonts.css)
+```
+
 ## Storybook
 
 You can find documentation and examples of all our components in this [storybook](https://components.gnosis-safe.io/).
 
 ## Local development
 
 To develop on your local machine, install the dependencies (including the peer dependencies):
+
 ```
 yarn
 ```
 
 Launch the Storybook:
+
 ```
 yarn storybook
 ```
@@ -79,6 +99,7 @@ yarn storybook
 Snapshot tests are generated automatically from the Storybook stories using the [StoryShots addon](https://github.com/storybookjs/storybook/tree/master/addons/storyshots/storyshots-core).
 
 To run the tests locally:
+
 ```
 yarn test
 ```
@@ -91,4 +112,4 @@ If you want to add a new Jest test, make sure to put a file with the `.test.tsx`
 
 ## Examples
 
-At Gnosis we have developed some example Safe Apps. Here is the [repository](https://github.com/gnosis/safe-react-apps).
+At Safe we have developed some example Safe Apps. Here is the [repository](https://github.com/safe-global/safe-react-apps).