Skip to content

global-theme.md

Latest commit

 

History

History
108 lines (73 loc) · 6 KB

global-theme.md

File metadata and controls

108 lines (73 loc) · 6 KB
Raw
title Global Themes
description The Ignite UI for Angular Theming component is developed in SASS with a low-difficulty API that offers restyling of one component, multiple components, or the entire suite.
keywords Ignite UI for Angular, UI controls, Angular widgets, web widgets, UI widgets, Angular, Native Angular Components Suite, Native Angular Controls, Native Angular Components Library, Native Angular Components, Angular Theming Component, Angular Theming
_language kr

Global Themes

The global theme allows you to quickly generate a theme that uses your custom color palette. The color palette will be propagated to all components that don't have custom themes created for them.

Overview

If you've included the igniteui-angular.css file in your application project, now is a good time to remove it. We are going to use our own my-app-theme.scss file to generate a global theme for all components in our application.

Ignite UI for Angular uses a global theme by default to theme the entire suite of components. You can, however, create themes scoped to components you have in your app, depending on your use case. For now, we will be including all of our themes in a single file. To generate a global theme we're going to be including two mixins core and theme; core doesn't accept any arguments, theme accepts a few:

Name Type Default Description
$palette map undefined The palette map to be used to by the default themes of all components.
$schema map $light-schema The schema used as basis for styling the components.
$exclude list ( ) A list of component themes to be excluded from the global theme.
$legacy-support boolean true Determines the theming strategy - if set to false, theming is done via CSS variables.

Let's create a custom global theme that will use the primary and secondary colors of our company.

@use "igniteui-angular/theming" as *;

// IMPORTANT: Prior to Ignite UI for Angular version 13 use:
// @import '~igniteui-angular/lib/core/styles/themes/index';

$primary-color: #2ab759; // Some green shade I like
$secondary-color: #f96a88; // Watermelon pink

$my-color-palette: palette(
    $primary: $primary-color,
    $secondary: $secondary-color
);

// IMPORTANT: Make sure you always includecore first!
@include core();
// Pass the color palette we generated to thetheme mixin
@include theme($my-color-palette);

Let's explain what the core and theme mixins do. The core mixin takes care of loading all essential parts like global elevations, global typography, etc. The theme will set the global variable $default-palette to the palette map you pass; it will also set the global variable $igx-legacy-support to the value of $legacy-support. The theme mixin also includes each individual component style that is not listed in the $exclude list of components.

Important

Including core before theme is essential. The core mixin provides all base definitions needed for theme to work.

Excluding Components

The theme mixin allows you to provide a list of component names to be excluded from the global theme styles. For instance, if you want to completely remove all styles we include for the igx-avatar and igx-badge and provide your own custom styles, you can do so by passing the list of components like so:

// ...
$unnecessary: (igx-avatar, igx-badge);

@include theme($my-color-palette, $exclude: $unnecessary);

Additionally, if you know your app will not be using some of our components, you can list them in the $exclude list, thus reducing the overall size of the produced CSS.

Light and Dark Themes

In addition to the more powerful theme mixin, we include two additional global theme mixins for fast bootstrapping of light and dark themes. Those mixins are igx-light-theme and dark-theme.

Here's a quick showcase of how you can create a light and dark theme for your application

.light-theme {
    @include light-theme($default-palette);
}

.dark-theme {
    background: #333;
    color: #fff;

    @include dark-theme($default-palette);
}

Ideally you would be applying .light-theme and .dark-theme CSS classes somewhere high in your application DOM tree. Your app-root element is a good candidate for that.

Browser Support

The value of $igx-legacy-support is quite important as it determines how component themes will work. When its value is set to true, individual component style rules will have their values set at build time to the hard values defined in their theme. If you set the value of $igx-legacy-support to false, however, style rules will look for values from CSS variables defined at the :root scope, or the nearest block scope.

The general rule of thumb regarding what the value of $legacy-support should be is dictated by whether you will be including support for Internet Explorer 11 or not. If you want to include support for IE11 set the $legacy-support value to true (default), otherwise setting its value to false will force CSS variables for theming.

API Overview

  • Global Theme
  • Palette

Additional Resources

Learn how to create individual component themes:

Our community is active and always welcoming to new ideas.