Porsche Design System

Angular

Table of Contents

Global Theme
Prefixing

Global Theme#

All system colors are controlled via the CSS color-scheme property and are included in our mandatory Global Styles. These styles also provide utility classes for selecting the active theme and a polyfill to ensure compatibility with browsers that do not yet support light-dark() (see browser support).

By default, color tokens use the light theme. To enable the dark theme or automatic theme switching based on system settings, add the .scheme-light, .scheme-dark or .scheme-light-dark CSS class to the <html> element or any HTML element. This applies the selected theme to all child elements.

Learn more in the Theme section.

Using Standalone Components

When using Standalone Components the PorscheDesignSystemModule.load() needs to be included in the bootstrapApplication config providers section using importProvidersFrom.

// main.ts (standalone setup)

import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app/app.component';

bootstrapApplication(AppComponent, {
  providers: [importProvidersFrom(PorscheDesignSystemModule.load())],
}).catch((err) => console.error(err));

Prefixing#

In case of a micro-service architecture, multiple instances and versions of the Porsche Design System can be combined in a final application. This could cause conflicts due to the way how custom webcomponents are registered in the browser. During the bootstrap phase of the Porsche Design System, custom elements are defined. If a second application wants to register Porsche Design System again it will cause issues especially when different versions are used.

A way of preventing those conflicts is by using a unique custom prefix for the components. Simply pass your desired prefix to the parameter of the static PorscheDesignSystemModule.load() function.

When using custom prefixed component tags, you've to add the schema CUSTOM_ELEMENTS_SCHEMA to the modules that use the prefixed components.

// app.module.ts

import { BrowserModule } from '@angular/platform-browser';
import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import { PorscheDesignSystemModule, WEB_COMPONENTS_PREFIX } from '@porsche-design-system/components-angular';
import { AppComponent } from './app.component';

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule, PorscheDesignSystemModule.load({ prefix: 'sample-prefix' })],
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
  bootstrap: [AppComponent],
})
export class AppModule {}

Be aware, that you still have to set the component name without the prefix as an attribute, otherwise you might get unexpected results. The component might display as usual, but it is no longer an Angular component which means bindings of inputs and outputs won't work.

You can now use the prefixed component as follows:

// app.component.ts

import { Component } from '@angular/core';

@Component({
  selector: 'app-root',
  template: `
    <div id="app">
      <sample-prefix-p-heading p-heading size="xx-large">Heading</sample-prefix-p-heading>
    </div>
  `,
  styles: [],
})
export class AppComponent {}

You can add more prefixes by calling PorscheDesignSystemModule.load() multiple times or in your sub modules:

// app.module.ts

import { BrowserModule } from '@angular/platform-browser';
import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
import { AppComponent } from './app.component';

@NgModule({
  declarations: [AppComponent],
  imports: [
    BrowserModule,
    PorscheDesignSystemModule.load({ prefix: 'sample-prefix' }),
    PorscheDesignSystemModule.load({ prefix: 'another-prefix' }),
  ],
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
  bootstrap: [AppComponent],
})
export class AppModule {}