Skip to content

Missing Required ModernColors Setup in "Get Started" Guide on Website #548

@ZtheLeader

Description

@ZtheLeader

Package: @freenow/wave
Version: 2.38.1 (or latest stable)


🐛 Issue

The official "Get Started" documentation is missing a critical step: including the ModernColors (or ClassicColors) component at the root of your React application. Without this, Wave components render unstyled.

This requirement is currently only mentioned in:

However, new users following only the website documentation are likely to miss it.


✅ Expected Behavior

The "Get Started" guide should clearly instruct users to add the appropriate color scheme component (ModernColors or ClassicColors) to ensure proper styling of Wave components.


💡 Suggested Fix

Add an example like this in the main setup instructions on https://wave.free-now.com/?path=/docs/get-started--docs:

import { ModernColors } from '@freenow/wave'; // Or ClassicColors for default theme

ReactDOM.createRoot(document.getElementById('root')).render(
  <React.StrictMode>
    <ModernColors /> {/* Loads Wave CSS variables */}
    <App />
  </React.StrictMode>
);

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions