Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(theme): Move colors to lightConfig #31719

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

msyavuz
Copy link
Contributor

@msyavuz msyavuz commented Jan 6, 2025

SUMMARY

Current implementation of Ant Design theme is based on Superset having a single light theme. To enable theming capabilities colors need to be seperated to their own lightConfig. This pr aims to do that. After this, adding a dark mode can be done by copying the light theme and changing colors.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

Run the tests and visually check if there are any regressions.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

Copy link

korbit-ai bot commented Jan 6, 2025

Based on your review schedule, I'll hold off on reviewing this PR until it's marked as ready for review. If you'd like me to take a look now, comment /korbit-review.

Your admin can change your review schedule in the Korbit Console

@msyavuz msyavuz marked this pull request as ready for review January 6, 2025 09:29
@dosubot dosubot bot added the global:theming Related to theming Superset label Jan 6, 2025
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review by Korbit AI

Korbit automatically attempts to detect when you fix issues in new commits.
Category Issue Fix Detected
Design Patterns Simplify the lightConfig object structure. ▹ view
Files scanned
File Path Reviewed
superset-frontend/src/theme/index.ts
superset-frontend/src/theme/light.ts

Explore our documentation to understand the languages and file types we support and the files we ignore.

Need a new review? Comment /korbit-review on this PR and I'll review your latest changes.

Korbit Guide: Usage and Customization

Interacting with Korbit

  • You can manually ask Korbit to review your PR using the /korbit-review command in a comment at the root of your PR.
  • You can ask Korbit to generate a new PR description using the /korbit-generate-pr-description command in any comment on your PR.
  • Too many Korbit comments? I can resolve all my comment threads if you use the /korbit-resolve command in any comment on your PR.
  • Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
  • Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.

Customizing Korbit

  • Check out our docs on how you can make Korbit work best for you and your team.
  • Customize Korbit for your organization through the Korbit Console.

Current Korbit Configuration

General Settings
Setting Value
Review Schedule Automatic excluding drafts
Max Issue Count 10
Automatic PR Descriptions
Issue Categories
Category Enabled
Naming
Database Operations
Documentation
Logging
Error Handling
Systems and Environment
Objects and Data Structures
Readability and Maintainability
Asynchronous Processing
Design Patterns
Third-Party Libraries
Performance
Security
Functionality

Feedback and Support

Note

Korbit Pro is free for open source projects 🎉

Looking to add Korbit to your team? Get started with a free 2 week trial here

@@ -117,3 +118,70 @@ export const lightAlgorithm: MappingAlgorithm = seedToken => {
lineWidthBold: supersetTheme.gridUnit / 2,
};
};

export const lightConfig: ThemeConfig = {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simplify the lightConfig object structure. category Design Patterns

Tell me more

It appears that the lightConfig object is becoming quite complex and monolithic with maintaining colors, themes, and configuration components inside one large object. This could limit the scalability of your theme setup. I suggest you consider breaking down the lightConfig object into smaller, more manageable configuration units. This will increase the maintainability and simplicity of the configuration code. An appropriate design pattern like the Module or Factory pattern can be employed to achieve this modularity.

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

@sadpandajoe sadpandajoe added the hold! On hold label Jan 8, 2025
@sadpandajoe
Copy link
Member

Putting a hold on this as there are discussions on theming going on right now that could already include this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
global:theming Related to theming Superset hold! On hold size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants