HeadSpinUI Setup
Step-by-step guide to integrating BreakMade with HeadSpinUI.
This guide walks you through setting up HeadSpinUI integration with BreakMade.
Prerequisites
Before enabling HeadSpin Mode:
- BreakMade plugin installed and activated
- HeadSpinUI plugin installed and activated
- HeadSpinUI initialized with default settings
- Breakdance page builder active
Step-by-Step Setup
Step 1: Install HeadSpinUI
- Purchase HeadSpinUI from the official source
- Upload and activate the plugin
- Run the HeadSpinUI initialization wizard
- Configure default HeadSpinUI settings
Step 2: Enable HeadSpin Mode
- Go to BreakMade in WordPress admin
- Find the HeadSpin Mode toggle
- Click to enable HeadSpin Mode
- A confirmation dialog will appear
Step 3: Merge Data
After enabling HeadSpin Mode:
- Click the Merge Data button
- Wait for the merge to complete
- This syncs BreakMade data to HeadSpinUI format
Step 4: Verify Integration
Check that integration is working:
- Go to HeadSpinUI settings
- Verify BreakMade variables appear
- Check that colors are synced
- Preview a page to confirm styles
What Changes with HeadSpin Mode
Variable Naming
| Without HeadSpin | With HeadSpin |
|---|---|
--s1 | --hsp-s1 |
--s8 | --hsp-s8 |
--s32 | --hsp-s32 |
--primary-base | --hsp-primary-base |
--neutral-text | --hsp-neutral-text |
--radius-lg | --hsp-radius-lg |
CSS Output
- Native Mode: BreakMade generates CSS
- HeadSpin Mode: HeadSpinUI generates CSS
Design Selection
When copying designs from breakmade.com:
- Native Mode: Select “Native” framework
- HeadSpin Mode: Select “HeadSpin” framework
HeadSpin Mode Features
Automatic Variable Conversion
When HeadSpin Mode is active, BreakMade automatically:
- Converts all spacing variables
- Converts all color variables
- Converts radius variables
- Updates CSS output format
Data Synchronization
The “Merge Data” feature:
- Syncs color palette to HeadSpinUI
- Transfers spacing configuration
- Maintains design set compatibility
Unified Token Management
HeadSpinUI provides:
- Central token dashboard
- Variable organization
- Export capabilities
- Team collaboration features
Common Setup Issues
HeadSpin Mode Won’t Enable
Possible causes:
- HeadSpinUI not installed
- HeadSpinUI not activated
- HeadSpinUI not initialized
Solution:
- Verify HeadSpinUI is active in Plugins
- Run HeadSpinUI setup wizard
- Try enabling HeadSpin Mode again
Variables Not Converting
Possible causes:
- Merge Data not clicked
- Cache needs clearing
Solution:
- Click “Merge Data” button
- Clear all caches
- Regenerate CSS
Styles Breaking After Enable
Possible causes:
- Using Native designs with HeadSpin Mode
- CSS not regenerated
Solution:
- Re-copy designs using HeadSpin framework
- Regenerate CSS file
- Clear browser cache
Best Practices
Plan Ahead
- Decide on HeadSpin Mode before adding designs
- Switching later requires re-copying designs
Document Your Setup
For team projects:
- Note that HeadSpin Mode is enabled
- Document in project README
- Inform all team members
Test Thoroughly
After setup:
- Preview all pages
- Check responsive views
- Verify colors render correctly
- Test on actual devices
Disabling HeadSpin Mode
If you need to switch back to Native mode:
- Go to BreakMade settings
- Toggle off HeadSpin Mode
- Variables revert to Native format
- May need to re-copy designs using Native framework
Related
- Variable Conversion - How variables are converted
- Native vs HeadSpin - Choosing the right framework
- Removing BreakMade - Removal instructions