Skip to content

Migrate to Bootstrap-like Naming Convention (Scoped with .n-) #1

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

Open
5 tasks
LoboGuardian opened this issue May 5, 2025 · 0 comments
Open
5 tasks
Labels
enhancement New feature or request question Further information is requested

Comments

@LoboGuardian
Copy link
Member

LoboGuardian commented May 5, 2025

🎯 Goal

Improve the developer experience and adoption by aligning class names with Bootstrap-style naming, while retaining the .n- prefix for namespace scoping.


📌 Current Situation

Numix UI currently uses longer, custom class names like:

  • .n-button, .n-button-primary, .n-button-disabled
  • .n-input, .n-label
  • .n-heading-1, .n-paragraph

These work fine, but can feel verbose and unfamiliar to developers used to Bootstrap, Bulma, etc.


✅ Proposed Change

Adopt Bootstrap-style naming patterns, scoped with .n- for modularity and safety.

Old Class New Class
.n-button .n-btn
.n-button-primary .n-btn-primary
.n-button-secondary .n-btn-secondary
.n-button-rounded .n-btn-rounded
.n-button-disabled .n-btn-disabled
.n-input .n-form-control
.n-label .n-form-label
.n-heading-1 .n-h1
.n-paragraph .n-text
.n-small-text .n-text-sm
.n-alert-success .n-alert-success
.n-alert-dismissible .n-alert-dismissible
.n-container .n-container

🛠️ Tasks

  • Audit existing .n-* class names
  • Add Bootstrap-style .n-btn, .n-form-control, etc.
  • Mark verbose forms as deprecated or alias them
  • Update all documentation and examples to use new classes
  • Ensure backward compatibility where needed

💡 Notes

  • Keep the .n- prefix on all classes
  • Follow consistent naming patterns:
    • n-btn, n-btn-primary, n-form-control, n-text-sm, etc.
  • Consider providing deprecation warnings in docs for older class forms

🧠 Benefits

  • Reduces cognitive load
  • Familiar and intuitive for Bootstrap users
  • Faster to write and easier to scan
  • Maintains scoping and branding (n-)
@LoboGuardian LoboGuardian added enhancement New feature or request question Further information is requested labels May 5, 2025
LoboGuardian added a commit that referenced this issue May 5, 2025
Add theme toggling and enhance UI components
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant