Angular Mode(Dark, Light, System/Auto) Switcher

ngx-mode-switcher is a versatile Angular library that allows developers to effortlessly integrate dark mode, light mode, and auto (system default) mode switching into their applications. With a simple configuration, you can provide users with a seamless experience, adapting to their preferred display settings.

This library offers full customization:

• Configurable Display: Choose to show or hide the mode-switching legend.
• Customizable Mode Names: Tailor the mode names to fit your application's branding or user experience.

Make your Angular applications more user-friendly and responsive to individual preferences with ngx-mode-switcher.

Demo

https://jaganb.dev/angular-mode-switcher-demo/

Compatibility

Supported Angular Versions

This library is compatible with the following Angular versions:

• Angular 14: ^14.0.0
• Angular 15: ^15.0.0
• Angular 16: ^16.0.0
• Angular 17: ^17.0.0
• Angular 18: ^18.0.0

Installation Instructions

Ensure that your project uses one of the supported Angular versions.

Installation

Install the npm package.

npm install ngx-mode-switcher

Import in NgModule:

import { NgxModeSwitcherModule } from 'ngx-mode-switcher';

@NgModule({
    imports: [ NgxModeSwitcherModule ]
})

Usage

<ngx-mode-switcher></ngx-mode-switcher>

You may pass config as an object:

<ngx-mode-switcher [config]="customConfig"></ngx-mode-switcher>

Default Config

config: IConfig = {
    legend: {
        visible: true,
        LIGHT: 'light',
        DARK: 'dark',
        SYSTEM: 'system'
    }
}

Custom Config

Hide the legend

customConfig: IConfig = {
    legend: {
        visible: false
    }
}

Add custom legends

customConfig: IConfig = {
    legend: {
        visible: true,
        LIGHT: 'day',
        DARK: 'night',
        SYSTEM: 'auto'
    }
}

For any questions, suggestions, or feature requests

https://github.com/jaganbishoyi/angular-mode-switcher/issues

For a comprehensive guide on implementing Light, Dark, and System/Auto modes in Angular, please read the detailed blog post available at https://jaganb.dev/blogs/implement-light-dark-mode-in-angular

License

License under the MIT License (MIT)

Copyright (c) 2024 Jagan Mohan Bishoyi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.