自訂主題

創建自訂主題

注意：此 API 不穩定，未來可能會更改。我們建議暫時使用內建主題。

儘管內建主題提供了一些自訂功能，Theme 類型旨在幫助您定義自己的自訂主題，並能較低層次地訪問基本的主題變數。

import { RainbowKitProvider, Theme } from '@rainbow-me/rainbowkit';

const myCustomTheme: Theme = {
  blurs: {
    modalOverlay: '...',
  },
  colors: {
    accentColor: '...',
    accentColorForeground: '...',
    actionButtonBorder: '...',
    actionButtonBorderMobile: '...',
    actionButtonSecondaryBackground: '...',
    closeButton: '...',
    closeButtonBackground: '...',
    connectButtonBackground: '...',
    connectButtonBackgroundError: '...',
    connectButtonInnerBackground: '...',
    connectButtonText: '...',
    connectButtonTextError: '...',
    connectionIndicator: '...',
    downloadBottomCardBackground: '...',
    downloadTopCardBackground: '...',
    error: '...',
    generalBorder: '...',
    generalBorderDim: '...',
    menuItemBackground: '...',
    modalBackdrop: '...',
    modalBackground: '...',
    modalBorder: '...',
    modalText: '...',
    modalTextDim: '...',
    modalTextSecondary: '...',
    profileAction: '...',
    profileActionHover: '...',
    profileForeground: '...',
    selectedOptionBorder: '...',
    standby: '...',
  },
  fonts: {
    body: '...',
  },
  radii: {
    actionButton: '...',
    connectButton: '...',
    menuButton: '...',
    modal: '...',
    modalMobile: '...',
  },
  shadows: {
    connectButton: '...',
    dialog: '...',
    profileDetailsAction: '...',
    selectedOption: '...',
    selectedWallet: '...',
    walletLogo: '...',
  },
};

const App = () => (
  <RainbowKitProvider theme={myCustomTheme} {...etc}>
    {/* Your App */}
  </RainbowKitProvider>;
)

擴展內建主題

您可以擴展內建主題，而無需重新定義整個主題。這在您只想覆蓋特定主題標記時非常有用。

為此，請安裝 lodash.merge（或等效的）：

npm install lodash.merge

導入它，以及您想要擴展的主題（例如：darkTheme）和 TypeScript 的 Theme 類型：

import merge from 'lodash.merge';
import {
  RainbowKitProvider,
  darkTheme,
  Theme,
} from '@rainbow-me/rainbowkit';

然後，將內建主題與您想要覆蓋的主題標記合併。在此例中，我將 accentColor 標記覆蓋為符合我品牌的強調色。

const myTheme = merge(darkTheme(), {
  colors: {
    accentColor: '#07296d',
  },
} as Theme);

最後，您現在可以將您的自訂主題傳遞給 RainbowKitProvider 的 theme 屬性。

const App = () => {
  return (
    <RainbowKitProvider theme={myTheme} {...etc}>
      {/* Your App */}
    </RainbowKitProvider>
  );
};

創建自訂主題選擇器

如果您的應用伺服器呈現或靜態呈現並允許用戶手動切換主題，RainbowKit 的主題系統可以通過以下函數連接到自訂 CSS 選擇器，並且可以與任何 CSS-in-JS 系統一起使用：

cssStringFromTheme
cssObjectFromTheme

這些函數返回設置所有必需主題變數的 CSS。由於同時支持字串和物件，它可以與任何 CSS-in-JS 系統集成。

作為基本例子，您可以為每個主題渲染自己的 style 元素和自訂選擇器。由於我們控制主題 CSS 的渲染，因此我們將 theme 屬性設定為 null，以便 RainbowKitProvider 不會為我們渲染任何樣式。還請注意 cssStringFromTheme 函數上的 extends 選項，它會忽略與基礎主題相同的任何主題變數。

import {
  RainbowKitProvider,
  cssStringFromTheme,
  lightTheme,
  darkTheme,
} from '@rainbow-me/rainbowkit';

const App = () => {
  return (
    <RainbowKitProvider theme={null} {...etc}>
      <style
        dangerouslySetInnerHTML={{
          __html: `
            :root {
              ${cssStringFromTheme(lightTheme)}
            }

            html[data-dark] {
              ${cssStringFromTheme(darkTheme, {
                extends: lightTheme,
              })}
            }
          `,
        }}
      />

      {/* ... */}
    </RainbowKitProvider>
  );
};

概述

入門指南

進階

自訂主題

創建自訂主題

擴展內建主題

創建自訂主題選擇器