Skip to content

Custom Tokens

Create your own theme by overriding GuideFlow's CSS custom properties.

Available Tokens

Popover

TokenDescriptionDefault
--gf-popover-bgBackground color#ffffff
--gf-popover-colorText color#1f2937
--gf-popover-borderBorder shorthand1px solid #e5e7eb
--gf-popover-border-radiusCorner radius8px
--gf-popover-shadowBox shadow0 4px 16px rgba(0,0,0,0.12)
--gf-popover-paddingInner padding16px 20px
--gf-popover-max-widthMaximum width320px
--gf-popover-fontFont familyinherit
--gf-popover-backdropBackdrop filternone

Buttons

TokenDescriptionDefault
--gf-btn-primary-bgPrimary button background#3b82f6
--gf-btn-primary-colorPrimary button text#ffffff
--gf-btn-secondary-bgSecondary button backgroundtransparent
--gf-btn-secondary-colorSecondary button text#6b7280
--gf-btn-border-radiusButton corner radius6px
--gf-btn-paddingButton padding8px 16px

Spotlight

TokenDescriptionDefault
--gf-overlay-colorOverlay background#000000
--gf-overlay-opacityOverlay opacity0.5

Hotspot Beacon

TokenDescriptionDefault
--gf-beacon-colorBeacon pulse color#6366f1
--gf-beacon-sizeBeacon diameter12px

Creating a Theme File

css
/* my-theme.css */
.guideflow-popover {
  --gf-popover-bg: #0f172a;
  --gf-popover-color: #e2e8f0;
  --gf-popover-border: 1px solid #334155;
  --gf-popover-border-radius: 12px;
  --gf-popover-shadow: 0 8px 24px rgba(0, 0, 0, 0.4);
  --gf-btn-primary-bg: #8b5cf6;
  --gf-btn-primary-color: #ffffff;
}
ts
import '@guideflow/core/styles'
import './my-theme.css'

Dark Mode

Use CSS media queries or class-based toggling:

css
@media (prefers-color-scheme: dark) {
  .guideflow-popover {
    --gf-popover-bg: #1e293b;
    --gf-popover-color: #f1f5f9;
    --gf-popover-border: 1px solid #475569;
  }
}

Or with a class toggle:

css
.dark .guideflow-popover {
  --gf-popover-bg: #1e293b;
  --gf-popover-color: #f1f5f9;
}

Released under the MIT License.