Skip to content

ThemeConfig Default Strategy Does Not Match Theming Example #2

@JoshuaAlzate

Description

@JoshuaAlzate

The current ThemeConfig default strategy uses the attribute mode, but the theming examples in the documentation demonstrate the class strategy. This mismatch can cause the theme system to appear non-functional for new users, especially those following the provided examples exactly as written.

Because the defaults and examples do not align, first-time adopters may believe the library is broken “out of the box” when in reality the issue is caused by inconsistent strategy configuration.

Expected Behaviour

  • The default ThemeConfig strategy should match the documented examples.
  • Alternatively, the documentation should clearly state that the default strategy is attribute and update the examples accordingly.

Actual Behaviour

  • Default strategy: attribute
  • Example usage: assumes class strategy
  • Result: Themes do not switch or apply correctly unless users manually adjust the configuration.

Impact

  • New users may struggle to get the library working on first install.
  • Creates confusion about whether theme switching is functioning.
  • Increases support overhead due to initial setup friction.

Proposal

Two options:

  1. Update the default strategy to class, matching the examples.
    This would give a consistent “works immediately” developer experience.

  2. Update the examples to use attribute, with a clear explanation of both options and when each should be used.

Consistency between defaults and examples is important to ensure the library behaves predictably for new adopters.

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