CSS Variables
Platform customers have access to a comprehensive set of CSS variables that can be used to customize the appearance of the embedded signing experience. These variables control everything from colors to spacing and can be used to match your application's design system.
Available Variables
Colors
Variable | Description | Default |
---|---|---|
background | Base background color | System default |
foreground | Base text color | System default |
muted | Muted/subtle background color | System default |
mutedForeground | Muted/subtle text color | System default |
popover | Popover/dropdown background color | System default |
popoverForeground | Popover/dropdown text color | System default |
card | Card background color | System default |
cardBorder | Card border color | System default |
cardBorderTint | Card border tint/highlight color | System default |
cardForeground | Card text color | System default |
fieldCard | Field card background color | System default |
fieldCardBorder | Field card border color | System default |
fieldCardForeground | Field card text color | System default |
widget | Widget background color | System default |
widgetForeground | Widget text color | System default |
border | Default border color | System default |
input | Input field border color | System default |
primary | Primary action/button color | System default |
primaryForeground | Primary action/button text color | System default |
secondary | Secondary action/button color | System default |
secondaryForeground | Secondary action/button text color | System default |
accent | Accent/highlight color | System default |
accentForeground | Accent/highlight text color | System default |
destructive | Destructive/danger action color | System default |
destructiveForeground | Destructive/danger text color | System default |
ring | Focus ring color | System default |
warning | Warning/alert color | System default |
Spacing and Layout
Variable | Description | Default |
---|---|---|
radius | Border radius size in REM units | System default |
Usage Example
Here's how to use these variables in your embedding implementation:
const cssVars = {
// Colors
background: '#ffffff',
foreground: '#000000',
primary: '#0000ff',
primaryForeground: '#ffffff',
accent: '#4f46e5',
destructive: '#ef4444',
// Spacing
radius: '0.5rem'
};
// React/Preact
<EmbedDirectTemplate
token={token}
cssVars={cssVars}
/>
// Vue
<EmbedDirectTemplate
:token="token"
:cssVars="cssVars"
/>
// Svelte
<EmbedDirectTemplate
{token}
cssVars={cssVars}
/>
// Solid
<EmbedDirectTemplate
token={token}
cssVars={cssVars}
/>
Color Format
Colors can be specified in any valid CSS color format:
- Hexadecimal:
#ff0000
- RGB:
rgb(255, 0, 0)
- HSL:
hsl(0, 100%, 50%)
- Named colors:
red
The colors will be automatically converted to the appropriate format internally.
Best Practices
-
Maintain Contrast: When customizing colors, ensure there's sufficient contrast between background and foreground colors for accessibility.
-
Test Dark Mode: If you haven't disabled dark mode, test your color variables in both light and dark modes.
-
Use Your Brand Colors: Align the primary and accent colors with your brand's color scheme for a cohesive look.
-
Consistent Radius: Use a consistent border radius value that matches your application's design system.
CSS Class Targets
In addition to CSS variables, specific components in the embedded experience can be targeted using CSS classes for more granular styling:
Component Classes
Class Name | Description |
---|---|
.embed--Root | Main container for the embedded signing experience |
.embed--DocumentContainer | Container for the document and signing widget |
.embed--DocumentViewer | Container for the document viewer |
.embed--DocumentWidget | The signing widget container |
.embed--DocumentWidgetContainer | Outer container for the signing widget, handles positioning |
.embed--DocumentWidgetHeader | Header section of the signing widget |
.embed--DocumentWidgetContent | Main content area of the signing widget |
.embed--DocumentWidgetForm | Form section within the signing widget |
.embed--DocumentWidgetFooter | Footer section of the signing widget |
.embed--WaitingForTurn | Container for the waiting screen when it's not the user's turn to sign |
.embed--DocumentCompleted | Container for the completion screen after signing |
.field--FieldRootContainer | Base container for document fields (signatures, text, checkboxes, etc.) |
Field components also expose several data attributes that can be used for styling different states:
Data Attribute | Values | Description |
---|---|---|
[data-field-type] | SIGNATURE , TEXT , CHECKBOX , RADIO , etc. | The type of field |
[data-inserted] | true , false | Whether the field has been filled |
[data-validate] | true , false | Whether the field is being validated |
Field Styling Example
/* Style all field containers */
.field--FieldRootContainer {
transition: all 200ms ease;
}
/* Style specific field types */
.field--FieldRootContainer[data-field-type='SIGNATURE'] {
background-color: rgba(0, 0, 0, 0.02);
}
/* Style inserted fields */
.field--FieldRootContainer[data-inserted='true'] {
background-color: var(--primary);
opacity: 0.2;
}
/* Style fields being validated */
.field--FieldRootContainer[data-validate='true'] {
border-color: orange;
}
Example Usage
/* Custom styles for the document widget */
.embed--DocumentWidget {
background-color: #ffffff;
box-shadow: 0 4px 6px -1px rgb(0 0 0 / 0.1);
}
/* Custom styles for the waiting screen */
.embed--WaitingForTurn {
background-color: #f9fafb;
padding: 2rem;
}
/* Responsive adjustments for the document container */
@media (min-width: 768px) {
.embed--DocumentContainer {
gap: 2rem;
}
}