zkMe Dochub
GitHubTwitterDiscord
  • zkMe Network
  • Learn about zkMe Network
    • Introduction
    • Try a Demo
    • High Level Architectural Overview
      • High Level User Stories
      • zkMe Protocol Components
        • zkMe zkVault
        • zkMe DID Method
        • zkMe Credential Suites
        • zkMe Self-Sovereign Identity
    • Vision, Mission & Design Philosophy
    • Value Propositions & Use Cases
  • Verify with zkMe Protocol
    • Integration Checklist
      • zkMe Dashboard Setup
      • zkMe Supported Chains Overview
      • zkMe Protocol Smart Contract
    • Integration Guide
      • JavaScript SDK
        • zkKYC - Compliance Suite
        • MeID - Anti-Sybil Suite
        • Me - Profiling Suite
      • zkMe API
        • zkKYC - Compliance Suite
          • Verify zkKYC Status
          • Get KYT Results
      • Platform Integration
        • QuestN Integration
      • Smart Contract Verification
        • Compliance Suite
      • Customize Widget UI
    • zkKYC - Compliance Suite
      • zkMe zkKYC Levels
      • Regulatory Frameworks
        • EU - MiCA/TFR Regulations
        • US - Crypto Regulations
        • UK - Crypto Regulations
      • zkKYC Credentials
        • Proof-of-Citizenship (zkPoC)
        • Proof-of-Location (zkPoL)
        • Proof-of-Accredited-Investor (zkPoAI)
        • AML Check (AMLMe)
        • Know Your Transaction (KYT)
          • KYT Supported Scope
        • Know Your Business (KYB)
    • MeID - Anti-Sybil Suite
      • CKKS Homomorphic Encryption
      • DID Creation
      • MeID Credentials
        • MeID
    • Me - Profiling Suite
      • MeScores Credentials
        • zkCredit Score
        • zkSocial Network
        • zkDAO Management
        • zkGaming Status
    • zkMe Roadmap
  • Explore More
    • zkMe Bug Bounty Program
    • zkMe Brand Kit
    • zkMe Identity Hub
    • FAQ
    • Glossary
    • Link
      • GitHub
      • X / Twitter
      • Medium
      • YouTube
      • LinkedIn
      • Discord
      • Blog
    • Privacy Policy
Powered by GitBook
On this page
  • Color Mode
  • Theme Color
  • Advance Setting
  • Examples
  1. Verify with zkMe Protocol
  2. Integration Guide

Customize Widget UI

PreviousCompliance SuiteNextzkKYC - Compliance Suite

Last updated 2 months ago

We understand that while our default design style aims to meet a variety of needs, specific projects may require a more tailored approach. Therefore, we've expanded our customization features.

In our dashboard, you now have the ability to alter the zkMe Widget style, including font color, background color, and more. This provides you with the flexibility to adapt the zkMe Widget to fit your project needs or personal preferences effectively.

We will now guide you through the utilization of this feature in detail.

On the left, you'll find our custom editing area. On the right, we display real-time previews, showcasing how the Widget will appear on both PC Browsers and Mobile Devices by clicking the toggle button on the top.

Color Mode

As it stands, the zkMe Widget's default color mode aligns with the system settings. This means that the widget's background color, icon background color, and font color adapt to the display mode on the user's device. However, selecting either Light mode or Dark mode overrides this functionality, meaning the color style will then remain constant, regardless of changes to the user's system settings.

Theme Color

We provide 16 distinct color choices, along with a color palette option in our editor, to ensure a perfect match with your project's theme.

The zkMe Widget will use the following color values when no theme color is set:

Advance Setting

This textarea lets you insert your own CSS to customize the zkMe Widget. If you adjust the color here, it'll take precedence over the theme color selector. We've implemented a few limitations on the custom CSS uploads; actions such as adding pseudo-elements, concealing elements in the widget, or altering the image source of background and icons are not allowed.

To pinpoint and adjust the style of elements within a widget more effectively, you can inspect the specific elements using your browser. Subsequently, you can make alterations based on their class names.

Examples

Here are some straightforward examples to assist you in navigating the Advanced Settings.

Background Color

To modify the background color of the zkMe Widget to a solid color other than black or white, you may apply the subsequent CSS.

:root {
  --color-background: pink;
  --vt-c-white-bg: pink;
}

To switch the background color to a gradient, we suggest updating the background of the given class name and adjusting the color attributes --color-background and --vt-c-white-bg.

:root {
  --color-background: transparent;
  --vt-c-white-bg: linear-gradient(0deg, rgba(34,193,195,1) 0%, rgba(253,187,45,1) 100%);
}

.sty1-cell {
  background: linear-gradient(0deg, rgba(34,193,195,1) 0%, rgba(253,187,45,1) 100%);
}

Button Style

Most of the buttons within the zkMe Widget utilize the el-button class name. This allows you to easily style the Widget's buttons using this class name.

.el-button {
  background: linear-gradient(90deg, #FFC658 0.27%, #F712A9 100.27%);
  border: none;
}

Font Color

To adjust the font color in zkMe Widget, you can generally do so by altering the color attribute of the relevant preset.

:root {
  --color-text-9: #3974c2;
  --color-text-6: 57, 116, 194;
  --color-text-7: #887272;
}

When a color from the palette is chosen, it's designated as -vt-c-primary-1. The remaining two colors are determined using 's palette tool. If the way these color values are calculated doesn't quite meet your needs, feel free to adjust them by adding your own CSS.

Ant Design
Light Mode (Default theme color)
Dark Mode (Default theme color)